Method: customLists.list

Elenca gli elenchi personalizzati.

L'ordine è definito dal parametro orderBy.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v4/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, 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, questo è il valore di nextPageToken restituito dalla chiamata precedente al metodo customLists.list. Se non specificato, verrà restituita la prima pagina dei risultati.
orderBy

string

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

  • customListId (valore predefinito)
  • displayName

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

string

Consente di filtrare in base ai campi dell'elenco personalizzato.

Sintassi supportata:

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

Campi supportati:

  • displayName

Esempi:

  • Tutti gli elenchi personalizzati per i quali il nome visualizzato contiene "Google": displayName:"Google".

La lunghezza di questo campo non deve superare i 500 caratteri.

Per saperne di più, consulta la nostra guida relativa alle richieste di LIST filtro.
Obbligatorio. Identifica l'entità DV360 in cui viene effettuata la richiesta. La richiesta LIST restituirà solo le entità di elenchi personalizzati accessibili all'entità DV360 identificata in accessor. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
advertiserId

string (int64 format)

L'ID dell'inserzionista DV360 che ha accesso agli elenchi personalizzati recuperati.
Fine dei campi che si escludono a vicenda.

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 degli elenchi personalizzati.

Questo elenco non sarà presente se è vuoto.
nextPageToken

string

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

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.