Method: advertisers.campaigns.list

Listet die Kampagnen eines Werbetreibenden auf.

Die Reihenfolge wird durch den Parameter orderBy definiert. Wenn kein filter nach 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 die Kampagnen aufgelistet werden sollen.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, 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 Methode campaigns.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 wird die Sortierreihenfolge aufsteigend sein. Wenn Sie für ein Feld eine absteigende Reihenfolge angeben möchten, fügen Sie das Suffix „desc“ ein. dem Feldnamen hinzugefügt werden soll. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Kampagnenfeldern.

Unterstützte Syntax:

  • Filterausdrücke umfassen eine oder mehrere 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}.
  • Im Feld updateTime muss der Operator GREATER THAN OR EQUAL TO (>=) oder LESS THAN OR EQUAL TO (<=) verwendet werden.
  • In allen anderen Feldern 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 mit einer Aktualisierungszeit kleiner oder gleich 2020-11-04T18:54:47Z (Format von ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Alle Kampagnen mit einer Aktualisierungszeit größer oder gleich 2020-11-04T18:54:47Z (Format von ISO 8601): updateTime>="2020-11-04T18:54:47Z"

Die Länge dieses Feldes 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 Methode campaigns.list 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.