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, 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 ID do anunciante para quem as campanhas serão listadas.
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 de um campo, adicione o sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter
string
Permite filtrar por campos de campanha.
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:
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"
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 campaigns.list para recuperar a próxima página de resultados.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eLists campaigns within a specified advertiser, allowing for filtering and sorting.\u003c/p\u003e\n"],["\u003cp\u003eRetrieves paginated results, with options to control page size and navigate through pages.\u003c/p\u003e\n"],["\u003cp\u003eSupports filtering by campaign attributes such as ID, display name, entity status, and update time.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific OAuth scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of campaigns with details and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"]]],["This describes how to list campaigns for an advertiser using a `GET` request to the specified endpoint. Key actions include using the `advertiserId` path parameter and optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter`. `orderBy` allows sorting by `displayName`, `entityStatus`, or `updateTime`. The response includes a list of campaigns and a `nextPageToken` for pagination. Filters can be applied to fields such as `campaignId`, `displayName`, `entityStatus`, and `updateTime`. The request body must be empty.\n"],null,[]]
