Class: Google::Apis::DoubleclicksearchV2::Conversion

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

Overview

A conversion containing data relevant to DoubleClick Search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Conversion

Returns a new instance of Conversion.



280
281
282
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 280

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

Instance Attribute Details

#ad_group_id ⇒ Fixnum

DS ad group ID. Corresponds to the JSON property adGroupId

Returns:

  • (Fixnum) 


90
91
92
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 90

def ad_group_id
  @ad_group_id
end

#ad_id ⇒ Fixnum

DS ad ID. Corresponds to the JSON property adId

Returns:

  • (Fixnum) 


95
96
97
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 95

def ad_id
  @ad_id
end

#advertiser_id ⇒ Fixnum

DS advertiser ID. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


100
101
102
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 100

def advertiser_id
  @advertiser_id
end

#agency_id ⇒ Fixnum

DS agency ID. Corresponds to the JSON property agencyId

Returns:

  • (Fixnum) 


105
106
107
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 105

def agency_id
  @agency_id
end

#attribution_model ⇒ String

Available to advertisers only after contacting DoubleClick Search customer support. Corresponds to the JSON property attributionModel

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 111

def attribution_model
  @attribution_model
end

#campaign_id ⇒ Fixnum

DS campaign ID. Corresponds to the JSON property campaignId

Returns:

  • (Fixnum) 


116
117
118
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 116

def campaign_id
  @campaign_id
end

#channel ⇒ String

Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store Corresponds to the JSON property channel

Returns:

  • (String) 


122
123
124
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 122

def channel
  @channel
end

#click_id ⇒ String

DS click ID for the conversion. Corresponds to the JSON property clickId

Returns:

  • (String) 


127
128
129
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 127

def click_id
  @click_id
end

#conversion_id ⇒ String

For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. Corresponds to the JSON property conversionId

Returns:

  • (String) 


137
138
139
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 137

def conversion_id
  @conversion_id
end

#conversion_modified_timestamp ⇒ Fixnum

The time at which the conversion was last modified, in epoch millis UTC. Corresponds to the JSON property conversionModifiedTimestamp

Returns:

  • (Fixnum) 


142
143
144
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 142

def conversion_modified_timestamp
  @conversion_modified_timestamp
end

#conversion_timestamp ⇒ String

The time at which the conversion took place, in epoch millis UTC. Corresponds to the JSON property conversionTimestamp

Returns:

  • (String) 


147
148
149
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 147

def conversion_timestamp
  @conversion_timestamp
end

#count_millis ⇒ Fixnum

Available to advertisers only after contacting DoubleClick Search customer support. Corresponds to the JSON property countMillis

Returns:

  • (Fixnum) 


153
154
155
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 153

def count_millis
  @count_millis
end

#criterion_id ⇒ Fixnum

DS criterion (keyword) ID. Corresponds to the JSON property criterionId

Returns:

  • (Fixnum) 


158
159
160
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 158

def criterion_id
  @criterion_id
end

#currency_code ⇒ String

The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


164
165
166
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 164

def currency_code
  @currency_code
end

#custom_dimension ⇒ Array<Google::Apis::DoubleclicksearchV2::CustomDimension>

Custom dimensions for the conversion, which can be used to filter data in a report. Corresponds to the JSON property customDimension

Returns:



170
171
172
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 170

def custom_dimension
  @custom_dimension
end

#custom_metric ⇒ Array<Google::Apis::DoubleclicksearchV2::CustomMetric>

Custom metrics for the conversion. Corresponds to the JSON property customMetric

Returns:



175
176
177
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 175

def custom_metric
  @custom_metric
end

#customer_id ⇒ String

Customer ID of a client account in the new Search Ads 360 experience. Corresponds to the JSON property customerId

Returns:

  • (String) 


180
181
182
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 180

def customer_id
  @customer_id
end

#device_type ⇒ String

The type of device on which the conversion occurred. Corresponds to the JSON property deviceType

Returns:

  • (String) 


185
186
187
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 185

def device_type
  @device_type
end

#ds_conversion_id ⇒ Fixnum

ID that DoubleClick Search generates for each conversion. Corresponds to the JSON property dsConversionId

Returns:

  • (Fixnum) 


190
191
192
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 190

def ds_conversion_id
  @ds_conversion_id
end

#engine_account_id ⇒ Fixnum

DS engine account ID. Corresponds to the JSON property engineAccountId

Returns:

  • (Fixnum) 


195
196
197
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 195

def 
  @engine_account_id
end

#floodlight_order_id ⇒ String

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

Returns:

  • (String) 


200
201
202
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 200

def floodlight_order_id
  @floodlight_order_id
end

#inventory_account_id ⇒ Fixnum

ID that DS generates and uses to uniquely identify the inventory account that contains the product. Corresponds to the JSON property inventoryAccountId

Returns:

  • (Fixnum) 


206
207
208
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 206

def 
  @inventory_account_id
end

#product_country ⇒ String

The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. Corresponds to the JSON property productCountry

Returns:

  • (String) 


212
213
214
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 212

def product_country
  @product_country
end

#product_group_id ⇒ Fixnum

DS product group ID. Corresponds to the JSON property productGroupId

Returns:

  • (Fixnum) 


217
218
219
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 217

def product_group_id
  @product_group_id
end

#product_id ⇒ String

The product ID (SKU). Corresponds to the JSON property productId

Returns:

  • (String) 


222
223
224
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 222

def product_id
  @product_id
end

#product_language ⇒ String

The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. Corresponds to the JSON property productLanguage

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 228

def product_language
  @product_language
end

#quantity_millis ⇒ Fixnum

The quantity of this conversion, in millis. Corresponds to the JSON property quantityMillis

Returns:

  • (Fixnum) 


233
234
235
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 233

def quantity_millis
  @quantity_millis
end

#revenue_micros ⇒ String

The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. Corresponds to the JSON property revenueMicros

Returns:

  • (String) 


240
241
242
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 240

def revenue_micros
  @revenue_micros
end

#segmentation_id ⇒ Fixnum

The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). Corresponds to the JSON property segmentationId

Returns:

  • (Fixnum) 


246
247
248
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 246

def segmentation_id
  @segmentation_id
end

#segmentation_name ⇒ String

The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). Corresponds to the JSON property segmentationName

Returns:

  • (String) 


252
253
254
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 252

def segmentation_name
  @segmentation_name
end

#segmentation_type ⇒ String

The segmentation type of this conversion (for example, FLOODLIGHT). Corresponds to the JSON property segmentationType

Returns:

  • (String) 


257
258
259
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 257

def segmentation_type
  @segmentation_type
end

#state ⇒ String

The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. Corresponds to the JSON property state

Returns:

  • (String) 


263
264
265
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 263

def state
  @state
end

#store_id ⇒ String

The ID of the local store for which the product was advertised. Applicable only when the channel is "local". Corresponds to the JSON property storeId

Returns:

  • (String) 


269
270
271
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 269

def store_id
  @store_id
end

#type ⇒ String

The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION ) versus ecommerce purchases (TRANSACTION). Corresponds to the JSON property type

Returns:

  • (String) 


278
279
280
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 278

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/apis/doubleclicksearch_v2/classes.rb', line 285

def update!(**args)
  @ad_group_id = args[:ad_group_id] if args.key?(:ad_group_id)
  @ad_id = args[:ad_id] if args.key?(:ad_id)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @agency_id = args[:agency_id] if args.key?(:agency_id)
  @attribution_model = args[:attribution_model] if args.key?(:attribution_model)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @channel = args[:channel] if args.key?(:channel)
  @click_id = args[:click_id] if args.key?(:click_id)
  @conversion_id = args[:conversion_id] if args.key?(:conversion_id)
  @conversion_modified_timestamp = args[:conversion_modified_timestamp] if args.key?(:conversion_modified_timestamp)
  @conversion_timestamp = args[:conversion_timestamp] if args.key?(:conversion_timestamp)
  @count_millis = args[:count_millis] if args.key?(:count_millis)
  @criterion_id = args[:criterion_id] if args.key?(:criterion_id)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
  @custom_metric = args[:custom_metric] if args.key?(:custom_metric)
  @customer_id = args[:customer_id] if args.key?(:customer_id)
  @device_type = args[:device_type] if args.key?(:device_type)
  @ds_conversion_id = args[:ds_conversion_id] if args.key?(:ds_conversion_id)
  @engine_account_id = args[:engine_account_id] if args.key?(:engine_account_id)
  @floodlight_order_id = args[:floodlight_order_id] if args.key?(:floodlight_order_id)
  @inventory_account_id = args[:inventory_account_id] if args.key?(:inventory_account_id)
  @product_country = args[:product_country] if args.key?(:product_country)
  @product_group_id = args[:product_group_id] if args.key?(:product_group_id)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_language = args[:product_language] if args.key?(:product_language)
  @quantity_millis = args[:quantity_millis] if args.key?(:quantity_millis)
  @revenue_micros = args[:revenue_micros] if args.key?(:revenue_micros)
  @segmentation_id = args[:segmentation_id] if args.key?(:segmentation_id)
  @segmentation_name = args[:segmentation_name] if args.key?(:segmentation_name)
  @segmentation_type = args[:segmentation_type] if args.key?(:segmentation_type)
  @state = args[:state] if args.key?(:state)
  @store_id = args[:store_id] if args.key?(:store_id)
  @type = args[:type] if args.key?(:type)
end