Method: advertisers.lineItems.list

Listet die Werbebuchungen eines Werbetreibenden auf.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wird kein filter nach entityStatus angegeben, werden Werbebuchungen mit ENTITY_STATUS_ARCHIVED nicht in die Ergebnisse aufgenommen.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/lineItems

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, für den Werbebuchungen aufgelistet werden sollen.

Abfrageparameter

Parameters
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wurde.
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 lineItems.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)
  • entityStatus
  • updateTime

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

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. Bei einer Abfolge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Im Feld updateTime muss der Operator GREATER THAN OR EQUAL TO (>=) oder LESS THAN OR EQUAL TO (<=) verwendet werden.
  • Alle anderen Felder müssen den Operator EQUALS (=) verwenden.

Unterstützte Felder:

  • campaignId
  • displayName
  • entityStatus
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (Eingabe im ISO-8601-Format oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

  • Alle Werbebuchungen eines Anzeigenauftrags: insertionOrderId="1234"
  • Alle ENTITY_STATUS_ACTIVE-, ENTITY_STATUS_PAUSED- und LINE_ITEM_TYPE_DISPLAY_DEFAULT-Werbebuchungen eines Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Alle Werbebuchungen mit einer Aktualisierungszeit von maximal 2020-11-04T18:54:47Z (Format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Alle Werbebuchungen mit einer Aktualisierungszeit, die größer oder gleich 2020-11-04T18:54:47Z (Format ISO 8601) ist: updateTime>="2020-11-04T18:54:47Z"

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

Weitere Informationen finden Sie im Leitfaden zu LIST-Filteranfragen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (LineItem)

Die Liste der Werbebuchungen.

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