Method: advertisers.campaigns.list

Lista as campanhas de um anunciante.

A ordem é definida pelo parâmetro orderBy. Se um filter por entityStatus não for especificado, as campanhas com ENTITY_STATUS_ARCHIVED não serão incluídas nos resultados.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

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

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

O ID do anunciante para o qual listar campanhas.

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, 100 será usado como padrão.
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 campaigns.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classifica 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 em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter

string

Permite filtrar por campos de campanha.

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 sequência de restrições usa AND implicitamente.
  • 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:

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

Exemplos:

  • Todas as campanhas ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED de um anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Todas as campanhas 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"
  • Todas as campanhas 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 filtragem de solicitações 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Campos
campaigns[]

object (Campaign)

A lista de campanhas.

Essa lista não será exibida se estiver vazia.
nextPageToken

string

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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