Method: properties.audienceLists.list

Lista todas as listas de público-alvo de uma propriedade. Use esse método para encontrar e reutilizar listas de público-alvo existentes em vez de criar novas listas de público-alvo desnecessárias. O mesmo público-alvo pode ter várias listas que representam a lista de usuários que estavam em um público-alvo em dias diferentes.

Consulte Como criar uma lista de público-alvo para uma introdução a listas de público-alvo com exemplos.

Esse método está disponível na versão Beta em audienceExports.list. Para enviar feedback sobre essa API, preencha o formulário Feedback sobre a 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 exibidas 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, serão retornadas no máximo 200 listas de público-alvo. O valor máximo é 1.000 (valores mais altos 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.readonly
  • https://www.googleapis.com/auth/analytics