Method: guaranteedOrders.list

Listet garantierte Bestellungen auf, auf die der aktuelle Nutzer zugreifen kann.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wenn kein filter nach entityStatus angegeben ist, werden garantierte Bestellungen mit dem Entitätsstatus ENTITY_STATUS_ARCHIVED nicht in die Ergebnisse aufgenommen.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v2/guaranteedOrders

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameters
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet.
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 guaranteedOrders.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:

  • displayName (Standard)

Die standardmäßige Sortierreihenfolge ist aufsteigend. Wenn ein Feld absteigend sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Feldern für garantierte Reihenfolge.

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit den logischen Operatoren AND oder OR kombiniert werden. Bei einer Abfolge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Alle Felder müssen den Operator EQUALS (=) verwenden.

Unterstützte Felder: * guaranteedOrderId * exchange * displayName * status.entityStatus

Beispiele:

  • Alle aktiven garantierten Bestellungen: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Garantierte Aufträge von Anzeigenplattformen von Google Ad Manager oder Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Weitere Informationen finden Sie im Leitfaden zu LIST-Filteranfragen.

Union-Parameter accessor. Erforderlich.

Gibt an, in welcher DV360-Entität die Anfrage gesendet wird. Bei der LIST-Anfrage werden nur garantierte Auftragsentitäten zurückgegeben, auf die die in accessor angegebene DV360-Entität zugreifen kann. Für accessor ist nur einer der folgenden Werte zulässig:
partnerId

string (int64 format)

Die ID des Partners, der Zugriff auf die garantierte Bestellung hat.
advertiserId

string (int64 format)

Die ID des Werbetreibenden, der Zugriff auf den garantierten Auftrag hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (GuaranteedOrder)

Die Liste der garantierten Bestellungen.

Diese Liste fehlt, 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 guaranteedOrders.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.