A partir de 8 de setembro de 2025, todos os novos itens de linha precisarão declarar se vão veicular anúncios políticos da União Europeia (UE). As APIs do Display & Video 360 e os uploads de SDF que não fornecem declarações vão falhar. Consulte nossa página de suspensões de uso para mais detalhes sobre como atualizar sua integração e fazer essa declaração.
A ordem é definida pelo parâmetro orderBy. Se um filter por 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 listar os pedidos de inserção.
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, 100 será usado como padrão. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
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 insertionOrders.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 de um campo, adicione o sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter
string
Permite filtrar por campos de ordem de inserção.
Sintaxe aceita:
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")
Todas as ordens de inserção 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 ordens de inserção 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 deste campo não pode exceder 500 caracteres.
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente para o método insertionOrders.list para recuperar a próxima página de resultados.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eLists insertion orders, filterable by campaign ID, display name, entity status, and update time, within a specified advertiser.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large result sets via \u003ccode\u003epageToken\u003c/code\u003e and \u003ccode\u003epageSize\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eAllows sorting results by display name, entity status, or update time, with optional descending order.\u003c/p\u003e\n"],["\u003cp\u003eResponse provides a list of insertion orders and a token for fetching the next page if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This API endpoint lists insertion orders for a specified advertiser using a GET request. You must provide the `advertiserId` as a path parameter. You can filter the results using the `filter` query parameter, sort them using `orderBy`, and control pagination with `pageSize` and `pageToken`. The response includes a list of `insertionOrders` and a `nextPageToken` for pagination. Filtering allows for logical operators and various fields, including `entityStatus` and `updateTime`. The request body must be empty.\n"],null,[]]
