Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna propriedades filhas na conta principal especificada.
As propriedades serão excluídas se o autor da chamada não tiver acesso. As propriedades excluídas de maneira reversível (ou seja, "lixeira") são excluídas por padrão. Retorna uma lista vazia se nenhuma propriedade relevante for encontrada.
Solicitação HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/properties
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros |
filter |
string
Obrigatório. Uma expressão para filtrar os resultados da solicitação. Os campos qualificados para filtragem são: parent: (o nome do recurso da conta/propriedade principal), ancestor: (o nome do recurso da conta principal) ou firebase_project: (o ID ou número do projeto do Firebase vinculado). Alguns exemplos de filtros:
| 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
O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja outras páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.
|
pageToken |
string
Um token de página recebido de uma chamada properties.list anterior. Forneça isso para recuperar a página subsequente. Na paginação, todos os outros parâmetros enviados para properties.list precisam corresponder à chamada que proporcionou o token da página.
|
showDeleted |
boolean
Se as propriedades excluídas temporariamente (ou seja, "lixeira") vão ser incluídas nos resultados. As propriedades podem ser inspecionadas para determinar se foram excluídas ou não.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para o RPC properties.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
{
"properties": [
{
object (Property )
}
],
"nextPageToken": string
} |
Campos |
properties[] |
object (Property )
Resultados que correspondem aos critérios de filtro e são acessíveis ao autor da chamada.
|
nextPageToken |
string
Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eLists all Google Analytics 4 properties under a specified parent account, excluding soft-deleted properties by default.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parent account, ancestor account, or linked Firebase project using the \u003ccode\u003efilter\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scopes.\u003c/p\u003e\n"],["\u003cp\u003eReturns an empty list if no matching properties are found or if the user lacks access.\u003c/p\u003e\n"]]],["This describes how to list child properties under a parent account using a `GET` request to `https://analyticsadmin.googleapis.com/v1alpha/properties`. The request requires a filter parameter to specify the parent. Additional optional query parameters include `pageSize`, `pageToken`, and `showDeleted`. The request body must be empty. A successful response includes a list of `properties` and a `nextPageToken` for pagination. Authorization requires `analytics.readonly` or `analytics.edit` scopes.\n"],null,["# Method: properties.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPropertiesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns child Properties under the specified parent Account.\n\nProperties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/properties`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: | 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. | |\n| `pageSize` | `integer` The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |\n| `pageToken` | `string` A page token, received from a previous `properties.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `properties.list` must match the call that provided the page token. |\n| `showDeleted` | `boolean` Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for properties.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"properties\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `properties[]` | `object (`[Property](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property)`)` Results that matched the filter criteria and were accessible to the caller. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]