Method: advertisers.campaigns.list

Liste der Kampagnen eines Werbetreibenden.

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

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v3/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 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.
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 campaigns.list-Methode 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

Es kann nach Kampagnenfeldern gefiltert werden.

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 Abfolge 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 ENTITY_STATUS_ACTIVE- oder ENTITY_STATUS_PAUSED-Kampagnen eines Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Alle Kampagnen 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 Kampagnen mit einer Aktualisierungszeit, die mindestens dem 04.11.2020 18:54:47 Uhr (ISO 8601-Format) entspricht: updateTime>="2020-11-04T18:54:47Z"

Dieses Feld darf maximal 500 Zeichen lang sein.

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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Felder
campaigns[]

object (Campaign)

Die Liste der Kampagnen.

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 campaigns.list, 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 unter OAuth 2.0 Overview.