Method: guaranteedOrders.list

Listet garantierte Aufträge auf, auf die der aktuelle Nutzer Zugriff hat.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wenn keine 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/v3/guaranteedOrders

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.

pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. Normalerweise ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der Methode guaranteedOrders.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:

  • displayName (Standard)

Standardmäßig werden die Einträge aufsteigend sortiert. Wenn Sie ein Feld absteigend sortieren möchten, sollte das Suffix „desc“ an den Feldnamen angehängt werden. Beispiel: displayName desc.

filter

string

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

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

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

Beispiele:

  • Alle aktiven garantierten Bestellungen: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Garantierte Aufträge, die zu Google Ad Manager- oder Rubicon-Börsen gehören: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

Dieses Feld darf maximal 500 Zeichen lang sein.

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

Union-Parameter accessor. Erforderlich.

Gibt an, für welche DV360-Entität die Anfrage gestellt wird. Bei der LIST-Anfrage werden nur Entitäten für garantierte Aufträge 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 den garantierten Auftrag 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 Aufträge.

Wenn die Liste leer ist, ist sie nicht vorhanden.

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 guaranteedOrders.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.