REST Resource: properties.keyEvents

资源:KeyEvent

Google Analytics 媒体资源中的关键事件。

JSON 表示法
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
字段
name

string

仅限输出。此关键事件的资源名称。格式:properties/{property}/keyEvents/{keyEvent}

eventName

string

不可变。此关键事件的事件名称。示例:“click”“purchase”

createTime

string (Timestamp format)

仅限输出。在媒体资源中创建此关键事件的时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

deletable

boolean

仅限输出。如果设置为 true,则可以删除此事件。

custom

boolean

仅限输出。如果设置为 true,则此关键事件是指自定义事件。如果设置为 false,则此关键事件是指 GA 中的默认事件。默认事件通常在 GA 中具有特殊含义。默认事件通常由 GA 系统为您创建,但在某些情况下,媒体资源管理员也可以创建默认事件。自定义事件计入每个媒体资源可创建的自定义关键事件数量上限。

countingMethod

enum (CountingMethod)

必需。在会话中跨多个事件统计关键事件的方法。

defaultValue

object (DefaultValue)

可选。为关键事件定义默认值/币种。

CountingMethod

在会话中跨多个事件统计关键事件的方法。

枚举
COUNTING_METHOD_UNSPECIFIED 未指定统计方法。
ONCE_PER_EVENT 每个事件实例都被视为关键事件。
ONCE_PER_SESSION 每个用户在每个会话中,一个事件实例最多被视为一次关键事件。

DefaultValue

为关键事件定义默认值/币种。

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

number

必需。此值将用于填充此关键事件(由 eventName 指定)的所有发生情况的“value”参数(如果该参数未设置)。

currencyCode

string

必需。当此关键事件(由 eventName 指定)的发生情况未设置币种时,系统会将此币种应用为默认币种。必须采用 ISO 4217 币种代码格式。

如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_4217

方法

create

创建关键事件。

delete

删除关键事件。

get

检索单个关键事件。

list

返回指定父级媒体资源中的关键事件列表。

patch

更新关键事件。