Method: advertisers.youtubeAdGroupAds.list

Listet Anzeigen auf YouTube-Anzeigengruppen auf.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds

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

Angeforderte Seitengröße. Muss zwischen 1 und 100 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben ist.
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 Methode youtubeAdGroupAds.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:

  • displayName (Standard)
  • entityStatus

Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie für ein Feld eine absteigende Reihenfolge angeben möchten, fügen Sie das Suffix „desc“ ein. dem Feldnamen hinzugefügt werden soll. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach benutzerdefinierten Feldern für Anzeigen in einer YouTube-Anzeigengruppe.

Unterstützte Syntax:

  • Filterausdrücke umfassen eine oder mehrere Einschränkungen.
  • Einschränkungen können nach 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 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 Feldes 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 
{
  "youtubeAdGroupAds": [
    {
      object (YoutubeAdGroupAd)
    }
  ],
  "nextPageToken": string
}
Felder
youtubeAdGroupAds[]

object (YoutubeAdGroupAd)

Die Liste der Anzeigen in der Anzeigengruppe.

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 Methode youtubeAdGroupAds.list 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.