Method: advertisers.lineItems.list

Listet Werbebuchungen eines Werbetreibenden auf.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wenn keine filter nach entityStatus angegeben ist, werden Positionen mit ENTITY_STATUS_ARCHIVED nicht in die Ergebnisse einbezogen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

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

Abfrageparameter

Parameter
pageSize

integer

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

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 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 Folge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Für das Feld updateTime muss der Operator 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
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (Eingabe im ISO 8601-Format oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

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

Dieses Feld darf maximal 500 Zeichen lang sein.

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

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

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