Method: customers.uploadClickConversions

处理指定的点击转化。

抛出的错误的列表：AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

HTTP 请求

POST https://googleads.googleapis.com/v17/customers/{customerId}:uploadClickConversions

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

必需。执行上传的客户 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
字段
conversions[]

object (ClickConversion)

必需。上传的转化数据。
partialFailure

boolean

必需。如果值为 true，则系统将执行成功的操作，而无效操作将返回错误。如果为 false，则当且仅当所有操作都有效时，才会在一个事务中执行所有操作。此字段应始终设置为 true。如需详细了解部分失败的操作，请参阅 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。
validateOnly

boolean

如果为 true，则系统会验证该请求，但不会执行该请求。仅返回错误，不返回结果。
debugEnabled

boolean

如果为 true，该 API 将执行所有上传检查，如果发现任何上传检查，则返回错误。如果为 false，它将仅执行基本的输入验证，跳过后续的上传检查，即使未找到针对提供的 userIdentifiers 的点击，也返回成功。

此设置只会影响使用 userIdentifiers（而非 GCLID、GBRAID 或 WBRAID）上传潜在客户的增强型转化。上传增强型潜在客户转化时，您应将所有转化事件上传到 API，包括可能并非来自 Google Ads 广告系列的转化事件。如果此字段设为 true，则上传的事件并非来自 Google Ads 广告系列，则会导致 CLICK_NOT_FOUND 错误。由于此类事件预计会出现这些错误，因此请将此字段设置为 false，这样您就可以确认上传内容的格式正确，同时忽略所有非 Google Ads 广告系列转化中的 CLICK_NOT_FOUND 错误。这样，您就可以只关注您可以解决的错误。

默认值为 false。
jobId

integer

可选。用于设置作业 ID 的可选输入。必须是小于 2^31 的非负数（如果提供）。如果未提供此字段，API 将生成 [2^31, (2^63)-1] 范围内的职位 ID。API 将在 UploadClickConversionsResponse 的 jobId 字段中返回此请求的值。

响应正文

ConversionUploadService.UploadClickConversions 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
字段
partialFailureError

object (Status)

与部分失败模式下的转化失败相关的错误。当转化内发生所有错误时返回。如果在转化之外发生任何错误（例如身份验证错误），我们将返回 RPC 级别的错误。如需详细了解部分失败的操作，请参阅 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures。
results[]

object (ClickConversionResult)

针对成功处理的转化返回。如果行收到错误，Proto 将为空。当 VerifyOnly 为 true 时，不返回结果。
jobId

string (int64 format)

批量上传的作业 ID。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/adwords

如需了解详情，请参阅 OAuth 2.0 概览。

ClickConversion

点击型转化。

JSON 表示法 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
字段
gbraid

string

与应用转化相关联且来自 iOS 14 及更高版本的点击的点击标识符。
wbraid

string

与网站转化相关联的点击，源自 iOS 14 及更高版本的点击的点击标识符。
externalAttributionData

object (ExternalAttributionData)

关于外部归因转化的其他数据。此字段是包含外部归因转化操作的转化所必需的，但不应设置。
customVariables[]

object (CustomVariable)

与此转化相关联的自定义变量。
cartData

object (CartData)

与此转化相关联的购物车数据。
userIdentifiers[]

object (UserIdentifier)

与此转化相关联的用户标识符。对于转化数据上传，仅支持 hashedEmail 和 hashedPhoneNumber。每次转化的用户标识符数量上限为 5 个。
conversionEnvironment

enum (ConversionEnvironment)

记录该转化的环境，例如应用或网站。
consent

object (Consent)

事件的用户意见征求设置。
gclid

string

与此转化相关联的 Google 点击 ID (gclid)。
conversionAction

string

与此转化相关联的转化操作的资源名称。注意：尽管此资源名称由客户 ID 和转化操作 ID 组成，但在验证过程中，系统会忽略客户 ID，而将转化操作 ID 用作转化操作的唯一标识符。
conversionDateTime

string

转化发生的日期时间。必须晚于点击时间。必须指定时区。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”，例如“2019-01-01 12:32:45-08:00”。
conversionValue

number

为广告客户带来的转化价值。
currencyCode

string

与转化价值相关联的币种。这是由 3 个字符组成的 ISO 4217 货币代码。例如：USD、EUR。
orderId

string

与转化相关联的订单 ID。对于每项转化操作，一个订单 ID 只能用于一次转化。

ExternalAttributionData

包含有关外部归因转化的更多信息。

JSON 表示法 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
字段
externalAttributionCredit

number

表示归因于 Google Ads 点击的转化所占的比例。
externalAttributionModel

string

指定归因模型名称。

CartData

包含有关购物车数据的更多信息。

JSON 表示法 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
字段
merchantId

string (int64 format)

用于上传商品数据的 Merchant Center ID。
feedCountryCode

string

与您上传的商品的 Feed 相关联的国家/地区代码。
feedLanguageCode

string

与上传商品数据的 Feed 相关联的语言代码。
localTransactionCost

number

所有交易级折扣的总和，例如整个购物车的免费送货和优惠券折扣。货币代码与 ClickConversion 消息中的货币代码相同。
items[]

object (Item)

所购商品的数据。

项

包含所购商品的数据。

JSON 表示法 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
字段
productId

string

商品的购物 ID。必须等于 Merchant Center 商品标识码。
quantity

integer

售出的商品数量。
unitPrice

number

单价（不含税费、运费和任何交易级折扣）。货币代码与 ClickConversion 消息中的货币代码相同。

ConversionEnvironment

已上传的转化的转化环境。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
APP 这次转化记录为某个应用。
WEB 转化记录在网站上。

ClickConversionResult

成功处理的 ClickConversion 的标识信息。

JSON 表示法 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
字段
gbraid

string

与应用转化相关联且来自 iOS 14 及更高版本的点击的点击标识符。
wbraid

string

与网站转化相关联的点击，源自 iOS 14 及更高版本的点击的点击标识符。
userIdentifiers[]

object (UserIdentifier)

与此转化相关联的用户标识符。对于转化数据上传，仅支持 hashedEmail 和 hashedPhoneNumber。每次转化的用户标识符数量上限为 5 个。
gclid

string

与此转化相关联的 Google 点击 ID (gclid)。
conversionAction

string

与此转化相关联的转化操作的资源名称。
conversionDateTime

string

转化发生的日期时间。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”，例如“2019-01-01 12:32:45-08:00”。