Method: customLists.list

Listet benutzerdefinierte Listen auf.

Die Reihenfolge wird durch den Parameter orderBy definiert.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn kein Wert angegeben ist, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wird.
pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. In der Regel ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der customLists.list-Methode zurückgegeben wurde. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben.
orderBy

string

Feld, nach dem die Liste sortiert werden soll. Akzeptable Werte sind:

  • customListId (Standard)
  • displayName

Die Standardsortierreihenfolge ist aufsteigend. Wenn ein Feld in absteigender Reihenfolge sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach benutzerdefinierten Listenfeldern.

Unterstützte Syntax:

  • Filterausdrücke für benutzerdefinierte Listen dürfen höchstens eine Einschränkung enthalten.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Alle Felder müssen den Operator HAS (:) verwenden.

Unterstützte Felder:

  • displayName

Beispiele:

  • Alle benutzerdefinierten Listen, deren Anzeigename „Google“ enthält: displayName:"Google".

Die Länge dieses Felds darf 500 Zeichen nicht überschreiten.

Weitere Informationen finden Sie im Leitfaden LIST-Anfragen filtern.
advertiserId

string (int64 format)

Die ID des DV360-Werbetreibenden, der Zugriff auf die abgerufenen benutzerdefinierten Listen hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Felder
customLists[]

object (CustomList)

Die Liste der benutzerdefinierten Listen.

Diese Liste ist nicht vorhanden, wenn sie leer ist.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im nachfolgenden Aufruf der customLists.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.