Method: advertisers.list

Lista os anunciantes que estão acessíveis ao usuário atual.

A ordem é definida pelo parâmetro orderBy.

Um único partnerId é obrigatório. A listagem entre parceiros não é aceita.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/advertisers

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

Parâmetros de consulta

Parâmetros
partnerId

string (int64 format)

Obrigatório. O ID do parceiro ao qual os anunciantes buscados devem pertencer. O sistema só permite listar os anunciantes de um parceiro por vez.
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.
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 advertisers.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:

  • displayName (padrão)
  • entityStatus
  • updateTime

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. Por exemplo, displayName desc.
filter

string

Permite filtrar por campos do anunciante.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por operadores lógicos AND ou OR.
  • Uma restrição tem o formato {field} {operator} {value}.
  • O campo updateTime precisa usar os operadores GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=).
  • Todos os outros campos precisam usar o operador EQUALS (=).

Campos compatíveis:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (entrada no formato ISO 8601 ou YYYY-MM-DDTHH:MM:SSZ)

Exemplos:

  • Todos os anunciantes ativos de um parceiro: entityStatus="ENTITY_STATUS_ACTIVE"
  • Todos os anunciantes com um horário de atualização menor ou igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todos os anunciantes com um horário de atualização maior ou igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Consulte nosso guia de solicitações de filtro de LIST para mais informações.

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

object (Advertiser)

A lista de anunciantes.

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