Method: googleAudiences.list

Lista os públicos-alvo do Google.

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1/googleAudiences

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior para o método googleAudiences.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classificará a lista. Os valores aceitáveis são:

  • googleAudienceId (padrão)
  • displayName

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente de um campo, use o sufixo "desc" deve ser adicionado ao nome do campo. Exemplo: displayName desc.
filter

string

Permite filtrar por campos de público-alvo do Google.

Sintaxe compatível:

  • As expressões de filtro para públicos-alvo do Google podem conter no máximo uma restrição.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Todos os campos precisam usar o operador HAS (:).

Campos compatíveis:

  • displayName

Exemplos:

  • Todos os públicos-alvo do Google em que o nome de exibição contém "Google": displayName:"Google".

Esse campo não pode ter mais de 500 caracteres.

Consulte nosso guia de solicitações de filtro de LIST para mais informações.
Parâmetro de união accessor. Obrigatório. Identifica em qual entidade do DV360 a solicitação está sendo feita. A solicitação LIST retornará apenas as entidades de público-alvo do Google que podem ser acessadas pela entidade do DV360 identificada no accessor. accessor pode ser apenas de um dos tipos a seguir:
partnerId

string (int64 format)

O ID do parceiro que tem acesso aos públicos-alvo buscados do Google.
advertiserId

string (int64 format)

O ID do anunciante que tem acesso aos públicos-alvo buscados do Google.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "googleAudiences": [
    {
      object (GoogleAudience)
    }
  ],
  "nextPageToken": string
}
Campos
googleAudiences[]

object (GoogleAudience)

A lista de públicos-alvo do Google.

Esta lista estará ausente se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método googleAudiences.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video

Para mais informações, consulte a Visão geral do OAuth 2.0.