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 数据和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 未能创建受众群体导出。重新请求此受众群体导出操作可能会成功。

方法

create

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

get

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

list

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

query

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