Conversion

转化资源包含允许用户批量创建、修改和检索 Floodlight 转化数据的方法。

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

转化列表。

{
  "kind": "doubleclicksearch#conversionList",
  "conversion": [
    {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "customerId": string,
      "adGroupId": long,
      "criterionId": long,
      "adId": long,
      "clickId": string,
      "dsConversionId": long,
      "conversionId": string,
      "state": string,
      "type": string,
      "revenueMicros": long,
      "currencyCode": string,
      "quantityMillis": long,
      "segmentationType": string,
      "segmentationId": long,
      "segmentationName": string,
      "conversionTimestamp": unsigned long,
      "conversionModifiedTimestamp": unsigned long,
      "floodlightOrderId": string,
      "customMetric": [
        {
          "name": string,
          "value": double
        }
      ],
      "customDimension": [
        {
          "name": string,
          "value": string
        }
      ],
      "countMillis": long,
      "attributionModel": string,
      "productGroupId": long,
      "inventoryAccountId": long,
      "productId": string,
      "productCountry": string,
      "productLanguage": string,
      "channel": string,
      "storeId": string,
      "deviceType": string,
      "adUserDataConsent": string
    }
  ]
}
属性名称 说明 备注
conversion[] list 请求的转化。
conversion[].adGroupId long DS 广告组 ID。
conversion[].adId long DS 广告 ID。
conversion[].adUserDataConsent string 表示设置中针对核心平台服务 (CPS) 偏好设置的用户意见征求。无默认值。可接受的值为:GRANTED:表示所需的意见征求状态为“granted”。请在 GTE 设置中读取 CPS 偏好设置。DENIED:期望的意见征求状态为“拒绝”;CPS 列表为空。
conversion[].advertiserId long DS 广告客户 ID。
conversion[].agencyId long DS 代理机构 ID。
conversion[].attributionModel string 广告客户只有在与 DoubleClick Search 客户支持小组联系后,才能使用此列。
conversion[].campaignId long DS 广告系列 ID。
conversion[].channel string 产品的销售渠道。可接受的值包括:
  • local”:实体店
  • online”:网店
conversion[].clickId string 转化的 DS 点击 ID。
conversion[].conversionId string 对于线下转化,广告客户需提供此 ID。广告客户可以指定对他们有意义的任何 ID。请求中的每次转化都必须指定一个唯一 ID,并且 ID 和时间戳的组合在广告客户的所有转化中必须是唯一的。
对于线上转化,DS 会根据广告客户的 Floodlight 说明,将 dsConversionIdfloodlightOrderId 复制到此媒体资源中。
conversion[].conversionModifiedTimestamp unsigned long 转化的上次修改时间,以新纪元毫秒 (UTC) 为单位。
conversion[].conversionTimestamp unsigned long 转化发生的时间,以新纪元毫秒数 UTC 为单位。
conversion[].countMillis long 广告客户只有在与 DoubleClick Search 客户支持小组联系后,才能使用此列。
conversion[].criterionId long DS 条件(关键字)ID。
conversion[].currencyCode string 转化收入的货币代码。应采用 ISO 4217 字母(3 个字符)格式。 可写入
conversion[].customDimension[] list 转化的自定义维度,可用于过滤报告中的数据。
conversion[].customDimension[].name string 自定义维度名称。
conversion[].customDimension[].value string 自定义维度值。
conversion[].customMetric[] list 转化的自定义指标。
conversion[].customMetric[].name string 自定义指标名称。
conversion[].customMetric[].value double 自定义指标数值。
conversion[].customerId string 新版 Search Ads 360 客户 ID。必须是客户账号。设置此字段后,所有其他 ID 字段都应设为新版 Search Ads 360 ID。
conversion[].deviceType string 发生该次转化的设备类型。

可接受的值包括:
  • DESKTOP
  • HIGH_END_MOBILE
  • OTHER_DEVICE
  • TABLET
conversion[].dsConversionId long DoubleClick Search 为每次转化生成的 ID。
conversion[].engineAccountId long DS 引擎账号 ID。
conversion[].floodlightOrderId string 广告客户为转化提供的 Floodlight 订单 ID。
conversion[].inventoryAccountId long DS 生成的 ID,用于唯一标识包含该产品的产品目录账号。
conversion[].productCountry string 针对包含相应产品的 Merchant Center Feed 注册的国家/地区。使用 ISO 3166 代码指定国家/地区。
conversion[].productGroupId long DS 产品组 ID。
conversion[].productId string 产品 ID (SKU)。
conversion[].productLanguage string 为包含相应产品的 Merchant Center Feed 注册的语言。请使用 ISO 639 代码指定语言。
conversion[].quantityMillis long 此次转化的数量,以毫米为单位。 可写入
conversion[].revenueMicros long 此次 TRANSACTION 转化的收入金额,以微单位表示(值乘以 1000000,不含小数)。例如,要将收入值指定为“10”输入“10000000”(1,000,000)。 可写入
conversion[].segmentationId long 数字形式的细分标识符(例如 DoubleClick Search Floodlight 活动 ID)。
conversion[].segmentationName string 易记的细分标识符(例如 DoubleClick Search Floodlight 活动名称)。
conversion[].segmentationType string 此转化的细分类型(例如 FLOODLIGHT)。

可接受的值为: <ph type="x-smartling-placeholder">
    </ph>
  • FLOODLIGHT
conversion[].state string 转化的状态,即 ACTIVEREMOVED。注意:状态 DELETED 已弃用。

可接受的值包括: <ph type="x-smartling-placeholder">
    </ph>
  • ACTIVE
  • DELETED”:(已弃用)
  • REMOVED
可写入
conversion[].storeId string 宣传商品的本地商店的 ID。仅当渠道为“local”时适用。
conversion[].type string 转化的类型,即 ACTIONTRANSACTIONACTION 转化是用户执行的操作,没有金钱价值,而 TRANSACTION 转化则是具有金钱价值的操作。例如,注册电子邮件收件人列表(ACTION)与电子商务购买(TRANSACTION)。

可接受的值为:
  • ACTION
  • TRANSACTION
kind string 将此标识为 ConversionList 资源。值:固定字符串 doubleclicksearch#conversionList

方法

get
从 DoubleClick Search 引擎账号中检索转化列表。
getByCustomerId
使用新的 Search Ads 360 客户 ID 从 DoubleClick Search 引擎账号中检索转化列表。
insert
将一批新的转化插入到 DoubleClick Search 中。
update
在 DoubleClick Search 中批量更新转化数据。
updateAvailability
在 DoubleClick Search 中更新一批 Floodlight 活动的可用情况。