- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- ClickConversion
- ExternalAttributionData
- CartData
- 单项
- ConversionEnvironment
- ClickConversionResult
- 试试看!
处理指定的点击转化。
抛出的错误列表:AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError
HTTP 请求
POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadClickConversions
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customerId |
必需。执行上传的客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"conversions": [
{
object ( |
字段 | |
---|---|
conversions[] |
必需。将上传的转化数据。 |
partialFailure |
必需。如果为 true,将执行成功的操作,而无效操作将返回错误。如果为 false,当且仅当所有操作均有效时,所有操作都将在一个事务中执行。此字段始终都应设为 true。如需详细了解部分失败,请参阅 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。 |
validateOnly |
如果为 true,则会验证该请求,但不会执行该请求。系统只会返回错误,不会返回结果。 |
debugEnabled |
如果为 true,该 API 将执行所有上传检查,如果发现错误,则返回错误。如果为 false,则仅执行基本的输入验证,跳过后续的上传检查,即使未找到提供的 此设置只会影响上传使用 默认值为 false。 |
jobId |
可选。用于设置作业 ID 的可选输入。必须是小于 2^31 的非负数(如果提供)。如果未提供此字段,API 将生成 [2^31, (2^63)-1] 范围内的职位 ID。API 将在 |
响应正文
ConversionUploadService.UploadClickConversions
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "partialFailureError": { object ( |
字段 | |
---|---|
partialFailureError |
与部分失败模式下的转化失败相关的错误。当所有错误都发生在转化内时,系统会返回此错误代码。如果转化之外发生任何错误(例如身份验证错误),我们会返回 RPC 级错误。如需详细了解部分失败,请参阅 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。 |
results[] |
针对成功处理的转化返回。对于收到错误的行,Proto 将为空。当 verifyOnly 为 true 时,不返回结果。 |
jobId |
批量上传的作业 ID。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/adwords
有关详情,请参阅 OAuth 2.0 概览。
ClickConversion
一次点击转化。
JSON 表示法 |
---|
{ "gbraid": string, "wbraid": string, "externalAttributionData": { object ( |
字段 | |
---|---|
gbraid |
与应用转化相关联且源自 iOS 14 及更高版本的 iOS 设备的点击的点击标识符。 |
wbraid |
与网站转化相关且源自 iOS 14 及以上版本的 iOS 设备的点击的点击标识符。 |
externalAttributionData |
有关外部归因转化的其他数据。对于具有外部归因的转化操作的转化,此字段是必填字段,但不应另外设置。 |
customVariables[] |
与此转化相关联的自定义变量。 |
cartData |
与此转化相关联的购物车数据。 |
userIdentifiers[] |
与此转化相关联的用户标识符。转化数据上传仅支持 hashedEmail 和 hashedPhoneNumber。每次转化的用户标识符数量上限为 5 个。 |
conversionEnvironment |
记录此转化的环境,例如“应用”或“网站”。 |
consent |
事件的用户意见征求设置。 |
gclid |
与此转化相关联的 Google 点击 ID (gclid)。 |
conversionAction |
与此转化相关联的转化操作的资源名称。注意:虽然此资源名称由客户 ID 和转化操作 ID 组成,但验证过程会忽略客户 ID,并将转化操作 ID 用作转化操作的唯一标识符。 |
conversionDateTime |
转化发生的日期和时间。必须晚于点击时间。必须指定时区。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”,例如“2019-01-01 12:32:45-08:00”。 |
conversionValue |
广告客户的转化价值。 |
currencyCode |
与转化价值相关联的币种。这是由 3 个字符组成的 ISO 4217 货币代码。例如:USD、EUR。 |
orderId |
与转化相关联的订单 ID。对于每项转化操作,一个订单 ID 只能用于一次转化。 |
ExternalAttributionData
包含有关外部归因转化的更多信息。
JSON 表示法 |
---|
{ "externalAttributionCredit": number, "externalAttributionModel": string } |
字段 | |
---|---|
externalAttributionCredit |
表示归因于 Google Ads 点击的转化所占的比例。 |
externalAttributionModel |
指定归因模型名称。 |
CartData
包含有关购物车数据的其他信息。
JSON 表示法 |
---|
{
"merchantId": string,
"feedCountryCode": string,
"feedLanguageCode": string,
"localTransactionCost": number,
"items": [
{
object ( |
字段 | |
---|---|
merchantId |
用于上传商品数据的 Merchant Center ID。 |
feedCountryCode |
与您上传的商品的 Feed 相关联的国家/地区代码。 |
feedLanguageCode |
您用来上传商品数据的 Feed 所关联的语言代码。 |
localTransactionCost |
所有交易级折扣(例如整个购物车中的免运费和优惠券折扣)的总和。货币代码与 ClickConversion 消息中的货币代码相同。 |
items[] |
所购商品的数据。 |
商品
包含所购商品的数据。
JSON 表示法 |
---|
{ "productId": string, "quantity": integer, "unitPrice": number } |
字段 | |
---|---|
productId |
商品的购物 ID。必须等于 Merchant Center 商品标识码。 |
quantity |
售出的商品数量。 |
unitPrice |
单价(不含税、运费及任何交易级折扣)。货币代码与 ClickConversion 消息中的货币代码相同。 |
ConversionEnvironment
上传的转化数据的转化环境。
枚举 | |
---|---|
UNSPECIFIED |
未指定。 |
UNKNOWN |
仅用于返回值。表示此版本中的未知值。 |
APP |
该转化记录在某款应用中。 |
WEB |
转化被记录在一个网站上。 |
ClickConversionResult
成功处理的 ClickConversion 的标识信息。
JSON 表示法 |
---|
{
"gbraid": string,
"wbraid": string,
"userIdentifiers": [
{
object ( |
字段 | |
---|---|
gbraid |
与应用转化相关联且源自 iOS 14 及更高版本的 iOS 设备的点击的点击标识符。 |
wbraid |
与网站转化相关且源自 iOS 14 及以上版本的 iOS 设备的点击的点击标识符。 |
userIdentifiers[] |
与此转化相关联的用户标识符。转化数据上传仅支持 hashedEmail 和 hashedPhoneNumber。每次转化的用户标识符数量上限为 5 个。 |
gclid |
与此转化相关联的 Google 点击 ID (gclid)。 |
conversionAction |
与此转化相关联的转化操作的资源名称。 |
conversionDateTime |
转化发生的日期和时间。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”,例如“2019-01-01 12:32:45-08:00”。 |