Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesConversion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/searchads360_v0/classes.rb,
lib/google/apis/searchads360_v0/representations.rb,
lib/google/apis/searchads360_v0/representations.rb

Overview

A conversion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesConversion

Returns a new instance of GoogleAdsSearchads360V0ResourcesConversion.



6341
6342
6343
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6341

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

Instance Attribute Details

#ad_id ⇒ Fixnum

Output only. Ad ID. A value of 0 indicates that the ad is unattributed. Corresponds to the JSON property adId

Returns:

  • (Fixnum) 


6203
6204
6205
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6203

def ad_id
  @ad_id
end

#advertiser_conversion_id ⇒ String

Output only. For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions. Corresponds to the JSON property advertiserConversionId

Returns:

  • (String) 


6211
6212
6213
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6211

def advertiser_conversion_id
  @advertiser_conversion_id
end

#asset_field_type ⇒ String

Output only. Asset field type of the conversion event. Corresponds to the JSON property assetFieldType

Returns:

  • (String) 


6216
6217
6218
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6216

def asset_field_type
  @asset_field_type
end

#asset_id ⇒ Fixnum

Output only. ID of the asset which was interacted with during the conversion event. Corresponds to the JSON property assetId

Returns:

  • (Fixnum) 


6222
6223
6224
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6222

def asset_id
  @asset_id
end

#attribution_type ⇒ String

Output only. What the conversion is attributed to: Visit or Keyword+Ad. Corresponds to the JSON property attributionType

Returns:

  • (String) 


6227
6228
6229
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6227

def attribution_type
  @attribution_type
end

#click_id ⇒ String

Output only. A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter. Corresponds to the JSON property clickId

Returns:

  • (String) 


6233
6234
6235
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6233

def click_id
  @click_id
end

#conversion_date_time ⇒ String

Output only. The timestamp of the conversion event. Corresponds to the JSON property conversionDateTime

Returns:

  • (String) 


6238
6239
6240
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6238

def conversion_date_time
  @conversion_date_time
end

#conversion_last_modified_date_time ⇒ String

Output only. The timestamp of the last time the conversion was modified. Corresponds to the JSON property conversionLastModifiedDateTime

Returns:

  • (String) 


6243
6244
6245
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6243

def conversion_last_modified_date_time
  @conversion_last_modified_date_time
end

#conversion_quantity ⇒ Fixnum

Output only. The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1. Corresponds to the JSON property conversionQuantity

Returns:

  • (Fixnum) 


6251
6252
6253
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6251

def conversion_quantity
  @conversion_quantity
end

#conversion_revenue_micros ⇒ Fixnum

Output only. The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account. Corresponds to the JSON property conversionRevenueMicros

Returns:

  • (Fixnum) 


6257
6258
6259
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6257

def conversion_revenue_micros
  @conversion_revenue_micros
end

#conversion_visit_date_time ⇒ String

Output only. The timestamp of the visit that the conversion is attributed to. Corresponds to the JSON property conversionVisitDateTime

Returns:

  • (String) 


6262
6263
6264
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6262

def conversion_visit_date_time
  @conversion_visit_date_time
end

#criterion_id ⇒ Fixnum

Output only. Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed. Corresponds to the JSON property criterionId

Returns:

  • (Fixnum) 


6268
6269
6270
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6268

def criterion_id
  @criterion_id
end

#floodlight_order_id ⇒ String

Output only. The Floodlight order ID provided by the advertiser for the conversion. Corresponds to the JSON property floodlightOrderId

Returns:

  • (String) 


6274
6275
6276
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6274

def floodlight_order_id
  @floodlight_order_id
end

#floodlight_original_revenue ⇒ Fixnum

Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications. Corresponds to the JSON property floodlightOriginalRevenue

Returns:

  • (Fixnum) 


6281
6282
6283
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6281

def floodlight_original_revenue
  @floodlight_original_revenue
end

#id ⇒ Fixnum

Output only. The ID of the conversion Corresponds to the JSON property id

Returns:

  • (Fixnum) 


6286
6287
6288
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6286

def id
  @id
end

#merchant_id ⇒ Fixnum

Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


6293
6294
6295
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6293

def merchant_id
  @merchant_id
end

#product_channel ⇒ String

Output only. The sales channel of the product that was clicked on: Online or Local. Corresponds to the JSON property productChannel

Returns:

  • (String) 


6299
6300
6301
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6299

def product_channel
  @product_channel
end

#product_country_code ⇒ String

Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on. Corresponds to the JSON property productCountryCode

Returns:

  • (String) 


6305
6306
6307
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6305

def product_country_code
  @product_country_code
end

#product_id ⇒ String

Output only. The ID of the product clicked on. Corresponds to the JSON property productId

Returns:

  • (String) 


6310
6311
6312
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6310

def product_id
  @product_id
end

#product_language_code ⇒ String

Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product. Corresponds to the JSON property productLanguageCode

Returns:

  • (String) 


6316
6317
6318
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6316

def product_language_code
  @product_language_code
end

#product_store_id ⇒ String

Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. Corresponds to the JSON property productStoreId

Returns:

  • (String) 


6322
6323
6324
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6322

def product_store_id
  @product_store_id
end

#resource_name ⇒ String

Output only. The resource name of the conversion. Conversion resource names have the form: customers/customer_id/conversions/ad_group_id~ criterion_id~ds_conversion_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


6329
6330
6331
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6329

def resource_name
  @resource_name
end

#status ⇒ String

Output only. The status of the conversion, either ENABLED or REMOVED.. Corresponds to the JSON property status

Returns:

  • (String) 


6334
6335
6336
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6334

def status
  @status
end

#visit_id ⇒ Fixnum

Output only. The Search Ads 360 visit ID that the conversion is attributed to. Corresponds to the JSON property visitId

Returns:

  • (Fixnum) 


6339
6340
6341
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6339

def visit_id
  @visit_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6346

def update!(**args)
  @ad_id = args[:ad_id] if args.key?(:ad_id)
  @advertiser_conversion_id = args[:advertiser_conversion_id] if args.key?(:advertiser_conversion_id)
  @asset_field_type = args[:asset_field_type] if args.key?(:asset_field_type)
  @asset_id = args[:asset_id] if args.key?(:asset_id)
  @attribution_type = args[:attribution_type] if args.key?(:attribution_type)
  @click_id = args[:click_id] if args.key?(:click_id)
  @conversion_date_time = args[:conversion_date_time] if args.key?(:conversion_date_time)
  @conversion_last_modified_date_time = args[:conversion_last_modified_date_time] if args.key?(:conversion_last_modified_date_time)
  @conversion_quantity = args[:conversion_quantity] if args.key?(:conversion_quantity)
  @conversion_revenue_micros = args[:conversion_revenue_micros] if args.key?(:conversion_revenue_micros)
  @conversion_visit_date_time = args[:conversion_visit_date_time] if args.key?(:conversion_visit_date_time)
  @criterion_id = args[:criterion_id] if args.key?(:criterion_id)
  @floodlight_order_id = args[:floodlight_order_id] if args.key?(:floodlight_order_id)
  @floodlight_original_revenue = args[:floodlight_original_revenue] if args.key?(:floodlight_original_revenue)
  @id = args[:id] if args.key?(:id)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @product_channel = args[:product_channel] if args.key?(:product_channel)
  @product_country_code = args[:product_country_code] if args.key?(:product_country_code)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_language_code = args[:product_language_code] if args.key?(:product_language_code)
  @product_store_id = args[:product_store_id] if args.key?(:product_store_id)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
  @visit_id = args[:visit_id] if args.key?(:visit_id)
end