Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.keyEvents.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de eventos principais na propriedade pai especificada. Retorna uma lista vazia se nenhum evento principal for encontrado.
Solicitação HTTP
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
parent |
string
Obrigatório. O nome do recurso da propriedade pai. Exemplo: "properties/123"
|
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 forçados ao máximo)
|
pageToken |
string
Um token de página recebido de uma chamada keyEvents.list anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para keyEvents.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 keyEvents.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"keyEvents": [
{
object (KeyEvent)
}
],
"nextPageToken": string
} |
| Campos |
keyEvents[] |
object (KeyEvent)
Os eventos principais solicitados
|
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\u003eRetrieves a list of Key Events, which are significant changes or actions within a Google Analytics property.\u003c/p\u003e\n"],["\u003cp\u003eAllows for filtering by parent property and pagination to manage large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access to data.\u003c/p\u003e\n"],["\u003cp\u003eProvides a structured JSON response containing Key Events and pagination details.\u003c/p\u003e\n"],["\u003cp\u003eIncludes links to relevant documentation and code samples for implementation.\u003c/p\u003e\n"]]],["This document details how to list Key Events via an HTTP GET request to `https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents`. It requires a `parent` path parameter specifying the property, and optional `pageSize` and `pageToken` query parameters for pagination. The request body must be empty. A successful response returns a JSON structure containing an array of `keyEvents` and a `nextPageToken` for further pagination. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.keyEvents.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.ListKeyEventsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The resource name of the parent property. Example: 'properties/123' |\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 `keyEvents.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `keyEvents.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 keyEvents.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"keyEvents\": [ { object (/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents#KeyEvent) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `keyEvents[]` | `object (`[KeyEvent](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents#KeyEvent)`)` The requested Key Events |\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`"]]
