Method: advertisers.list

Listet Werbetreibende auf, auf die der aktuelle Nutzer zugreifen kann.

Die Reihenfolge wird durch den Parameter orderBy definiert.

Es ist nur ein partnerId erforderlich. Die partnerübergreifende Auflistung wird nicht unterstützt.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v3/advertisers

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
partnerId

string (int64 format)

Erforderlich. Die ID des Partners, zu dem alle abgerufenen Werbetreibenden gehören sollen. Das System unterstützt nur die Auflistung von Werbetreibenden für jeweils einen Partner.
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 Methode advertisers.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:

  • advertiserId (Standard)
  • displayName
  • 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 Werbetreibendenfeldern.

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 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:

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

Beispiele:

  • Alle aktiven Werbetreibenden unter einem Partner: entityStatus="ENTITY_STATUS_ACTIVE"
  • Alle Werbetreibenden mit einer Aktualisierungszeit, die kleiner oder gleich 2020-11-04T18:54:47Z ist (Format nach ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Alle Werbetreibenden 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 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Felder
advertisers[]

object (Advertiser)

Die Liste der Werbetreibenden.

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