REST Resource: properties.audienceLists

资源：AudienceList

受众群体名单是指在受众群体名单创建时，该受众群体中的用户名单。一个受众群体可以有针对不同日期创建的多个受众群体名单。

JSON 表示法 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
字段
name

string

仅限输出。标识符。在创建期间分配的受众群体名单资源名称。此资源名称用于标识此 AudienceList。

格式：properties/{property}/audienceLists/{audienceList}
audience

string

必需。受众群体资源名称。此资源名称用于标识要列出的受众群体，并在 Google Analytics 数据 API 和 Admin API 之间共享。

格式：properties/{property}/audiences/{audience}
audienceDisplayName

string

仅限输出。此受众群体的描述性显示名称。例如“买家”。
dimensions[]

object (AudienceDimension)

必需。请求的维度，并在查询响应中显示。
creationQuotaTokensCharged

integer

仅限输出。创建 AudienceList 时消耗的配额令牌总数。由于此令牌数基于 CREATING 状态下的活动，因此 AudienceList 进入 ACTIVE 或 FAILED 状态后，系统收取的此类令牌数将固定不变。
state

enum (State)

仅限输出。此 AudienceList 的当前状态。
beginCreatingTime

string (Timestamp format)

仅限输出。调用 audienceLists.create 并使 AudienceList 进入 CREATING 状态的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
rowCount

integer

仅限输出。AudienceList 结果中的总行数。
errorMessage

string

仅限输出。如果受众群体列表在创建过程中失败，系统会填充错误消息。导致此类失败的常见原因是配额耗尽。
percentageCompleted

number

仅限输出。此受众群体导出操作的完成百分比，介于 0 到 100 之间。
recurringAudienceList

string

仅限输出。用于创建此受众群体名单的周期性受众群体名单。周期性受众群体名单每天都会创建受众群体名单。

如果直接创建受众群体名单，则不会有关联的周期性受众群体名单，并且此字段将为空。
webhookNotification

object (WebhookNotification)

可选。配置要从 Google Analytics Data API 发送到 webhook 服务器的 webhook 通知。使用 webhook 是可选的。如果未使用，您需要轮询此 API 以确定受众群体名单何时可以使用。借助 Webhook，您可以向服务器发送通知，而无需轮询。

系统会向该 webhook 发送 1 到 2 个 POST 请求。系统会立即发送第一个 POST 请求，其中显示新创建的受众群体名单处于“正在创建”状态。在受众群体列表创建完成（处于“有效”或“失败”状态）后，系统会发送第二个 POST 请求。

如果连续请求相同的受众群体名单，系统可以从缓存中提供第二个和后续的受众群体名单。在这种情况下，受众群体名单创建方法可以返回已处于“有效”状态的受众群体名单。在这种情况下，系统只会向该网络钩子发送一个 POST 请求。

州

AudienceList 目前处于此状态。

枚举
STATE_UNSPECIFIED 系统绝不会使用“未指定”状态。
CREATING AudienceList 目前正在创建中，未来将推出。创建会在 audienceLists.create 调用后立即进行。
ACTIVE AudienceList 已完全创建，可以进行查询。系统会根据请求异步将 AudienceList 更新为有效状态；这会在初始创建调用之后的一段时间（例如 15 分钟）发生。
FAILED 未能创建 AudienceList。重新请求此受众群体名单可能会成功。

方法

create

 创建受众群体名单以供日后检索。

exportSheet

 将用户的受众群体名单导出到 Google 表格。

get

 获取有关特定受众群体名单的配置元数据。

list

 列出媒体资源的所有受众群体名单。

query

 检索用户的受众群体名单。