REST Resource: properties.audienceLists

{
  "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)
  }
}

string

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

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

string

必需。受众群体资源名称。此资源名称用于标识列出的受众群体，并在 Google Analytics（分析）Data & Admin API 之间共享。

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

string

仅限输出。此受众群体的描述性显示名称。例如，“购买者”。

object (AudienceDimension)

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

integer

仅限输出。创建受众群体名单期间收取的配额令牌总数。由于此令牌数基于 CREATING 状态中的活动，因此一旦受众群体名单进入 ACTIVE 或 FAILED 状态，计费的此令牌便会修复。

enum (State)

仅限输出。此受众群体名单的当前状态。

string (Timestamp format)

仅限输出。调用 audienceLists.create 时， AudienceList 开始处于 CREATING 状态的时间。

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

integer

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

string

仅限输出。受众群体名单创建失败时，系统会填充错误消息。导致此类失败的一种常见原因是配额耗尽。

number

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

string

仅限输出。创建此受众群体名单的周期性受众群体名单。定期重复的受众群体名单会每天创建一次受众群体名单。

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

object (WebhookNotification)

可选。配置要从 Google Analytics（分析）Data API 发送到您的网络钩子服务器的网络钩子通知。使用网络钩子是可选操作。如果未使用，您需要轮询此 API，以确定受众群体名单何时可供使用。借助网络钩子，您可以向服务器发送通知，避免进行轮询。

系统会向网络钩子发送一个或两个 POST 请求。系统将立即发送第一个 POST 请求，并将新创建的受众群体名单显示为“正在创建”状态。第二个 POST 请求将在受众群体名单创建完毕后（状态为 ACTIVE 或 FAILED）发送。

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