Class: Google::Apis::DfareportingV3_4::Conversion

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Conversion

Returns a new instance of Conversion.



2542
2543
2544
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2542

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

Returns:

  • (Boolean) 


2422
2423
2424
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2422

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

Returns:



2428
2429
2430
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2428

def custom_variables
  @custom_variables
end

#dclid ⇒ String

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

Returns:

  • (String) 


2436
2437
2438
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2436

def dclid
  @dclid
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, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property encryptedUserId

Returns:

  • (String) 


2444
2445
2446
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2444

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, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property encryptedUserIdCandidates

Returns:

  • (Array<String>) 


2456
2457
2458
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2456

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

Returns:

  • (Fixnum) 


2461
2462
2463
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2461

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

Returns:

  • (Fixnum) 


2466
2467
2468
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2466

def floodlight_configuration_id
  @floodlight_configuration_id
end

#gclid ⇒ String

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

Returns:

  • (String) 


2474
2475
2476
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2474

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

Returns:

  • (String) 


2480
2481
2482
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2480

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

Returns:

  • (Boolean) 


2486
2487
2488
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2486

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, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field. Corresponds to the JSON property matchId

Returns:

  • (String) 


2497
2498
2499
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2497

def match_id
  @match_id
end

#mobile_device_id ⇒ String

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

Returns:

  • (String) 


2505
2506
2507
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2505

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

Returns:

  • (Boolean) 


2510
2511
2512
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2510

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

Returns:

  • (String) 


2517
2518
2519
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2517

def ordinal
  @ordinal
end

#quantity ⇒ Fixnum

The quantity of the conversion. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


2522
2523
2524
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2522

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

Returns:

  • (Fixnum) 


2527
2528
2529
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2527

def timestamp_micros
  @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

Returns:

  • (Boolean) 


2534
2535
2536
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2534

def treatment_for_underage
  @treatment_for_underage
end

#value ⇒ Float

The value of the conversion. Corresponds to the JSON property value

Returns:

  • (Float) 


2540
2541
2542
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2540

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2547

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