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.



6113
6114
6115
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6113

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) 


5975
5976
5977
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5975

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) 


5983
5984
5985
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5983

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) 


5988
5989
5990
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5988

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) 


5994
5995
5996
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5994

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) 


5999
6000
6001
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5999

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) 


6005
6006
6007
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6005

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) 


6010
6011
6012
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6010

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) 


6015
6016
6017
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6015

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) 


6023
6024
6025
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6023

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) 


6029
6030
6031
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6029

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) 


6034
6035
6036
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6034

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) 


6040
6041
6042
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6040

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) 


6046
6047
6048
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6046

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) 


6053
6054
6055
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6053

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) 


6058
6059
6060
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6058

def id
  @id
end

#merchant_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


6065
6066
6067
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6065

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) 


6071
6072
6073
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6071

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) 


6077
6078
6079
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6077

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) 


6082
6083
6084
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6082

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) 


6088
6089
6090
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6088

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) 


6094
6095
6096
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6094

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) 


6101
6102
6103
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6101

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) 


6106
6107
6108
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6106

def status
  @status
end

#visit_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


6111
6112
6113
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6111

def visit_id
  @visit_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 6118

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