Method: combinedAudiences.list

Lista os públicos-alvo combinados.

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1beta2/combinedAudiences

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 100. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken

string

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

string

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

  • combinedAudienceId (padrão)
  • displayName

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter

string

Permite filtrar por campos de público-alvo combinado.

Sintaxe compatível:

  • No momento, as expressões de filtro para públicos-alvo combinados só podem conter no máximo uma restrição.
  • Uma restrição tem o formato {field} {operator} {value}.
  • O operador precisa ser CONTAINS (:).
  • Campos compatíveis:
    • displayName

Exemplos:

  • Todos os públicos-alvo combinados que têm "Google" no nome de exibição: displayName : "Google".

Esse campo não pode ter mais de 500 caracteres.
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á somente as entidades de público-alvo combinado 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 combinados buscados.
advertiserId

string (int64 format)

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

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 
{
  "combinedAudiences": [
    {
      object (CombinedAudience)
    }
  ],
  "nextPageToken": string
}
Campos
combinedAudiences[]

object (CombinedAudience)

Lista de públicos-alvo combinados.

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 combinedAudiences.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.