class Google::Apis::DfareportingV3_5::Conversion

A Conversion represents when a user successfully performs a desired action after seeing an ad.

Attributes

child_directed_treatment[RW]

Whether this particular request may come from a user under the age of 13, under COPPA compliance. Corresponds to the JSON property `childDirectedTreatment` @return [Boolean]

child_directed_treatment?[RW]

Whether this particular request may come from a user under the age of 13, under COPPA compliance. Corresponds to the JSON property `childDirectedTreatment` @return [Boolean]

custom_variables[RW]

Custom floodlight variables. Corresponds to the JSON property `customVariables` @return [Array<Google::Apis::DfareportingV3_5::CustomFloodlightVariable>]

dclid[RW]

The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field. Corresponds to the JSON property `dclid` @return [String]

encrypted_user_id[RW]

The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property `encryptedUserId` @return [String]

encrypted_user_id_candidates[RW]

A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property `encryptedUserIdCandidates` @return [Array<String>]

floodlight_activity_id[RW]

Floodlight Activity ID of this conversion. This is a required field. Corresponds to the JSON property `floodlightActivityId` @return [Fixnum]

floodlight_configuration_id[RW]

Floodlight Configuration ID of this conversion. This is a required field. Corresponds to the JSON property `floodlightConfigurationId` @return [Fixnum]

gclid[RW]

The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field. Corresponds to the JSON property `gclid` @return [String]

kind[RW]

Identifies what kind of resource this is. Value: the fixed string “ dfareporting#conversion”. Corresponds to the JSON property `kind` @return [String]

limit_ad_tracking[RW]

Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. Corresponds to the JSON property `limitAdTracking` @return [Boolean]

limit_ad_tracking?[RW]

Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. Corresponds to the JSON property `limitAdTracking` @return [Boolean]

match_id[RW]

The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property `matchId` @return [String]

mobile_device_id[RW]

The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field. Corresponds to the JSON property `mobileDeviceId` @return [String]

non_personalized_ad[RW]

Whether the conversion was for a non personalized ad. Corresponds to the JSON property `nonPersonalizedAd` @return [Boolean]

non_personalized_ad?[RW]

Whether the conversion was for a non personalized ad. Corresponds to the JSON property `nonPersonalizedAd` @return [Boolean]

ordinal[RW]

The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. Corresponds to the JSON property `ordinal` @return [String]

quantity[RW]

The quantity of the conversion. Corresponds to the JSON property `quantity` @return [Fixnum]

timestamp_micros[RW]

The timestamp of conversion, in Unix epoch micros. This is a required field. Corresponds to the JSON property `timestampMicros` @return [Fixnum]

treatment_for_underage[RW]

Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). Corresponds to the JSON property `treatmentForUnderage` @return [Boolean]

treatment_for_underage?[RW]

Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). Corresponds to the JSON property `treatmentForUnderage` @return [Boolean]

value[RW]

The value of the conversion. Corresponds to the JSON property `value` @return [Float]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dfareporting_v3_5/classes.rb, line 2480
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dfareporting_v3_5/classes.rb, line 2485
def update!(**args)
  @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment)
  @custom_variables = args[:custom_variables] if args.key?(:custom_variables)
  @dclid = args[:dclid] if args.key?(:dclid)
  @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id)
  @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates)
  @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id)
  @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id)
  @gclid = args[:gclid] if args.key?(:gclid)
  @kind = args[:kind] if args.key?(:kind)
  @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking)
  @match_id = args[:match_id] if args.key?(:match_id)
  @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id)
  @non_personalized_ad = args[:non_personalized_ad] if args.key?(:non_personalized_ad)
  @ordinal = args[:ordinal] if args.key?(:ordinal)
  @quantity = args[:quantity] if args.key?(:quantity)
  @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros)
  @treatment_for_underage = args[:treatment_for_underage] if args.key?(:treatment_for_underage)
  @value = args[:value] if args.key?(:value)
end