REST Resource: properties.audienceExports

资源：AudienceExport

受众群体导出是指在创建名单时受众群体中的用户列表。一个受众群体可能会有多个在不同日期创建的受众群体导出。

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

string

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

格式：properties/{property}/audienceExports/{audienceExport}
audience

string

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

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

string

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

object (AudienceDimension)

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

integer

仅限输出。在创建 AudienceExport 期间收取的配额令牌总数。由于此令牌计数基于 CREATING 状态的活动，因此一旦 AudienceExport 进入 ACTIVE 或 FAILED 状态，收取的令牌数将是固定的。
state

enum (State)

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

string (Timestamp format)

仅限输出。调用 audienceExports.create 且 AudienceExport 开始进入 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

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

string

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

number

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

AudienceDimension

受众群体维度是用户属性。系统会请求特定的用户属性，然后在 QueryAudienceExportResponse 中返回这些属性。

JSON 表示法 
{
  "dimensionName": string
}
字段
dimensionName

string

可选。维度的 API 名称。如需查看维度名称列表，请参阅 API 维度。

状态

AudienceExport 目前处于此状态。

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

方法

create

 创建受众群体导出，以便日后检索。

get

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

list

 列出某个媒体资源的所有受众群体导出。

query

 检索用户的受众群体导出。