Method: advertisers.insertionOrders.list

Listet die Anzeigenaufträge eines Werbetreibenden auf.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wenn kein filter nach entityStatus angegeben ist, werden Anzeigenaufträge mit ENTITY_STATUS_ARCHIVED nicht in die Ergebnisse aufgenommen.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, für den Anzeigenaufträge aufgelistet werden sollen.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 100 liegen. Wenn nicht angegeben, wird standardmäßig 100 verwendet. Wenn ein ungültiger Wert angegeben wird, wird der Fehlercode INVALID_ARGUMENT zurückgegeben.
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 insertionOrders.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)
  • „entityStatus“
  • „updateTime“

Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie ein Feld absteigend sortieren möchten, sollte dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Anzeigenauftragsfeldern.

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 Folge von Einschränkungen verwendet implizit AND.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Für das Feld updateTime müssen die Operatoren GREATER THAN OR EQUAL TO (>=) oder LESS THAN OR EQUAL TO (<=) verwendet werden.
  • Für alle anderen Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Felder:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (im ISO 8601-Format eingeben oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

  • Alle Anzeigenaufträge einer Kampagne: campaignId="1234"
  • Alle ENTITY_STATUS_ACTIVE- oder ENTITY_STATUS_PAUSED-Anzeigenaufträge für einen Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Alle Anzeigenaufträge mit einer Aktualisierungszeit, die vor oder am 04.11.2020 um 18:54:47 Uhr (ISO 8601-Format) liegt: updateTime<="2020-11-04T18:54:47Z"
  • Alle Anzeigenaufträge mit einer Aktualisierungszeit, die mindestens dem 2020-11-04T18:54:47Z (ISO 8601-Format) entspricht: updateTime>="2020-11-04T18:54:47Z"

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

Weitere Informationen finden Sie in unserem Leitfaden zu LIST-Anfragen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (InsertionOrder)

Die Liste der Anzeigenaufträ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 insertionOrders.list, 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 OAuth 2.0-Übersicht.