资源:受众群体名单
受众群体名单是创建之时受众群体中所含用户的名单。一个受众群体可以针对不同日期创建多个受众群体名单。
JSON 表示法 |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
字段 | |
---|---|
name |
仅限输出。标识符。创建期间分配的受众群体名单资源名称。此资源名称可标识此 格式: |
audience |
必需。受众群体资源名称。此资源名称用于标识列出的受众群体,并在 Google Analytics(分析)Data & Admin API 之间共享。 格式: |
audienceDisplayName |
仅限输出。此受众群体的描述性显示名称。例如,“购买者”。 |
dimensions[] |
必需。请求并显示在查询响应中的维度。 |
creationQuotaTokensCharged |
仅限输出。创建受众群体名单期间收取的配额令牌总数。由于此令牌数基于 |
state |
仅限输出。此受众群体名单的当前状态。 |
beginCreatingTime |
仅限输出。调用 audienceLists.create 时, AudienceList 开始处于 采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例: |
rowCount |
仅限输出。AudienceList 结果中的总行数。 |
errorMessage |
仅限输出。受众群体名单创建失败时,系统会填充错误消息。导致此类失败的一种常见原因是配额耗尽。 |
percentageCompleted |
仅限输出。此受众群体导出完成的百分比介于 0 到 100 之间。 |
recurringAudienceList |
仅限输出。创建此受众群体名单的周期性受众群体名单。定期重复的受众群体名单会每天创建一次受众群体名单。 如果受众群体名单是直接创建的,则这些名单没有关联的周期性受众群体名单,并且此字段将为空。 |
webhookNotification |
可选。配置要从 Google Analytics(分析)Data API 发送到您的网络钩子服务器的网络钩子通知。使用网络钩子是可选操作。如果未使用,您需要轮询此 API,以确定受众群体名单何时可供使用。借助网络钩子,您可以向服务器发送通知,避免进行轮询。 系统会向网络钩子发送一个或两个 POST 请求。系统将立即发送第一个 POST 请求,并将新创建的受众群体名单显示为“正在创建”状态。第二个 POST 请求将在受众群体名单创建完毕后(状态为 ACTIVE 或 FAILED)发送。 如果快速连续请求相同的受众群体名单,则可以从缓存中传送第二个及后续受众群体名单。在这种情况下,受众群体名单创建方法可以返回已处于 ACTIVE 状态的受众群体名单。在这种情况下,只有一个 POST 请求会发送到 webhook。 |
状态
受众群体名单当前处于此状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
绝不会使用未指定的状态。 |
CREATING |
受众群体名单目前正在创建中,日后便可使用。调用 audienceLists.create 后,系统会立即执行创建操作。 |
ACTIVE |
受众群体名单已完全创建完毕,随时可供查询。AudienceList 会根据请求异步更新为有效;此过程在初始 create 调用后的一段时间(例如 15 分钟)内发生。 |
FAILED |
未能创建受众群体名单。重新请求此受众群体名单可能会成功。 |
方法 |
|
---|---|
|
创建受众群体名单以供日后检索。 |
|
将用户的受众群体名单导出至 Google 表格。 |
|
获取特定受众群体名单的相关配置元数据。 |
|
列出媒体资源的所有受众群体名单。 |
|
检索用户的受众群体名单。 |