Method: customers.uploadConversionAdjustments

处理指定的转化调整。

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

HTTP 请求

POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadConversionAdjustments

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

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

请求正文

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

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

object (ConversionAdjustment)

必需。将上传的转化调整。

partialFailure

boolean

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

validateOnly

boolean

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

jobId

integer

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

响应正文

ConversionAdjustmentUploadService.UploadConversionAdjustments 的响应消息。

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

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

object (Status)

与部分失败模式下的转化调整失败相关的错误。当所有错误都发生在调整内时,系统会返回此错误代码。如果调整范围之外发生任何错误(例如身份验证错误),我们会返回 RPC 级错误。如需详细了解部分失败,请参阅 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures

results[]

object (ConversionAdjustmentResult)

针对成功处理的转化调整返回。对于收到错误的行,Proto 将为空。当 verifyOnly 为 true 时,不返回结果。

jobId

string (int64 format)

批量上传的作业 ID。

授权范围

需要以下 OAuth 作用域:

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

有关详情,请参阅 OAuth 2.0 概览

ConversionAdjustment

转化调整。

JSON 表示法
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "adjustmentType": enum (ConversionAdjustmentType),
  "restatementValue": {
    object (RestatementValue)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "orderId": string,
  "conversionAction": string,
  "adjustmentDateTime": string,
  "userAgent": string
}
字段
gclidDateTimePair

object (GclidDateTimePair)

对于调整项,用于唯一标识在未指定订单 ID 的情况下报告的转化。如果调整项类型为 ENHANCEMENT,则此值是可选的,但可以与 orderId 一同设置。

adjustmentType

enum (ConversionAdjustmentType)

调整类型。

restatementValue

object (RestatementValue)

重申转化价值所需的信息。重报时必填。不应为撤消请求提供。如果提供了撤消请求,系统将会返回错误。注意:如果您想使用另一个调整后的值上传第二次重报,则必须具有新的调整发生时间。否则,将被视为与上一次重报操作重复,并被忽略。

userIdentifiers[]

object (UserIdentifier)

用于增强原始转化的用户标识符。ConversionAdjustmentUploadService 仅接受增强功能中的用户标识符。每项增强功能的用户标识符数量上限为 5 个。

orderId

string

要调整的转化的订单 ID。如果报告转化时指定了订单 ID,则此处必须使用该订单 ID 作为标识符。必须提供订单 ID 才能使用增强功能。

conversionAction

string

与此转化调整相关联的转化操作的资源名称。注意:虽然此资源名称由客户 ID 和转化操作 ID 组成,但验证过程会忽略客户 ID,并将转化操作 ID 用作转化操作的唯一标识符。

adjustmentDateTime

string

进行调整的日期。必须晚于 conversionDateTime。必须指定时区。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”,例如“2019-01-01 12:32:45-08:00”。

userAgent

string

用于增强原始转化的用户代理。当用户在您的网页上完成转化时,您可以在其 HTTP 请求标头中找到此信息。例如“Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)”。只能在带有用户标识符的增强功能中指定用户代理。这应与发送原始转化的请求的用户代理一致,以便相应转化及其增强功能可以同时归因于同一设备,或同时归因于跨设备。

GclidDateTimePair

唯一标识在未指定订单 ID 的情况下报告的转化。

JSON 表示法
{
  "gclid": string,
  "conversionDateTime": string
}
字段
gclid

string

与此调整的原始转化相关联的 Google 点击 ID (gclid)。

conversionDateTime

string

此调整的原始转化的发生日期。必须指定时区。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”,例如“2019-01-01 12:32:45-08:00”。

ConversionAdjustmentType

广告客户可以采取哪些不同的操作来调整已报告的转化。撤消会使转化失效。重报会改变转化价值。

枚举
UNSPECIFIED 未指定。
UNKNOWN 表示此版本中的未知值。
RETRACTION 对转化进行否定,使其总价值和计数都为零。
RESTATEMENT 更改转化价值。
ENHANCEMENT 使用所提供的用户标识符和用户代理对现有转化进行补充,Google 可以使用这些信息来增加转化次数。

RestatementValue

包含重申转化价值所需的信息。

JSON 表示法
{
  "adjustedValue": number,
  "currencyCode": string
}
字段
adjustedValue

number

重报的转化价值。这是重报后的转化价值。例如,要将转化价值从 100 更改为 70,应报告调整后的价值 70。注意:如果您想使用另一个调整后的值上传第二次重报,则必须具有新的调整发生时间。否则,将被视为与上一次重报操作重复,并被忽略。

currencyCode

string

重报价值的币种。如果未提供此项,系统会使用转化操作的默认币种;如果未设置,则使用账号币种。这是由 3 个字符组成的 ISO 4217 货币代码,例如 USD 或 EUR。

ConversionAdjustmentResult

用于标识已成功处理的转化调整的信息。

JSON 表示法
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "orderId": string,
  "adjustmentType": enum (ConversionAdjustmentType),
  "conversionAction": string,
  "adjustmentDateTime": string
}
字段
gclidDateTimePair

object (GclidDateTimePair)

转化的 GCLID 和转化日期时间。

orderId

string

要调整的转化的订单 ID。

adjustmentType

enum (ConversionAdjustmentType)

调整类型。

conversionAction

string

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

adjustmentDateTime

string

进行调整的日期。格式为“yyyy-mm-dd hh:mm:ss+|-hh:mm”,例如“2019-01-01 12:32:45-08:00”。