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

必需。受众群体资源名称。此资源名称用于标识要列出的受众群体，并且在 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 状态的时间。

采用 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"。
rowCount

integer

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

string

仅限输出。如果受众群体名单在创建期间失败，系统会填充错误消息。此类失败的常见原因是配额耗尽。
percentageCompleted

number

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

string

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

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

object (WebhookNotification)

可选。配置从 Google Analytics 数据 API 发送到您的 Webhook 服务器的 Webhook 通知。Webhook 的使用是可选的。如果不使用 Webhook，您需要轮询此 API，以确定受众群体名单何时可以开始使用。Webhook 允许向您的服务器发送通知，从而避免轮询。

系统将向 Webhook 发送一个或两个 POST 请求。第一个 POST 请求将立即发送，以显示处于 CREATING 状态的新创建的受众群体名单。第二个 POST 请求将在受众群体名单完成创建后发送（处于 ACTIVE 或 FAILED 状态）。

如果快速连续请求相同的受众群体名单，则可以从缓存中提供第二个及后续的受众群体名单。在这种情况下，受众群体名单创建方法可以返回受众群体名单已处于 ACTIVE 状态。在这种情况下，系统只会向 Webhook 发送一个 POST 请求。

状态

AudienceList 目前处于此状态。

枚举
STATE_UNSPECIFIED 系统永远不会使用未指定状态。
CREATING AudienceList 目前正在创建，将来可用。创建会在调用 audienceLists.create 后立即进行。
ACTIVE AudienceList 已完全创建，可以进行查询。AudienceList 会在收到请求后异步更新为活跃状态；此更新会在初始创建调用后的一段时间（例如 15 分钟）后发生。
FAILED AudienceList 创建失败。重新请求此受众群体名单可能会成功。

方法

create

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

get

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

list

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

query

 检索用户受众群体名单。