Method: advertisers.adGroups.list

Listet Anzeigengruppen auf.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, zu dem die Anzeigengruppen gehören.

Abfrageparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn nicht angegeben, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wird.
pageToken

string

Optional. Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. Normalerweise ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der Methode adGroups.list zurückgegeben wurde. Wenn keine Angabe erfolgt, wird die erste Ergebnisseite zurückgegeben.
orderBy

string

Optional. Feld, nach dem die Liste sortiert werden soll. Akzeptable Werte sind:

  • displayName (Standard)
  • entityStatus

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

Optional. Ermöglicht das Filtern nach benutzerdefinierten Anzeigengruppenfeldern.

Unterstützte Syntax:

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit AND und OR kombiniert werden. Bei einer Folge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Für alle Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Eigenschaften:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Beispiele:

  • Alle Anzeigengruppen für eine Werbebuchung: lineItemId="1234"
  • Alle ENTITY_STATUS_ACTIVE- oder ENTITY_STATUS_PAUSED-Anzeigengruppen unter einem Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"AD_GROUP_FORMAT_IN_STREAM

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

object (AdGroup)

Die Liste der Anzeigengruppen.

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