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 数据和Admin API。

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

string

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

object (AudienceDimension)

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

integer

仅限输出。创建 AudienceList 期间收取的配额令牌总数。由于此令牌数量基于处于 CREATING 状态的活动，因此当受众群体名单进入 ACTIVE 或 FAILED 状态后，计费的这些令牌数将保持不变。
state

enum (State)

仅限输出。此受众群体名单的当前状态。
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 发送到网络钩子服务器的网络钩子通知。您可以视需要使用网络钩子。如果未使用，您需要轮询此 API 来确定受众群体名单何时可以使用。通过网络钩子，你可以在自己的服务器和因此无需进行轮询

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

如果快速连续地请求相同的受众群体名单，则第二个和后续受众群体名单可通过缓存进行投放在这种情况下，受众群体名单创建方法可能会返回已处于“有效”状态的受众群体名单。在这种情况下，系统只会向 webhook 发送一个 POST 请求。

州

该受众群体名单目前处于此状态。

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

方法

create

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

exportSheet

 将受众群体名单导出至 Google 表格。

get

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

list

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

query

 检索用户受众群体名单。