Method: advertisers.reachForecast.retrievePlannableUserLists

Ruft eigene und Drittanbieter-Nutzerlisten ab, die für Prognosen verfügbar sind.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, für den planbare Nutzerlisten abgerufen werden sollen.

Suchparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Muss zwischen 1 und 5000 liegen. Wenn nicht angegeben, wird standardmäßig 5000 verwendet.
pageToken

string

Optional. 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 reachForecast.retrievePlannableUserLists zurückgegeben wurde. Wenn keine Angabe erfolgt, wird die erste Ergebnisseite zurückgegeben.
filter

string

Optional. Ermöglicht das Filtern nach planbaren Nutzerlistenattributen.

Unterstützte Syntax:

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit den logischen Operatoren AND oder OR kombiniert werden.
  • Eine Einschränkung hat die Form {field} {operator} {value}.
  • Das Feld displayName muss den Operator HAS (:) verwenden.
  • Für alle anderen Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Felder:

  • plannableStatus
  • displayName
  • userListType
  • name

Beispiele:

  • Alle planbaren Nutzerlisten: plannableStatus="PLANNABLE"
  • Planbare Nutzerlisten mit dem Anzeigenamen „Shopping“: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Eigene Nutzerlisten: userListType="FIRST_PARTY"

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

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für reachForecast.retrievePlannableUserLists.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (PlannableUserList)

Nur Ausgabe. Die Liste der planbaren Nutzerlisten.
nextPageToken

string

Nur Ausgabe. Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

PlannableUserList

Eine planbare Nutzerliste, die für Reichweitenprognosen verwendet wird.

JSON-Darstellung 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Felder
displayName

string

Nur Ausgabe. Der Anzeigename der Nutzerliste.
userListType

enum (UserListType)

Nur Ausgabe. Der Typ der Nutzerliste.
name

string

Nur Ausgabe. Der Ressourcenname, der die Nutzerliste identifiziert.

Format: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Nur Ausgabe. Der Planbarkeitsstatus der Nutzerliste.

UserListType

Arten von Nutzerlisten

Enums
USER_LIST_TYPE_UNSPECIFIED Nicht angegebener Nutzerlistentyp.
FIRST_PARTY Eine Liste mit selbst erhobenen Nutzerdaten.
THIRD_PARTY Eine Nutzerliste eines Drittanbieters.

PlannableStatus

Status, der angibt, ob eine Liste planbar ist oder nicht.

Enums
PLANNABLE_STATUS_UNSPECIFIED Nicht angegebener Planbarkeitsstatus.
PLANNABLE Die Nutzerliste ist planbar.
UNPLANNABLE Die Nutzerliste kann nicht geplant werden.