Method: advertisers.adGroupAds.list

Listet Anzeigen der Anzeigengruppe auf.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v3/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 Anzeigengruppe gehört.

Abfrageparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Muss zwischen 1 und 100 liegen. Wenn kein Wert angegeben ist, 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 adGroupAds.list-Methode 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 ein Feld in absteigender Reihenfolge sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt 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. Eine Folge von Einschränkungen verwendet implizit AND.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Alle Felder müssen den Operator EQUALS (=) verwenden.

Unterstützte Felder:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Beispiele:

  • Alle Anzeigen einer Anzeigengruppe 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 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 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
Felder
adGroupAds[]

object (AdGroupAd)

Die Liste der Anzeigengruppenanzeigen.

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