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 数据 API 和 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 会在收到请求后异步更新为有效状态；这会在初始创建调用之后的一段时间（例如 15 分钟）发生。
FAILED 未能创建 AudienceExport。重新请求导出此受众群体可能会成功。

方法

create

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

get

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

list

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

query

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