class Google::Apis::DoubleclicksearchV2::Conversion

A conversion containing data relevant to DoubleClick Search.

Attributes

ad_group_id[RW]

DS ad group ID. Corresponds to the JSON property `adGroupId` @return [String]

ad_id[RW]

DS ad ID. Corresponds to the JSON property `adId` @return [String]

advertiser_id[RW]

DS advertiser ID. Corresponds to the JSON property `advertiserId` @return [String]

agency_id[RW]

DS agency ID. Corresponds to the JSON property `agencyId` @return [String]

attribution_model[RW]

Available to advertisers only after contacting DoubleClick Search customer support. Corresponds to the JSON property `attributionModel` @return [String]

campaign_id[RW]

DS campaign ID. Corresponds to the JSON property `campaignId` @return [String]

channel[RW]

Sales channel for the product. Acceptable values are:

  • “local”: a physical store

  • “online”: an online store

Corresponds to the JSON property `channel` @return [String]

click_id[RW]

DS click ID for the conversion. Corresponds to the JSON property `clickId` @return [String]

conversion_id[RW]

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` @return [String]

conversion_modified_timestamp[RW]

The time at which the conversion was last modified, in epoch millis UTC. Corresponds to the JSON property `conversionModifiedTimestamp` @return [String]

conversion_timestamp[RW]

The time at which the conversion took place, in epoch millis UTC. Corresponds to the JSON property `conversionTimestamp` @return [String]

count_millis[RW]

Available to advertisers only after contacting DoubleClick Search customer support. Corresponds to the JSON property `countMillis` @return [String]

criterion_id[RW]

DS criterion (keyword) ID. Corresponds to the JSON property `criterionId` @return [String]

currency_code[RW]

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

custom_dimension[RW]

Custom dimensions for the conversion, which can be used to filter data in a report. Corresponds to the JSON property `customDimension` @return [Array<Google::Apis::DoubleclicksearchV2::CustomDimension>]

custom_metric[RW]

Custom metrics for the conversion. Corresponds to the JSON property `customMetric` @return [Array<Google::Apis::DoubleclicksearchV2::CustomMetric>]

device_type[RW]

The type of device on which the conversion occurred. Corresponds to the JSON property `deviceType` @return [String]

ds_conversion_id[RW]

ID that DoubleClick Search generates for each conversion. Corresponds to the JSON property `dsConversionId` @return [String]

engine_account_id[RW]

DS engine account ID. Corresponds to the JSON property `engineAccountId` @return [String]

floodlight_order_id[RW]

The Floodlight order ID provided by the advertiser for the conversion. Corresponds to the JSON property `floodlightOrderId` @return [String]

inventory_account_id[RW]

ID that DS generates and uses to uniquely identify the inventory account that contains the product. Corresponds to the JSON property `inventoryAccountId` @return [String]

product_country[RW]

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` @return [String]

product_group_id[RW]

DS product group ID. Corresponds to the JSON property `productGroupId` @return [String]

product_id[RW]

The product ID (SKU). Corresponds to the JSON property `productId` @return [String]

product_language[RW]

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` @return [String]

quantity_millis[RW]

The quantity of this conversion, in millis. Corresponds to the JSON property `quantityMillis` @return [String]

revenue_micros[RW]

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` @return [String]

segmentation_id[RW]

The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). Corresponds to the JSON property `segmentationId` @return [String]

segmentation_name[RW]

The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). Corresponds to the JSON property `segmentationName` @return [String]

segmentation_type[RW]

The segmentation type of this conversion (for example, FLOODLIGHT). Corresponds to the JSON property `segmentationType` @return [String]

state[RW]

The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. Corresponds to the JSON property `state` @return [String]

store_id[RW]

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` @return [String]

type[RW]

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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/doubleclicksearch_v2/classes.rb, line 268
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# 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