Method: advertisers.list

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

Die Reihenfolge wird durch den Parameter orderBy definiert.

Ein einzelnes partnerId ist erforderlich. Partnerübergreifende Einträge werden nicht unterstützt.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
partnerId

string (int64 format)

Erforderlich. Die ID des Partners, zu dem die abgerufenen Werbetreibenden gehören sollen. Das System unterstützt nur das Auflisten von Werbetreibenden für jeweils einen Partner.
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 100 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 advertisers.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 Werbetreibendeneigenschaften.

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}.
  • Der für updateTime verwendete Operator muss GREATER THAN OR EQUAL TO (>=) oder LESS THAN OR EQUAL TO (<=) sein.
  • Der Operator muss EQUALS (=) sein.
  • Unterstützte Felder:
    • advertiserId
    • displayName
    • entityStatus
    • updateTime (Eingabe im ISO-8601-Format oder JJJJ-MM-TTTHH:MM:SSZ)

Beispiele:

  • Alle aktiven Werbetreibenden eines Partners: entityStatus="ENTITY_STATUS_ACTIVE"
  • Alle Werbetreibenden, deren Aktualisierungszeit kleiner oder gleich 2020-11-04T18:54:47Z (format of ISO 8601) ist: updateTime<="2020-11-04T18:54:47Z"
  • Alle Werbetreibenden mit einer Aktualisierungszeit größer oder gleich 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

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.

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 advertisers.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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