Method: advertisers.locationLists.list

Lista as listas de locais com base em um determinado ID do anunciante.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/locationLists

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. É o ID do anunciante do DV360 a que as listas de locais buscados pertencem.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 100. Se nada for definido, 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 locationLists.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:

  • locationListId (padrão)
  • displayName

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 lista de locais.

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 operador precisa ser EQUALS (=).
  • Campos compatíveis:
    • locationType

Exemplos:

  • Todos os locais regionais: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Lista de todos os locais próximos: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
Campos
locationLists[]

object (LocationList)

Lista de locais.

Esta lista estará ausente se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados.

Transmita esse valor no campo pageToken na chamada seguinte para o método locationLists.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video

Para mais informações, consulte a Visão geral do OAuth 2.0.