Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.audienceLists.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista todas as listas de público-alvo de uma propriedade. Esse método pode ser usado para encontrar e reutilizar listas de público-alvo em vez de criar novas listas desnecessárias. O mesmo público-alvo pode ter várias listas que representam os usuários que fizeram parte de um público-alvo em dias diferentes.
Consulte Como criar uma lista de público-alvo para uma introdução às listas de público-alvo com exemplos.
Esse método está disponível na estabilidade Beta em audienceExports.list. Para enviar seu feedback sobre essa API, preencha o formulário de Feedback da API Audience Export do Google Analytics.
Solicitação HTTP
GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
parent |
string
Obrigatório. Todas as listas de público-alvo dessa propriedade serão listadas na resposta. Formato: properties/{property}
|
Parâmetros de consulta
| Parâmetros |
pageSize |
integer
Opcional. O número máximo de listas de público-alvo a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 200 listas de público-alvo serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para o máximo.
|
pageToken |
string
Opcional. Um token de página recebido de uma chamada audienceLists.list anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para audienceLists.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
Uma lista de todas as listas de público-alvo de uma propriedade.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"audienceLists": [
{
object (AudienceList)
}
],
"nextPageToken": string
} |
| Campos |
audienceLists[] |
object (AudienceList)
Cada lista de público-alvo de uma propriedade.
|
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
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 audience lists for a given Google Analytics property, allowing for reuse of existing lists.\u003c/p\u003e\n"],["\u003cp\u003eProvides pagination to handle large numbers of audience lists, with customizable page size.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, either read-only or full Analytics access.\u003c/p\u003e\n"],["\u003cp\u003eUses a standard HTTP GET request with path and query parameters to specify the property and retrieval options.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing an array of audience lists and a token for retrieving subsequent pages.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of audience lists for a specific property using the Google Analytics Data API. It utilizes a `GET` HTTP request to the `audienceLists` endpoint, specifying the property in the `parent` path parameter. Optional query parameters include `pageSize` to limit results and `pageToken` for pagination. The request body must be empty. Successful responses include an array of `audienceLists` and a `nextPageToken` for subsequent pages. This operation requires `analytics.readonly` or `analytics` authorization scopes.\n"],null,["# Method: properties.audienceLists.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.ListAudienceListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days.\n\nSee [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples.\n\nThis method is available at beta stability at [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list). To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.\n\n### HTTP request\n\n`GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. All audience lists for this property will be listed in the response. Format: `properties/{property}` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `integer` Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum). |\n| `page``Token` | `string` Optional. A page token, received from a previous `audienceLists.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `audienceLists.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\nA list of all audience lists for a property.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"audienceLists\": [ { object (/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `audience``Lists[]` | `object (`[AudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList)`)` Each audience list for a property. |\n| `next``Page``Token` | `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`"]]
