Class: Google::Apis::DfareportingV2_5::Conversion

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


2296
2297
2298
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2296

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

Instance Attribute Details

#child_directed_treatmentBoolean Also known as: child_directed_treatment?

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

Returns:

  • (Boolean)

2232
2233
2234
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2232

def child_directed_treatment
  @child_directed_treatment
end

#custom_variablesArray<Google::Apis::DfareportingV2_5::CustomFloodlightVariable>

Custom floodlight variables. Corresponds to the JSON property customVariables


2238
2239
2240
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2238

def custom_variables
  @custom_variables
end

#encrypted_user_idString

The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field. Corresponds to the JSON property encryptedUserId

Returns:

  • (String)

2245
2246
2247
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2245

def encrypted_user_id
  @encrypted_user_id
end

#floodlight_activity_idString

Floodlight Activity ID of this conversion. This is a required field. Corresponds to the JSON property floodlightActivityId

Returns:

  • (String)

2250
2251
2252
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2250

def floodlight_activity_id
  @floodlight_activity_id
end

#floodlight_configuration_idString

Floodlight Configuration ID of this conversion. This is a required field. Corresponds to the JSON property floodlightConfigurationId

Returns:

  • (String)

2255
2256
2257
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2255

def floodlight_configuration_id
  @floodlight_configuration_id
end

#kindString

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

Returns:

  • (String)

2261
2262
2263
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2261

def kind
  @kind
end

#limit_ad_trackingBoolean Also known as: limit_ad_tracking?

Whether the user has Limit Ad Tracking set. Corresponds to the JSON property limitAdTracking

Returns:

  • (Boolean)

2266
2267
2268
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2266

def limit_ad_tracking
  @limit_ad_tracking
end

#mobile_device_idString

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

Returns:

  • (String)

2273
2274
2275
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2273

def mobile_device_id
  @mobile_device_id
end

#ordinalString

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)

2279
2280
2281
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2279

def ordinal
  @ordinal
end

#quantityString

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

Returns:

  • (String)

2284
2285
2286
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2284

def quantity
  @quantity
end

#timestamp_microsString

The timestamp of conversion, in Unix epoch micros. This is a required field. Corresponds to the JSON property timestampMicros

Returns:

  • (String)

2289
2290
2291
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2289

def timestamp_micros
  @timestamp_micros
end

#valueFloat

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

Returns:

  • (Float)

2294
2295
2296
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2294

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 2301

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