Method: customLists.list

Elenca elenchi personalizzati.

L'ordine è definito dal parametro orderBy.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, verrà usato il valore predefinito 100. Restituisce il codice di errore INVALID_ARGUMENT se viene specificato un valore non valido.
pageToken

string

Un token che identifica una pagina di risultati che il server deve restituire. In genere, si tratta del valore di nextPageToken restituito dalla chiamata precedente al metodo customLists.list. Se non specificato, verrà restituita la prima pagina di risultati.
orderBy

string

Campo in base al quale ordinare l'elenco. I valori accettati sono:

  • customListId (valore predefinito)
  • displayName

L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente di un campo, il suffisso "desc" al nome del campo. Esempio: displayName desc.
filter

string

Consente di filtrare in base a campi elenco personalizzati.

Sintassi supportata:

  • Le espressioni di filtro per gli elenchi personalizzati possono contenere al massimo una restrizione.
  • Una limitazione ha il formato {field} {operator} {value}.
  • Tutti i campi devono utilizzare l'operatore HAS (:).

Campi supportati:

  • displayName

Esempi:

  • Tutti gli elenchi personalizzati il cui nome visualizzato contiene "Google": displayName:"Google".

La lunghezza di questo campo non deve essere superiore a 500 caratteri.

Per saperne di più, consulta la nostra guida sulle richieste di LIST filtro.
Parametro di unione accessor. Obbligatorio. Identifica l'entità DV360 all'interno della quale viene effettuata la richiesta. La richiesta LIST restituirà solo entità elenco personalizzate accessibili all'entità DV360 identificata all'interno di accessor. accessor può essere solo uno dei seguenti:
advertiserId

string (int64 format)

L'ID dell'inserzionista DV360 che ha accesso agli elenchi personalizzati recuperati.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Campi
customLists[]

object (CustomList)

L'elenco di elenchi personalizzati.

Se vuoto, questo elenco non sarà presente.
nextPageToken

string

Un token per recuperare la pagina successiva di risultati. Passa questo valore nel campo pageToken nella chiamata successiva al metodo customLists.list per recuperare la pagina dei risultati successiva.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.