Class: Google::Apis::DfareportingV3_4::Conversion
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_4::Conversion
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/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_4::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.
-
#match_id ⇒ String
The match ID field.
-
#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.
2530 2531 2532 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2530 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
2420 2421 2422 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2420 def child_directed_treatment @child_directed_treatment end |
#custom_variables ⇒ Array<Google::Apis::DfareportingV3_4::CustomFloodlightVariable>
Custom floodlight variables.
Corresponds to the JSON property customVariables
2426 2427 2428 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2426 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[],
matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or
matchId or mobileDeviceId or gclid is a required field.
Corresponds to the JSON property encryptedUserId
2434 2435 2436 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2434 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
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 and gclid. This or encryptedUserId or matchId or mobileDeviceId
or gclid is a required field.
Corresponds to the JSON property encryptedUserIdCandidates
2446 2447 2448 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2446 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
2451 2452 2453 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2451 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
2456 2457 2458 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2456 def floodlight_configuration_id @floodlight_configuration_id end |
#gclid ⇒ String
The Google click ID. This field is mutually exclusive with encryptedUserId,
encryptedUserIdCandidates[], matchId and mobileDeviceId. This or
encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is
a required field.
Corresponds to the JSON property gclid
2464 2465 2466 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2464 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
2470 2471 2472 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2470 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
2476 2477 2478 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2476 def limit_ad_tracking @limit_ad_tracking end |
#match_id ⇒ String
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 and gclid. This or encryptedUserId or encryptedUserIdCandidates[
] or mobileDeviceId or gclid is a required field.
Corresponds to the JSON property matchId
2486 2487 2488 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2486 def match_id @match_id end |
#mobile_device_id ⇒ String
The mobile device ID. This field is mutually exclusive with encryptedUserId,
encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or
encryptedUserIdCandidates[] or matchId or gclid is a required field.
Corresponds to the JSON property mobileDeviceId
2493 2494 2495 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2493 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
2498 2499 2500 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2498 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
2505 2506 2507 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2505 def ordinal @ordinal end |
#quantity ⇒ Fixnum
The quantity of the conversion.
Corresponds to the JSON property quantity
2510 2511 2512 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2510 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
2515 2516 2517 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2515 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
2522 2523 2524 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2522 def treatment_for_underage @treatment_for_underage end |
#value ⇒ Float
The value of the conversion.
Corresponds to the JSON property value
2528 2529 2530 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2528 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2535 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) @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 |