Method: properties.list

返回指定父帐号下的子媒体资源。

将仅返回“GA4”属性。如果调用方没有访问权限,则会排除相应属性。默认情况下,软删除(即“垃圾”)属性被排除。如果未找到相关属性,则返回空列表。

HTTP 请求

GET https://analyticsadmin.googleapis.com/v1beta/properties

网址采用 gRPC 转码语法。

查询参数

参数
filter

string

必需。用于过滤请求结果的表达式。可用于过滤的字段包括 parent:(父级帐号/媒体资源的资源名称)、ancestor:(父级帐号的资源名称)或 firebase_project:(关联的 Firebase 项目的 ID 或编号)。过滤器的一些示例:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

要返回的资源数上限。即使返回更多网页,服务返回的值也可能少于此值。如果未指定,则最多返回 50 个资源。最大值为 200;(大于此值将强制转换为最大值)

pageToken

string

从之前的 ListProperties 调用接收的页面令牌。提供此字段以检索后续页面。进行分页时,提供给 ListProperties 的所有其他参数必须与提供页面令牌的调用匹配。

showDeleted

boolean

是否在结果中包含软删除(即“垃圾”)属性。您可以检查属性以确定它们是否被删除。

请求正文

请求正文必须为空。

响应正文

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

ListProperties RPC 的响应消息。

JSON 表示法
{
  "properties": [
    {
      object (Property)
    }
  ],
  "nextPageToken": string
}
字段
properties[]

object (Property)

符合过滤条件并且可供调用方访问的结果。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

授权范围

需要以下 OAuth 范围之一:

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