转化资源提供了一些方法,可让用户批量创建、修改和检索 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, "sessionAttributesEncoded": bytes } ] }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
conversion[] |
list |
请求的转化。 | |
conversion[].adGroupId |
long |
DS 广告组 ID。 | |
conversion[].adId |
long |
DS 广告 ID。 | |
conversion[].adUserDataConsent |
string |
表示用户是否同意在设置中使用核心平台服务 (CPS) 偏好设置。无默认值。可接受的值:已同意:所需的用户同意情况为“同意”。从 GTE 设置中读取 CPS 偏好设置。已拒绝:所需的用户同意情况为“拒绝”;CPS 列表为空。
可接受的值包括:
|
|
conversion[].advertiserId |
long |
DS 广告客户 ID。 | |
conversion[].agencyId |
long |
DS 代理机构 ID。 | |
conversion[].attributionModel |
string |
只有在与 DoubleClick Search 客户支持团队联系后,广告客户才能使用此功能。 | |
conversion[].campaignId |
long |
DS 广告系列 ID。 | |
conversion[].channel |
string |
商品的销售渠道。可接受的值:
|
|
conversion[].clickId |
string |
相应转化的 DS 点击 ID。 | |
conversion[].conversionId |
string |
对于线下转化,此 ID 由广告客户提供。广告客户可以指定对他们有意义的任何 ID。请求中的每个转化都必须指定一个唯一 ID,并且 ID 和时间戳的组合在广告客户的所有转化中必须是唯一的。 对于线上转化,DS 会根据广告客户的 Floodlight 指令将 dsConversionId 或 floodlightOrderId 复制到此媒体资源。 |
|
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 |
发生该次转化的设备类型。
可接受的值包括:
|
|
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 万)。 |
可写入 |
conversion[].segmentationId |
long |
数字细分标识符(例如 DoubleClick Search Floodlight 活动 ID)。 | |
conversion[].segmentationName |
string |
友好的细分标识符(例如,DoubleClick Search Floodlight 活动名称)。 | |
conversion[].segmentationType |
string |
此转化的细分类型(例如 FLOODLIGHT )。
可接受的值为:
|
|
conversion[].sessionAttributesEncoded |
bytes |
事件的会话属性,表示为 base64 编码的 JSON 字符串。内容应由 Google 提供的库生成。 | |
conversion[].state |
string |
转化的状态,可以是 ACTIVE 或 REMOVED 。注意:状态“DELETED”已废弃。
可接受的值:
|
可写入 |
conversion[].storeId |
string |
宣传相应产品的本地商店的 ID。仅当渠道为“local ”时适用。 |
|
conversion[].type |
string |
转化的类型,即 ACTION 或 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 活动的播出信息。