Method: advertisers.adGroupAds.list

Listet Anzeigengruppenanzeigen auf.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

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

Suchparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Muss zwischen 1 und 100 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. In der Regel ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der Methode adGroupAds.list zurückgegeben wurde. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben.
orderBy

string

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

  • displayName (Standard)
  • entityStatus

Die Standardsortierreihenfolge ist aufsteigend. 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 Feldern von Anzeigengruppenanzeigen.

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 die Form {field} {operator} {value}.
  • Für alle Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Felder:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Beispiele:

  • Alle Anzeigengruppenanzeigen in einer Anzeigengruppe: adGroupId="1234"
  • Alle Anzeigengruppenanzeigen in einer Anzeigengruppe mit dem entityStatus ENTITY_STATUS_ACTIVE oder ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

Die Länge dieses Felds darf maximal 500 Zeichen betragen.

Weitere Informationen finden Sie im Leitfaden zu Filter LIST Anfragen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
Felder
adGroupAds[]

object (AdGroupAd)

Die Liste der Anzeigen.

Diese Liste ist leer, wenn sie leer ist.
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 adGroupAds.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.