Method: advertisers.campaigns.list

Listet die Kampagnen eines Werbetreibenden auf.

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

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

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

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn kein Wert angegeben ist, 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 campaigns.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 Standardsortierreihenfolge ist aufsteigend. Wenn ein Feld in absteigender Reihenfolge sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Kampagnenfeldern.

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}.
  • Das Feld updateTime muss den Operator GREATER THAN OR EQUAL TO (>=) oder LESS THAN OR EQUAL TO (<=) verwenden.
  • Für alle anderen Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Felder:

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

Beispiele:

  • Alle ENTITY_STATUS_ACTIVE- oder ENTITY_STATUS_PAUSED-Kampagnen eines Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Alle Kampagnen, deren Aktualisierungszeit kleiner oder gleich dem 2020-11-04T18:54:47Z ist (Format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Alle Kampagnen, deren Aktualisierungszeit größer oder gleich dem 2020-11-04T18:54:47Z (Format ISO 8601) ist: updateTime>="2020-11-04T18:54:47Z"

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

Weitere Informationen finden Sie im Leitfaden LIST-Anfragen filtern.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (Campaign)

Die Liste der Kampagnen.

Diese Liste ist nicht vorhanden, 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 campaigns.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.