REST Resource: properties.dataStreams.sKAdNetworkConversionValueSchema

资源:SKAdNetworkConversionValueSchema

iOS 数据流的 SKAdNetwork 转化价值架构。

JSON 表示法
{
  "name": string,
  "postbackWindowOne": {
    object (PostbackWindow)
  },
  "postbackWindowTwo": {
    object (PostbackWindow)
  },
  "postbackWindowThree": {
    object (PostbackWindow)
  },
  "applyConversionValues": boolean
}
字段
name

string

仅限输出。架构的资源名称。此字段只能是 iOS 数据流的子项,并且 iOS 数据流下最多只能有一个此类子项。Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postbackWindowOne

object (PostbackWindow)

必需。第一个回传时间范围的转化价值设置。这些值与回传时间范围 2 和 3 的值不同,因为它们包含“精细”转化价值(一个数值)。

必须为此回传时间范围设置转化价值。其他窗口是可选的,如果未设置或已停用,则可能会继承此窗口的设置。

postbackWindowTwo

object (PostbackWindow)

第二个回传时间范围的转化价值设置。

只有在需要为此回传时间范围定义不同的转化价值时,才应配置此字段。

如果为此回传时间范围将 enable_postback_window_settings 设置为 false,则系统会使用 postbackWindowOne 中的值。

postbackWindowThree

object (PostbackWindow)

第三个回传时间范围的转化价值设置。

只有在用户选择为此回传时间范围定义不同的转化价值时,才应设置此字段。允许配置窗口 3,而无需设置窗口 2。如果设置了窗口 1 和 2 的设置,并且此回传时间范围的 enable_postback_window_settings 设置为 false,则架构将继承 postbackWindowTwo 中的设置。

applyConversionValues

boolean

如果启用,GA SDK 将使用此架构定义设置转化价值,并且架构将导出到与此媒体资源关联的所有 Google Ads 账号。如果停用,GA SDK 将不会自动设置转化价值,并且架构也不会导出到 Google Ads。

PostbackWindow

SKAdNetwork 转化回传时间范围的设置。

JSON 表示法
{
  "conversionValues": [
    {
      object (ConversionValues)
    }
  ],
  "postbackWindowSettingsEnabled": boolean
}
字段
conversionValues[]

object (ConversionValues)

系统会根据重复字段的排序来确定转化价值设置的优先级。编号越低的条目优先级越高。系统会选择第一个评估结果为 true 的转化价值设置。如果 enable_postback_window_settings 设置为 true,则必须至少包含一个条目。它最多可包含 128 个条目。

postbackWindowSettingsEnabled

boolean

如果 enable_postback_window_settings 为 true,则必须填充 conversionValues,该值将用于确定何时以及如何在客户端设备上设置转化价值,以及将架构导出到关联的 Google Ads 账号。如果为 false,系统不会使用这些设置,但会保留这些设置,以备日后使用。对于 postbackWindowOne,此值始终必须为 true。

ConversionValues

SKAdNetwork 转化价值架构的回传时间范围的转化价值设置。

JSON 表示法
{
  "displayName": string,
  "coarseValue": enum (CoarseValue),
  "eventMappings": [
    {
      object (EventMapping)
    }
  ],
  "lockEnabled": boolean,
  "fineValue": integer
}
字段
displayName

string

SKAdNetwork 转化价值的显示名称。允许的显示名称长度上限为 50 个 UTF-16 代码单元。

coarseValue

enum (CoarseValue)

必需。粗略转化价值。

此值不能保证唯一。

eventMappings[]

object (EventMapping)

此转化价值必须满足的事件条件。此列表中的条件之间是 AND 关系。如果启用了回传时间范围,则此字段必须包含至少 1 个条目,且最多包含 3 个条目。

lockEnabled

boolean

如果为 true,SDK 应针对当前回传时间范围锁定此转化价值。

fineValue

integer

精细转化价值。这仅适用于第一个回传时间范围。其有效值为 [0,63],包括这两个数值。必须为回传时间范围 1 设置此参数,但不得为回传时间范围 2 和 3 设置此参数。此值不能保证唯一。

如果第一个回传时间范围的配置被用于第二个或第三个回传时间范围,此字段将无效。

CoarseValue

当 ConversionValues.event_mappings 条件满足时,在 updatePostbackConversionValue SDK 调用中设置的粗略转化价值。如需了解详情,请参阅 SKAdNetwork.CoarseConversionValue

枚举
COARSE_VALUE_UNSPECIFIED 未指定粗略值。
COARSE_VALUE_LOW 粗略值为低。
COARSE_VALUE_MEDIUM 中等的粗略价值。
COARSE_VALUE_HIGH 粗略价值为高。

EventMapping

用于匹配事件的事件设置条件。

JSON 表示法
{
  "eventName": string,
  "minEventCount": string,
  "maxEventCount": string,
  "minEventValue": number,
  "maxEventValue": number
}
字段
eventName

string

必需。Google Analytics 事件的名称。必须始终设置此属性。允许的显示名称长度上限为 40 个 UTF-16 代码单元。

minEventCount

string (int64 format)

必须设置以下四个最小值/最大值中的至少一个。系统会对设置的值进行 AND 运算,以确定事件是否符合条件。事件发生的次数下限。如果未设置,系统将不会检查最低事件数。

maxEventCount

string (int64 format)

事件发生的次数上限。如果未设置,系统将不会检查事件数上限。

minEventValue

number

因事件而产生的最低收入。收入币种将在房源一级定义。如果未设置,系统不会检查最低事件价值。

maxEventValue

number

因事件而产生的最高收入。收入币种将在房源一级定义。如果未设置,系统将不会检查事件价值上限。

方法

create

创建 SKAdNetworkConversionValueSchema。

delete

删除目标 SKAdNetworkConversionValueSchema。

get

查找单个 SKAdNetworkConversionValueSchema。

list

列出数据流上的 SKAdNetworkConversionValueSchema。

patch

更新 SKAdNetworkConversionValueSchema。