Class: Google::Apis::DfareportingV2_8::Conversion

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



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

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#child_directed_treatment ⇒ Boolean Also known as: child_directed_treatment?

Whether the conversion was directed toward children. Corresponds to the JSON property childDirectedTreatment

Returns:

  • (Boolean) 


2336
2337
2338
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2336

def child_directed_treatment
  @child_directed_treatment
end

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

Custom floodlight variables. Corresponds to the JSON property customVariables

Returns:



2342
2343
2344
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2342

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

Returns:

  • (String) 


2350
2351
2352
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2350

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

Returns:

  • (Array<String>) 


2362
2363
2364
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2362

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) 


2367
2368
2369
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2367

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) 


2372
2373
2374
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2372

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

Returns:

  • (String) 


2379
2380
2381
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2379

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) 


2385
2386
2387
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2385

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) 


2391
2392
2393
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2391

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

Returns:

  • (String) 


2399
2400
2401
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2399

def mobile_device_id
  @mobile_device_id
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) 


2405
2406
2407
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2405

def ordinal
  @ordinal
end

#quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2410
2411
2412
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2410

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) 


2415
2416
2417
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2415

def timestamp_micros
  @timestamp_micros
end

#value ⇒ Float

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

Returns:

  • (Float) 


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

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 2427

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)
  @ordinal = args[:ordinal] if args.key?(:ordinal)
  @quantity = args[:quantity] if args.key?(:quantity)
  @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros)
  @value = args[:value] if args.key?(:value)
end