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

必需。受众群体资源名称。此资源名称用于标识列出的受众群体，并在 Google Analytics（分析）Data & Admin 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 状态的时间。

采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 会从请求中异步更新为有效；此过程会在初始 create 调用后的一段时间（例如 15 分钟）内发生。
FAILED 未能创建 AudienceExport。重新请求此受众群体导出可能会成功。

方法

create

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

get

 获取与特定受众群体导出操作相关的配置元数据。

list

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

query

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