Class: Google::Apis::DfareportingV3_3::Conversion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Conversion

Returns a new instance of Conversion.



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

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) 


2370
2371
2372
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2370

def child_directed_treatment
  @child_directed_treatment
end

#custom_variables ⇒ Array<Google::Apis::DfareportingV3_3::CustomFloodlightVariable>

Custom floodlight variables. Corresponds to the JSON property customVariables

Returns:



2376
2377
2378
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2376

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

Returns:

  • (String) 


2384
2385
2386
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2384

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

Returns:

  • (Array<String>) 


2396
2397
2398
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2396

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) 


2401
2402
2403
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2401

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) 


2406
2407
2408
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2406

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

Returns:

  • (String) 


2414
2415
2416
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2414

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) 


2420
2421
2422
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2420

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) 


2426
2427
2428
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2426

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

Returns:

  • (String) 


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

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

Returns:

  • (String) 


2443
2444
2445
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2443

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) 


2448
2449
2450
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2448

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) 


2455
2456
2457
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2455

def ordinal
  @ordinal
end

#quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2460
2461
2462
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2460

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) 


2465
2466
2467
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2465

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) 


2472
2473
2474
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2472

def treatment_for_underage
  @treatment_for_underage
end

#value ⇒ Float

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

Returns:

  • (Float) 


2478
2479
2480
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2478

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
 
# File 'generated/google/apis/dfareporting_v3_3/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)
  @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