Rede de Display e A API Video 360 v2 foi descontinuada. Use o Display & Video 360 API v3. Para ver as instruções de migração da v2 para a v3, consulte nosso guia de migração.
Obrigatório. O ID do parceiro ao qual os anunciantes buscados devem pertencer. O sistema só permite listar os anunciantes de um parceiro por vez.
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 advertisers.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy
string
Campo que classificará 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, use o sufixo "desc" deve ser adicionado ao nome do campo. Por exemplo, displayName desc.
filter
string
Permite filtrar por campos do anunciante.
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 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:
advertiserId
displayName
entityStatus
updateTime (entrada no formato ISO 8601 ou YYYY-MM-DDTHH:MM:SSZ)
Exemplos:
Todos os anunciantes ativos de um parceiro: entityStatus="ENTITY_STATUS_ACTIVE"
Todos os anunciantes 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"
Todos os anunciantes 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"
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método advertisers.list para recuperar a próxima página de resultados.