A ordem é definida pelo parâmetro orderBy. Se uma filter de entityStatus não for especificada, as campanhas com ENTITY_STATUS_ARCHIVED não serão incluídas nos resultados.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/campaigns
O ID do anunciante para o qual listar as 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, 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 campaigns.list. Caso não seja especificado, a primeira página de resultados será retornada.
orderBy
string
Campo que classificará a lista. Os valores aceitos 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 da 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 tempo 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"
O comprimento desse campo não pode ultrapassar 500 caracteres.
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método campaigns.list para recuperar a próxima página de resultados.