Method: customLists.list

Listet benutzerdefinierte Listen auf.

Die Reihenfolge wird durch den Parameter orderBy definiert.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v4/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. Normalerweise ist das der Wert von nextPageToken, der vom vorherigen Aufruf der Methode customLists.list zurückgegeben wurde. Wenn nicht angegeben, wird die erste Seite der Ergebnisse 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 höchstens eine Einschränkung enthalten.
  • Eine Einschränkung hat die Form {field} {operator} {value}.
  • Für alle Felder 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 sollte maximal 500 Zeichen betragen.

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

Erforderlich. Gibt an, für welche DV360-Einheit die Anfrage gestellt wird. Bei der LIST-Anfrage werden nur benutzerdefinierte Listeneinheiten zurückgegeben, auf die über die in accessor angegebene DV360-Einheit zugegriffen werden kann. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. 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.

Wenn die Liste leer ist, wird sie nicht angezeigt.

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.