Class: Google::Apis::DfareportingV2_6::Conversion

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



2318
2319
2320
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2318

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) 


2240
2241
2242
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2240

def child_directed_treatment
  @child_directed_treatment
end

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

Custom floodlight variables. Corresponds to the JSON property customVariables

Returns:



2246
2247
2248
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2246

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

Returns:

  • (String) 


2254
2255
2256
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2254

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 should only be used when calling conversions.batchinsert. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field. Corresponds to the JSON property encryptedUserIdCandidates

Returns:

  • (Array<String>) 


2265
2266
2267
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2265

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) 


2270
2271
2272
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2270

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) 


2275
2276
2277
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2275

def floodlight_configuration_id
  @floodlight_configuration_id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#conversion". Corresponds to the JSON property kind

Returns:

  • (String) 


2281
2282
2283
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2281

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) 


2287
2288
2289
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2287

def limit_ad_tracking
  @limit_ad_tracking
end

#mobile_device_id ⇒ String

The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field. Corresponds to the JSON property mobileDeviceId

Returns:

  • (String) 


2295
2296
2297
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2295

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) 


2301
2302
2303
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2301

def ordinal
  @ordinal
end

#quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2306
2307
2308
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2306

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) 


2311
2312
2313
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2311

def timestamp_micros
  @timestamp_micros
end

#value ⇒ Float

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

Returns:

  • (Float) 


2316
2317
2318
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2316

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2323

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