Method: properties.audienceExports.query

检索用户导出的受众群体。创建受众群体后，您无法立即导出这些用户。首先，需要向 audienceExports.create 发出请求才能创建用户的受众群体导出；其次，在导出受众群体时，需要使用此方法检索用户。

如需通过示例了解受众群体导出，请参阅创建受众群体导出。

借助 Google Analytics（分析）4 中的受众群体，您可以根据自身业务需求对用户进行细分。如需了解详情，请参阅 https://support.google.com/analytics/answer/9267572。

Audience Export API 有一些方法处于 Alpha 版阶段，还有一些方法处于 Beta 版稳定性阶段。这样做的目的是，获得一些反馈并采用相应方法后，将方法进一步提升到 Beta 版稳定性。如需就此 API 提供反馈，请填写 Google Analytics Audience Export API 反馈表单。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要从中检索用户的受众群体导出文件的名称。格式：properties/{property}/audienceExports/{audienceExport}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "offset": string,
  "limit": string
}
字段
offset

string (int64 format)

可选。起始行的行数。第一行计为第 0 行。

分页时，第一个请求不指定偏移量；或者等效地，将 offset 设置为 0；第一个请求会返回前 limit 行。第二个请求将偏移设置为第一个请求的 limit；第二个请求会返回第二个行的 limit。

如需详细了解此分页参数，请参阅分页。
limit

string (int64 format)

可选。要返回的行数。如果未指定，将返回 10,000 行。无论您请求返回多少行，每个请求最多返回 250,000 行。“limit”必须为正数。

如果维度值没有 limit 多，API 返回的行数也可能小于请求的 limit。

如需详细了解此分页参数，请参阅分页。

响应正文

受众群体导出文件中的用户列表。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceExport": {
    object (AudienceExport)
  },
  "rowCount": integer
}
字段
audienceRows[]

object (AudienceRow)

与受众群体导出内容中每个用户对应的行。此响应中的行数将小于或等于请求的页面大小。
audienceExport

object (AudienceExport)

正在查询的 AudienceExport 的相关配置数据。系统会返回以帮助解读此响应中的受众群体行。例如，此 AudienceExport 中的维度对应于 AudienceRows 中的列。
rowCount

integer

AudienceExport 结果中的总行数。rowCount 与响应中返回的行数、limit 请求参数和 offset 请求参数无关。例如，如果查询返回 175 行，并且在 API 请求中包含 50 的 limit，则响应将包含 175 行的 rowCount，但只有 50 行。

如需详细了解此分页参数，请参阅分页。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

相应受众群体用户行的维度值属性。

JSON 表示法 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
字段
dimensionValues[]

object (AudienceDimensionValue)

受众群体用户的每个维度值属性。系统会为所请求的每个维度列添加一个维度值。

AudienceDimensionValue

维度的值。

JSON 表示法 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
字段
联合字段 one_value。一种维度值。one_value 只能是下列其中一项：
value

string

以字符串表示的值（如果维度类型是字符串）。