检索用户的受众群体名单。创建受众群体后,用户并不是立即就能列出。首先,需要向 audienceLists.create
发出请求以创建包含用户的受众群体名单;其次,此方法用于检索受众群体名单中的用户。
如需通过示例了解受众群体名单,请参阅创建受众群体名单。
借助 Google Analytics(分析)4 中的受众群体,您可以根据自身业务需求对用户进行细分。如需了解详情,请参阅 https://support.google.com/analytics/answer/9267572。
此方法在 Beta 版稳定性阶段可用,具体位置为 audienceExports.query。如需就此 API 提供反馈,请填写 Google Analytics Audience Export API 反馈表单。
HTTP 请求
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
必需。要从中检索用户的受众群体名单的名称。格式: |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "offset": string, "limit": string } |
字段 | |
---|---|
offset |
可选。起始行的行数。第一行计为第 0 行。 分页时,第一个请求不指定偏移量;或者等效地,将 offset 设置为 0;第一个请求会返回前 如需详细了解此分页参数,请参阅分页。 |
limit |
可选。要返回的行数。如果未指定,将返回 10,000 行。无论您请求返回多少行,每个请求最多返回 250,000 行。“ 如果维度值没有 如需详细了解此分页参数,请参阅分页。 |
响应正文
受众群体名单中的一系列用户。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "audienceRows": [ { object ( |
字段 | |
---|---|
audienceRows[] |
受众群体名单中每个用户的行。此响应中的行数将小于或等于请求的页面大小。 |
audienceList |
正在查询的受众群体名单的配置数据。系统会返回以帮助解读此响应中的受众群体行。例如,此 AudienceList 中的维度对应于 AudienceRows 中的列。 |
rowCount |
AudienceList 结果中的总行数。 如需详细了解此分页参数,请参阅分页。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
相应受众群体用户行的维度值属性。
JSON 表示法 |
---|
{
"dimensionValues": [
{
object ( |
字段 | |
---|---|
dimensionValues[] |
受众群体用户的每个维度值属性。系统会为所请求的每个维度列添加一个维度值。 |
AudienceDimensionValue
维度的值。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 one_value 。一种维度值。one_value 只能是下列其中一项: |
|
value |
以字符串表示的值(如果维度类型是字符串)。 |