Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.customMetrics.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista CustomMetrics em uma propriedade.
Solicitação HTTP
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customMetrics
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 customMetrics.list anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para customMetrics.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 RPC customMetrics.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"customMetrics": [
{
object (CustomMetric)
}
],
"nextPageToken": string
} |
| Campos |
customMetrics[] |
object (CustomMetric)
Lista de CustomMetrics.
|
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 CustomMetrics on a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to retrieve large result sets via \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of CustomMetrics and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty and the endpoint is accessed using an HTTP GET request.\u003c/p\u003e\n"]]],["This document outlines the process for listing CustomMetrics on a property via an HTTP GET request to `https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customMetrics`. The `parent` path parameter (e.g., `properties/1234`) is required. Optional query parameters `pageSize` and `pageToken` allow for pagination. The request body must be empty. The response includes a list of `customMetrics` and a `nextPageToken` for retrieving subsequent pages, all in JSON format. Authentication requires either `analytics.readonly` or `analytics.edit` OAuth scopes.\n"],null,["# Method: properties.customMetrics.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.ListCustomMetricsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CustomMetrics on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customMetrics`\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 `customMetrics.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customMetrics.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 customMetrics.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customMetrics\": [ { object (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#CustomMetric) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| `customMetrics[]` | `object (`[CustomMetric](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#CustomMetric)`)` List of CustomMetrics. |\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`"]]
