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

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

Overview

A conversion containing data relevant to DoubleClick Search.

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.


268
269
270
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 268

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

Instance Attribute Details

#ad_group_idString

DS ad group ID. Corresponds to the JSON property adGroupId

Returns:

  • (String)

84
85
86
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 84

def ad_group_id
  @ad_group_id
end

#ad_idString

DS ad ID. Corresponds to the JSON property adId

Returns:

  • (String)

89
90
91
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 89

def ad_id
  @ad_id
end

#advertiser_idString

DS advertiser ID. Corresponds to the JSON property advertiserId

Returns:

  • (String)

94
95
96
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 94

def advertiser_id
  @advertiser_id
end

#agency_idString

DS agency ID. Corresponds to the JSON property agencyId

Returns:

  • (String)

99
100
101
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 99

def agency_id
  @agency_id
end

#attribution_modelString

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

Returns:

  • (String)

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

def attribution_model
  @attribution_model
end

#campaign_idString

DS campaign ID. Corresponds to the JSON property campaignId

Returns:

  • (String)

110
111
112
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 110

def campaign_id
  @campaign_id
end

#channelString

Sales channel for the product. Acceptable values are:

  • "local": a physical store
  • "online": an online store Corresponds to the JSON property channel

Returns:

  • (String)

117
118
119
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 117

def channel
  @channel
end

#click_idString

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

Returns:

  • (String)

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

def click_id
  @click_id
end

#conversion_idString

For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. 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)

130
131
132
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 130

def conversion_id
  @conversion_id
end

#conversion_modified_timestampString

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

Returns:

  • (String)

135
136
137
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 135

def conversion_modified_timestamp
  @conversion_modified_timestamp
end

#conversion_timestampString

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

Returns:

  • (String)

140
141
142
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 140

def conversion_timestamp
  @conversion_timestamp
end

#count_millisString

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

Returns:

  • (String)

146
147
148
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 146

def count_millis
  @count_millis
end

#criterion_idString

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

Returns:

  • (String)

151
152
153
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 151

def criterion_id
  @criterion_id
end

#currency_codeString

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)

157
158
159
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 157

def currency_code
  @currency_code
end

#custom_dimensionArray<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


163
164
165
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 163

def custom_dimension
  @custom_dimension
end

#custom_metricArray<Google::Apis::DoubleclicksearchV2::CustomMetric>

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


168
169
170
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 168

def custom_metric
  @custom_metric
end

#device_typeString

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

Returns:

  • (String)

173
174
175
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 173

def device_type
  @device_type
end

#ds_conversion_idString

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

Returns:

  • (String)

178
179
180
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 178

def ds_conversion_id
  @ds_conversion_id
end

#engine_account_idString

DS engine account ID. Corresponds to the JSON property engineAccountId

Returns:

  • (String)

183
184
185
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 183

def 
  @engine_account_id
end

#floodlight_order_idString

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

Returns:

  • (String)

188
189
190
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 188

def floodlight_order_id
  @floodlight_order_id
end

#inventory_account_idString

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

Returns:

  • (String)

194
195
196
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 194

def 
  @inventory_account_id
end

#product_countryString

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)

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

def product_country
  @product_country
end

#product_group_idString

DS product group ID. Corresponds to the JSON property productGroupId

Returns:

  • (String)

205
206
207
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 205

def product_group_id
  @product_group_id
end

#product_idString

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

Returns:

  • (String)

210
211
212
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 210

def product_id
  @product_id
end

#product_languageString

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)

216
217
218
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 216

def product_language
  @product_language
end

#quantity_millisString

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

Returns:

  • (String)

221
222
223
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 221

def quantity_millis
  @quantity_millis
end

#revenue_microsString

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)

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

def revenue_micros
  @revenue_micros
end

#segmentation_idString

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

Returns:

  • (String)

234
235
236
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 234

def segmentation_id
  @segmentation_id
end

#segmentation_nameString

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

Returns:

  • (String)

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

def segmentation_name
  @segmentation_name
end

#segmentation_typeString

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

Returns:

  • (String)

245
246
247
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 245

def segmentation_type
  @segmentation_type
end

#stateString

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

Returns:

  • (String)

251
252
253
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 251

def state
  @state
end

#store_idString

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)

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

def store_id
  @store_id
end

#typeString

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)

266
267
268
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 266

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 273

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