Method: advertisers.youtubeAdGroups.list

Listet YouTube-Anzeigengruppen auf

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, zu dem die Anzeigengruppe gehört.

Abfrageparameter

Parameters
pageSize

integer

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

Die standardmäßige Sortierreihenfolge ist aufsteigend. Wenn ein Feld absteigend sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach benutzerdefinierten Feldern für YouTube-Anzeigengruppen.

Unterstützte Syntax:

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit AND und OR kombiniert werden. Bei einer Abfolge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Alle Felder müssen den Operator EQUALS (=) verwenden.

Unterstützte Properties:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Beispiele:

  • Alle Anzeigengruppen einer Werbebuchung: lineItemId="1234"
  • Alle ENTITY_STATUS_ACTIVE- oder ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM-Anzeigengruppen für einen Werbetreibenden: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"

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

Weitere Informationen finden Sie im Leitfaden zu LIST-Filteranfragen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (YoutubeAdGroup)

Die Liste der Anzeigengruppen.

Diese Liste fehlt, 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 youtubeAdGroups.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.