Method: properties.audienceLists.exportSheet

将用户的受众群体名单导出至 Google 表格。创建受众群体后，用户并不是立即就能列出。首先，需要向 audienceLists.create 发出请求才能创建用户受众群体名单。其次，此方法用于将受众群体名单中的这些用户导出到 Google 表格。

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

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

此方法是在 Alpha 版稳定性阶段推出的，目的是在进入 Beta 版之前收集有关语法和功能的反馈。如需就此 API 提供反馈，请填写 Google Analytics Audience Export API 反馈表单。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要从中检索用户的受众群体名单的名称。格式：properties/{property}/audienceLists/{audienceList}

请求正文

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

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。

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

响应正文

已创建的 Google 表格，其中包含受众群体名单中的用户名单。

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

JSON 表示法 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
字段
spreadsheetUri

string

可在浏览器中访问以查看 Google 表格的 URI。
spreadsheetId

string

用于标识创建的 Google 表格资源的 ID。
rowCount

integer

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

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

object (AudienceList)

有关正在导出的受众群体名单的配置数据。返回以帮助解读此响应的 Google 表格中的受众群体名单。

例如，AudienceList 中的行数可能多于 Google 表格中显示的行数，在这种情况下，您可能需要使用其他的 offset 值发送额外的工作表导出请求，以便在其他 Google 表格中检索下一页行。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets