Method: customLists.list

Listet benutzerdefinierte Listen auf.

Die Reihenfolge wird durch den Parameter orderBy definiert.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn nicht angegeben, 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 Methode customLists.list zurückgegeben wurde. Wenn keine Angabe erfolgt, 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 Sie absteigend sortieren möchten, nutzen Sie das Suffix „desc“. Beispiel: displayName desc.

filter

string

Ermöglicht das Filtern nach benutzerdefinierten Listenfeldern.

Unterstützte Syntax:

  • Filterausdrücke für benutzerdefinierte Listen dürfen maximal eine Einschränkung enthalten.
  • Eine Einschränkung hat die Form {field} {operator} {value}.
  • In allen Feldern muss der Operator HAS (:) verwendet werden.

Unterstützte Felder:

  • displayName

Beispiele:

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

Die Länge dieses Felds darf maximal 500 Zeichen betragen.

Weitere Informationen finden Sie in unserem Leitfaden zum Filtern von LIST-Anfragen.

Erforderlich. Gibt an, in welcher DV360-Entität die Anfrage gestellt wird. Die LIST-Anfrage gibt nur benutzerdefinierte Listenentitäten zurück, auf die die in der accessor angegebene DV360-Entität zugreifen kann. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
advertiserId

string (int64 format)

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

Ende der sich gegenseitig ausschließenden Felder.

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 Feld pageToken im nachfolgenden Aufruf der Methode customLists.list, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.