Class: Google::Apis::DfareportingV3_2::Conversion
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_2::Conversion
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_2/classes.rb,
generated/google/apis/dfareporting_v3_2/representations.rb,
generated/google/apis/dfareporting_v3_2/representations.rb
Overview
A Conversion represents when a user successfully performs a desired action after seeing an ad.
Instance Attribute Summary collapse
-
#child_directed_treatment ⇒ Boolean
(also: #child_directed_treatment?)
Whether this particular request may come from a user under the age of 13, under COPPA compliance.
-
#custom_variables ⇒ Array<Google::Apis::DfareportingV3_2::CustomFloodlightVariable>
Custom floodlight variables.
-
#encrypted_user_id ⇒ String
The alphanumeric encrypted user ID.
-
#encrypted_user_id_candidates ⇒ Array<String>
A list of the alphanumeric encrypted user IDs.
-
#floodlight_activity_id ⇒ Fixnum
Floodlight Activity ID of this conversion.
-
#floodlight_configuration_id ⇒ Fixnum
Floodlight Configuration ID of this conversion.
-
#gclid ⇒ String
The Google click ID.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#limit_ad_tracking ⇒ Boolean
(also: #limit_ad_tracking?)
Whether Limit Ad Tracking is enabled.
-
#mobile_device_id ⇒ String
The mobile device ID.
-
#non_personalized_ad ⇒ Boolean
(also: #non_personalized_ad?)
Whether the conversion was for a non personalized ad.
-
#ordinal ⇒ String
The ordinal of the conversion.
-
#quantity ⇒ Fixnum
The quantity of the conversion.
-
#timestamp_micros ⇒ Fixnum
The timestamp of conversion, in Unix epoch micros.
-
#treatment_for_underage ⇒ Boolean
(also: #treatment_for_underage?)
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).
-
#value ⇒ Float
The value of the conversion.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Conversion
constructor
A new instance of Conversion.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Conversion
Returns a new instance of Conversion
2475 2476 2477 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2475 def initialize(**args) update!(**args) end |
Instance Attribute Details
#child_directed_treatment ⇒ Boolean Also known as: child_directed_treatment?
Whether this particular request may come from a user under the age of 13,
under COPPA compliance.
Corresponds to the JSON property childDirectedTreatment
2375 2376 2377 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2375 def child_directed_treatment @child_directed_treatment end |
#custom_variables ⇒ Array<Google::Apis::DfareportingV3_2::CustomFloodlightVariable>
Custom floodlight variables.
Corresponds to the JSON property customVariables
2381 2382 2383 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2381 def custom_variables @custom_variables end |
#encrypted_user_id ⇒ String
The alphanumeric encrypted user ID. When set, encryptionInfo should also be
specified. This field is mutually exclusive with encryptedUserIdCandidates[],
mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or
mobileDeviceId or gclid is a required field.
Corresponds to the JSON property encryptedUserId
2389 2390 2391 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2389 def encrypted_user_id @encrypted_user_id end |
#encrypted_user_id_candidates ⇒ Array<String>
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
NO_COOKIE_MATCH_FOUND 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,
mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid
is a required field.
Corresponds to the JSON property encryptedUserIdCandidates
2401 2402 2403 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2401 def encrypted_user_id_candidates @encrypted_user_id_candidates end |
#floodlight_activity_id ⇒ Fixnum
Floodlight Activity ID of this conversion. This is a required field.
Corresponds to the JSON property floodlightActivityId
2406 2407 2408 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2406 def floodlight_activity_id @floodlight_activity_id end |
#floodlight_configuration_id ⇒ Fixnum
Floodlight Configuration ID of this conversion. This is a required field.
Corresponds to the JSON property floodlightConfigurationId
2411 2412 2413 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2411 def floodlight_configuration_id @floodlight_configuration_id end |
#gclid ⇒ String
The Google click ID. This field is mutually exclusive with encryptedUserId,
encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or
encryptedUserIdCandidates[] or mobileDeviceId is a required field.
Corresponds to the JSON property gclid
2418 2419 2420 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2418 def gclid @gclid end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
dfareporting#conversion".
Corresponds to the JSON property kind
2424 2425 2426 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2424 def kind @kind end |
#limit_ad_tracking ⇒ Boolean Also known as: limit_ad_tracking?
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
2430 2431 2432 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2430 def limit_ad_tracking @limit_ad_tracking end |
#mobile_device_id ⇒ String
The mobile device ID. This field is mutually exclusive with encryptedUserId,
encryptedUserIdCandidates[] and gclid. This or encryptedUserId or
encryptedUserIdCandidates[] or gclid is a required field.
Corresponds to the JSON property mobileDeviceId
2438 2439 2440 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2438 def mobile_device_id @mobile_device_id end |
#non_personalized_ad ⇒ Boolean Also known as: non_personalized_ad?
Whether the conversion was for a non personalized ad.
Corresponds to the JSON property nonPersonalizedAd
2443 2444 2445 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2443 def non_personalized_ad @non_personalized_ad end |
#ordinal ⇒ String
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
2450 2451 2452 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2450 def ordinal @ordinal end |
#quantity ⇒ Fixnum
The quantity of the conversion.
Corresponds to the JSON property quantity
2455 2456 2457 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2455 def quantity @quantity end |
#timestamp_micros ⇒ Fixnum
The timestamp of conversion, in Unix epoch micros. This is a required field.
Corresponds to the JSON property timestampMicros
2460 2461 2462 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2460 def @timestamp_micros end |
#treatment_for_underage ⇒ Boolean Also known as: treatment_for_underage?
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
2467 2468 2469 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2467 def treatment_for_underage @treatment_for_underage end |
#value ⇒ Float
The value of the conversion.
Corresponds to the JSON property value
2473 2474 2475 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2473 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 2480 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) @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) @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 |