Method: customers.customerSkAdNetworkConversionValueSchemas.mutate

创建或更新 CustomerSkAdNetworkConversionValueSchema。

抛出的错误列表:AuthenticationError AuthorizationError FieldError InternalError MutateError

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

共享集被修改的客户的 ID。

请求正文

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

JSON 表示法
{
  "operation": {
    object (CustomerSkAdNetworkConversionValueSchemaOperation)
  },
  "validateOnly": boolean,
  "enableWarnings": boolean
}
字段
operation

object (CustomerSkAdNetworkConversionValueSchemaOperation)

要执行的操作。

validateOnly

boolean

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

enableWarnings

boolean

可选。如果为 true,则允许返回警告。警告会返回错误消息和错误代码,而不会阻止 mutate 操作的执行。

响应正文

customerSkAdNetworkConversionValueSchemas.mutate 的响应消息。

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

JSON 表示法
{
  "result": {
    object (MutateCustomerSkAdNetworkConversionValueSchemaResult)
  },
  "warning": {
    object (Status)
  }
}
字段
result

object (MutateCustomerSkAdNetworkConversionValueSchemaResult)

转变的所有结果。

warning

object (Status)

提供架构验证失败详细信息的非阻塞错误。仅当 enableWarnings = true 时返回。

授权范围

需要以下 OAuth 作用域:

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

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

CustomerSkAdNetworkConversionValueSchemaOperation

CustomerSkAdNetworkConversionValueSchema 的单次更新操作。

JSON 表示法
{
  "update": {
    object (CustomerSkAdNetworkConversionValueSchema)
  }
}
字段
update

object (CustomerSkAdNetworkConversionValueSchema)

更新操作:架构应具有有效的资源名称。

CustomerSkAdNetworkConversionValueSchema

CustomerSkAdNetworkConversionValueSchema。

JSON 表示法
{
  "resourceName": string,
  "schema": {
    object (SkAdNetworkConversionValueSchema)
  }
}
字段
resourceName

string

仅限输出。架构的资源名称。CustomerSkAdNetworkConversionValueSchema 资源名称的格式如下:customers/{customerId}/customerSkAdNetworkConversionValueSchemas/{accountLinkId}

schema

object (SkAdNetworkConversionValueSchema)

仅限输出。指定资源的架构。

SkAdNetworkConversionValueSchema

特定于 CustomerLink 的 SkAdNetworkConversionValueSchema。

JSON 表示法
{
  "appId": string,
  "measurementWindowHours": integer,
  "fineGrainedConversionValueMappings": [
    {
      object (FineGrainedConversionValueMappings)
    }
  ],
  "postbackMappings": [
    {
      object (PostbackMapping)
    }
  ]
}
字段
appId

string

必需。仅限输出。Apple App Store 应用 ID。

measurementWindowHours

integer

仅限输出。安装后的一段时长(以小时为单位),在此时间段过后,应用归因合作伙伴或广告客户将停止调用 updateConversionValue

fineGrainedConversionValueMappings[]

object (FineGrainedConversionValueMappings)

仅限输出。精细的转化价值对应关系。对于支持多个转化时间范围的 SkAdNetwork 4.0 或更高版本,精细的转化价值映射仅适用于第一个回传。

postbackMappings[]

object (PostbackMapping)

仅限输出。在多个转化时间范围内回传的转化价值映射。仅适用于 SkAdNetwork 4.0 或更高版本。

FineGrainedConversionValueMappings

精细转化价值的映射。

JSON 表示法
{
  "fineGrainedConversionValue": integer,
  "conversionValueMapping": {
    object (ConversionValueMapping)
  }
}
字段
fineGrainedConversionValue

integer

仅限输出。精细的转化价值。有效值的范围为 [0,63](含)。

conversionValueMapping

object (ConversionValueMapping)

仅限输出。精细转化价值映射的转化事件。

ConversionValueMapping

表示从一项转化价值到一个或多个转化事件的映射。

JSON 表示法
{
  "minTimePostInstallHours": string,
  "maxTimePostInstallHours": string,
  "mappedEvents": [
    {
      object (Event)
    }
  ]
}
字段
minTimePostInstallHours

string (int64 format)

仅限输出。在衡量时间范围内用户上次处于活跃状态的时间范围的最小值。

maxTimePostInstallHours

string (int64 format)

仅限输出。在衡量时间范围内用户上次处于活跃状态的时间范围上限。

mappedEvents[]

object (Event)

仅限输出。转化价值可能会映射到具有不同属性的多个事件。

事件

定义转化价值所映射到的 Google 转化事件。

JSON 表示法
{
  "mappedEventName": string,
  "currencyCode": string,

  // Union field revenue_rate can be only one of the following:
  "eventRevenueRange": {
    object (RevenueRange)
  },
  "eventRevenueValue": number
  // End of list of possible types for union field revenue_rate.

  // Union field event_rate can be only one of the following:
  "eventOccurrenceRange": {
    object (EventOccurrenceRange)
  },
  "eventCounter": string
  // End of list of possible types for union field event_rate.
}
字段
mappedEventName

string

仅限输出。以此转化价值表示的 Google 事件名称。

currencyCode

string

仅限输出。event_revenue 的报告所用币种。由三个字母组成的 ISO 4217 货币代码,例如“USD”

联合字段 revenue_rate。事件收入的范围或具体值。revenue_rate 只能是下列其中一项:
eventRevenueRange

object (RevenueRange)

仅限输出。事件收入范围。

eventRevenueValue

number

仅限输出。特定事件收入值。

联合字段 event_rate。事件计数器的范围或具体值。event_rate 只能是下列其中一项:
eventOccurrenceRange

object (EventOccurrenceRange)

仅限输出。事件计数器范围。

eventCounter

string (int64 format)

仅限输出。适用于特定的事件计数器值。

RevenueRange

定义收入值的范围。

JSON 表示法
{
  "minEventRevenue": number,
  "maxEventRevenue": number
}
字段
minEventRevenue

number

仅限输出。对于收入范围,系统会更新此转化价值的最小值(以currencyCode为单位)。如果值为 0,将被视为未设置。

maxEventRevenue

number

仅限输出。对于收入范围,系统将更新此转化价值的最大值(以currencyCode为单位)。如果值为 0,将被视为未设置。

EventOccurrenceRange

定义事件计数器值的范围。

JSON 表示法
{
  "minEventCount": string,
  "maxEventCount": string
}
字段
minEventCount

string (int64 format)

仅限输出。对于事件计数器范围,指定范围的最小值。如果值为 0,将被视为未设置。

maxEventCount

string (int64 format)

仅限输出。对于事件计数器范围,定义范围的最大值。如果值为 0,将被视为未设置。

PostbackMapping

多个转化时间范围中每个回传的映射。

JSON 表示法
{
  "postbackSequenceIndex": integer,
  "coarseGrainedConversionValueMappings": {
    object (CoarseGrainedConversionValueMappings)
  },

  // Union field lock_window_trigger can be only one of the following:
  "lockWindowCoarseConversionValue": enum (SkAdNetworkCoarseConversionValue),
  "lockWindowFineConversionValue": integer,
  "lockWindowEvent": string
  // End of list of possible types for union field lock_window_trigger.
}
字段
postbackSequenceIndex

integer

仅限输出。用于指示回传顺序的索引(从 0 开始)。有效值的范围为 [0,2](含 [0,2])。

coarseGrainedConversionValueMappings

object (CoarseGrainedConversionValueMappings)

仅限输出。所有粗粒度转化价值的转化价值对应关系。

联合字段 lock_window_trigger。用于锁定转化时间范围的事件或转化价值。lock_window_trigger 只能是下列其中一项:
lockWindowCoarseConversionValue

enum (SkAdNetworkCoarseConversionValue)

仅限输出。触发转化时间范围锁定的粗略转化价值。

lockWindowFineConversionValue

integer

仅限输出。可触发转化时间范围锁定的精细转化价值。

lockWindowEvent

string

仅限输出。触发转化时间范围锁定的事件名称。

CoarseGrainedConversionValueMappings

粗粒度转化价值的映射。

JSON 表示法
{
  "lowConversionValueMapping": {
    object (ConversionValueMapping)
  },
  "mediumConversionValueMapping": {
    object (ConversionValueMapping)
  },
  "highConversionValueMapping": {
    object (ConversionValueMapping)
  }
}
字段
lowConversionValueMapping

object (ConversionValueMapping)

仅限输出。“低”粗略转化价值的映射。

mediumConversionValueMapping

object (ConversionValueMapping)

仅限输出。“中”粗略转化价值的映射。

highConversionValueMapping

object (ConversionValueMapping)

仅限输出。粗略转化价值的映射。

MutateCustomerSkAdNetworkConversionValueSchemaResult

CustomerSkAdNetworkConversionValueSchema 转变的结果。

JSON 表示法
{
  "resourceName": string,
  "appId": string
}
字段
resourceName

string

被修改的客户资源名称。

appId

string

已修改 SkanConversionValue 的应用 ID。