Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.customDimensions.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista CustomDimensions em uma propriedade.
Solicitação HTTP
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customDimensions
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
parent |
string
Obrigatório. Exemplo de formato: propriedades/1234
|
Parâmetros de consulta
| Parâmetros |
pageSize |
integer
O número máximo de recursos a serem retornados. Se não for especificado, serão retornados no máximo 50 recursos. O valor máximo é 200 (valores mais altos serão convertidos para o máximo).
|
pageToken |
string
Um token de página recebido de uma chamada customDimensions.list anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para customDimensions.list precisam corresponder à chamada que forneceu o token da página.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para a RPC customDimensions.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"customDimensions": [
{
object (CustomDimension)
}
],
"nextPageToken": string
} |
| Campos |
customDimensions[] |
object (CustomDimension)
Lista de CustomDimensions.
|
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.readonlyhttps://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 CustomDimensions configured for a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of CustomDimensions.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e authorization scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the HTTP request structure, including path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of CustomDimensions and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"]]],["This document details how to list CustomDimensions within a property using the Google Analytics Admin API. The core action is performing a `GET` request to the specified URL, which includes a required `parent` path parameter (e.g., properties/1234). Optional query parameters `pageSize` and `pageToken` enable pagination. The request body is empty. A successful response returns a JSON structure containing a list of `customDimensions` and a `nextPageToken` for further pages. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.customDimensions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomDimensionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CustomDimensions on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customDimensions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/1234 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of resources to return. 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 `customDimensions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customDimensions.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for customDimensions.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customDimensions\": [ { object (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customDimensions[]` | `object (`[CustomDimension](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension)`)` List of CustomDimensions. |\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`"]]
