A ordem é definida pelo parâmetro orderBy. Se um filter de entityStatus não for especificado, os pedidos de inserção com ENTITY_STATUS_ARCHIVED não serão incluídos nos resultados.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders
Obrigatório. O ID do anunciante para o qual os pedidos de inserção serão listados.
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 insertionOrders.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:
"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 pedido de inserção.
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:
Todos os pedidos de inserção em uma campanha: campaignId="1234"
Todos os pedidos de inserção ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED de um anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
Todos os pedidos de inserção com tempo de atualização menor ou igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
Todos os pedidos de inserção com tempo de atualização maior ou igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método insertionOrders.list para recuperar a próxima página de resultados.