Method: customLists.list

Lista as listas personalizadas.

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/customLists

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

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. 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 customLists.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:

  • customListId (padrão)
  • displayName

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 lista personalizados.

Sintaxe aceita:

  • As expressões de filtro para listas personalizadas podem conter no máximo uma restrição.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Todos os campos precisam usar o operador HAS (:).

Campos compatíveis:

  • displayName

Exemplos:

  • Todas as listas personalizadas em que o nome de exibição contém "Google": displayName:"Google".

O comprimento desse campo não pode exceder 500 caracteres.

Consulte nosso guia de filtragem de solicitações LIST para mais informações.
Parâmetro de união accessor. Obrigatório. Identifica a entidade do DV360 em que a solicitação está sendo feita. A solicitação LIST só vai retornar entidades de lista personalizadas que são acessíveis à entidade do DV360 identificada no accessor. accessor pode ser apenas de um dos tipos a seguir:
advertiserId

string (int64 format)

O ID do anunciante do DV360 que tem acesso às listas personalizadas buscadas.

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 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Campos
customLists[]

object (CustomList)

A lista de listas personalizadas.

Essa lista não será exibida se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente para o método customLists.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.