REST Resource: advertisers.youtubeAdGroupAds

Ressource: YouTubeAdGroupAd

Eine einzelne Anzeige, die mit einer YouTube-Anzeigengruppe verknüpft ist.

JSON-Darstellung
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
Felder
name

string

Der Ressourcenname der Anzeige.

advertiserId

string (int64 format)

Die eindeutige ID des Werbetreibenden, zu dem die Anzeige gehört.

adGroupAdId

string (int64 format)

Die eindeutige ID der Anzeige. Vom System zugewiesen.

adGroupId

string (int64 format)

Die eindeutige ID der Anzeigengruppe, zu der die Anzeige gehört.

displayName

string

Der Anzeigename der Anzeige.

Muss UTF-8-codiert sein und darf maximal 255 Byte lang sein.

entityStatus

enum (EntityStatus)

Der Entitätsstatus der Anzeige.

adUrls[]

object (AdUrl)

Liste der URLs, die in der Anzeige verwendet werden.

Union-Feld ad_details. Die Details der Anzeige. Für ad_details ist nur einer der folgenden Werte zulässig:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Details zu einer Anzeige, die aus einem Display & Video 360-Creative stammen.

mastheadAd

object (MastheadAd)

Details zu einer Anzeige, die im YouTube-Startseitenfeed ausgeliefert wurde

inStreamAd

object (InStreamAd)

Details zu einer In-Stream-Anzeige, die nach 5 Sekunden übersprungen werden kann, um die Markenbekanntheit zu steigern oder Marketingziele zu erreichen

nonSkippableAd

object (NonSkippableAd)

Details einer nicht überspringbaren kurzen In-Stream-Videoanzeige mit einer Länge zwischen 6 und 15 Sekunden, die zum Erreichen von Marketingzielen verwendet wird

bumperAd

object (BumperAd)

Details zu einer nicht überspringbaren kurzen Videoanzeige mit einer Dauer von mindestens 6 Sekunden, die für die Reichweite verwendet wird

audioAd

object (AudioAd)

Details zu einer Audioanzeige, die für Marketingziele im Hinblick auf die Reichweite verwendet wird.

videoDiscoverAd

object (VideoDiscoveryAd)

Details zu einer Anzeige, mit der für ein Video geworben wird, die an Positionen eingeblendet wird, die für Nutzer interessant sind

videoPerformanceAd

object (VideoPerformanceAd)

Details zu einer Anzeige, die in einer Video-Aktionskampagne verwendet wird, um Aktionen für das Unternehmen, die Dienstleistung oder das Produkt zu fördern

DisplayVideoSourceAd

Die Anzeige, die aus einem DV360-Creative stammt.

JSON-Darstellung
{
  "creativeId": string
}
Felder
creativeId

string (int64 format)

Die ID des Quell-Creatives.

MastheadAd

Details zu einer Masthead-Anzeige

JSON-Darstellung
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
Felder
video

object (YoutubeVideoDetails)

Das in der Anzeige verwendete YouTube-Video.

headline

string

Der Titel der Anzeige.

description

string

Die Beschreibung der Anzeige.

videoAspectRatio

enum (VideoAspectRatio)

Das Seitenverhältnis des automatisch wiedergegebenen YouTube-Videos im Masthead.

autoplayVideoStartMillisecond

string (int64 format)

Der Zeitraum in Millisekunden, nach dem die Wiedergabe des Videos gestartet wird.

autoplayVideoDuration

string (Duration format)

Die Dauer der automatischen Wiedergabe des Videos.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

callToActionButtonLabel

string

Der Text auf der Call-to-Action-Schaltfläche

callToActionFinalUrl

string

Die Ziel-URL für die Call-to-Action-Schaltfläche

callToActionTrackingUrl

string

Die Tracking-URL für die Call-to-Action-Schaltfläche.

showChannelArt

boolean

Gibt an, ob ein Hintergrund oder ein Banner oben auf einer YouTube-Seite angezeigt werden soll.

companionYoutubeVideos[]

object (YoutubeVideoDetails)

Die Videos, die auf Computern neben der Masthead-Anzeige erscheinen. Darf nicht mehr als zwei betragen.

YoutubeVideoDetails

Details zu einem YouTube-Video.

JSON-Darstellung
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Felder
id

string

Die YouTube-Video-ID, die auf der YouTube-Webseite gesucht werden kann.

unavailableReason

enum (VideoUnavailableReason)

Der Grund, warum die Videodaten nicht verfügbar sind.

VideoUnavailableReason

Mögliche Gründe, warum ein Video nicht verfügbar ist.

Enums
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Unbekannt oder nicht angegeben.
VIDEO_UNAVAILABLE_REASON_PRIVATE Das Video ist privat.
VIDEO_UNAVAILABLE_REASON_DELETED Das Video wird gelöscht.

VideoAspectRatio

Mögliche Seitenverhältnisse für ein YouTube-Video.

Enums
VIDEO_ASPECT_RATIO_UNSPECIFIED Nicht angegeben oder unbekannt.
VIDEO_ASPECT_RATIO_WIDESCREEN Das Video wird gestreckt und oben und unten abgeschnitten.
VIDEO_ASPECT_RATIO_FIXED_16_9 Das Video hat ein festes Seitenverhältnis von 16:9.

InStreamAd

Details zu einer In-Stream-Anzeige

JSON-Darstellung
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Felder
commonInStreamAttribute

object (CommonInStreamAttribute)

Gängige Anzeigenattribute

customParameters

map (key: string, value: string)

Benutzerdefinierte Parameter, mit denen benutzerdefinierte Werte an die Tracking-URL-Vorlage übergeben werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Allgemeine Attribute für In-Stream-, nicht überspringbare und Bumper-Anzeigen

JSON-Darstellung
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Felder
displayUrl

string

Die Adresse der Webseite, die in der Anzeige zu sehen ist.

finalUrl

string

Die URL-Adresse der Webseite, auf die Nutzer gelangen, wenn sie auf die Anzeige klicken.

trackingUrl

string

Die URL-Adresse, die im Hintergrund zu Tracking-Zwecken geladen wird.

actionButtonLabel

string

Der Text auf der Call-to-Action-Schaltfläche

actionHeadline

string

Der Titel des Call-to-Action-Banners.

video

object (YoutubeVideoDetails)

Das YouTube-Video der Anzeige

companionBanner

object (ImageAsset)

Das Bild, das neben der Videoanzeige erscheint.

ImageAsset

Metadaten eines Bild-Assets.

JSON-Darstellung
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Felder
mimeType

string

MIME-Typ des Bild-Assets.

fullSize

object (Dimensions)

Metadaten für dieses Bild in Originalgröße.

fileSize

string (int64 format)

Die Dateigröße des Bild-Assets in Byte.

NonSkippableAd

Details zu einer nicht überspringbaren Anzeige

JSON-Darstellung
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Felder
commonInStreamAttribute

object (CommonInStreamAttribute)

Gängige Anzeigenattribute

customParameters

map (key: string, value: string)

Benutzerdefinierte Parameter, mit denen benutzerdefinierte Werte an die Tracking-URL-Vorlage übergeben werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Details zu einer Bumper-Anzeige

JSON-Darstellung
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Felder
commonInStreamAttribute

object (CommonInStreamAttribute)

Gängige Anzeigenattribute

AudioAd

Details zu einer Audioanzeige

JSON-Darstellung
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Felder
displayUrl

string

Die Adresse der Webseite, die in der Anzeige zu sehen ist.

finalUrl

string

Die URL-Adresse der Webseite, auf die Nutzer gelangen, wenn sie auf die Anzeige klicken.

trackingUrl

string

Die URL-Adresse, die im Hintergrund zu Tracking-Zwecken geladen wird.

video

object (YoutubeVideoDetails)

Das YouTube-Video der Anzeige

VideoDiscoveryAd

Details zu einer Video Discovery-Anzeige.

JSON-Darstellung
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Felder
headline

string

Die Überschrift der Anzeige.

description1

string

Erste Textzeile für die Anzeige.

description2

string

Zweite Textzeile für die Anzeige

video

object (YoutubeVideoDetails)

Das YouTube-Video, für das in der Anzeige geworben wird

thumbnail

enum (Thumbnail)

Thumbnail-Bild, das in der Anzeige verwendet wird.

Thumbnail

Mögliche Thumbnail-Optionen in Video Discovery-Anzeigen

Enums
THUMBNAIL_UNSPECIFIED Unbekannt oder nicht angegeben.
THUMBNAIL_DEFAULT Das Standard-Thumbnail kann automatisch generiert oder vom Nutzer hochgeladen werden.
THUMBNAIL_1 Thumbnail 1, generiert aus dem Video.
THUMBNAIL_2 Miniaturansicht 2, aus dem Video generiert
THUMBNAIL_3 Thumbnail 3, generiert aus dem Video.

VideoPerformanceAd

Details zu einer Video-Performance-Anzeige.

JSON-Darstellung
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
Felder
finalUrl

string

Die URL-Adresse der Webseite, auf die Nutzer gelangen, wenn sie auf die Anzeige klicken.

trackingUrl

string

Die URL-Adresse, die im Hintergrund zu Tracking-Zwecken geladen wird.

actionButtonLabels[]

string

Die Liste der Text-Assets, die auf der Call-to-Action-Schaltfläche angezeigt werden.

headlines[]

string

Liste der Anzeigentitel, die auf dem Call-to-Action-Banner zu sehen sind

longHeadlines[]

string

Die Liste der einzelnen Anzeigentitel, die im Call-to-Action-Banner angezeigt werden.

descriptions[]

string

Die Liste der Beschreibungen, die im Call-to-Action-Banner angezeigt werden.

displayUrlBreadcrumb1

string

Der erste Teil nach der Domain in der angezeigten URL.

displayUrlBreadcrumb2

string

Der zweite Teil nach der Domain in der angezeigten URL

domain

string

Die Domain der angezeigten URL

videos[]

object (YoutubeVideoDetails)

Die Liste der YouTube-Video-Assets, die für diese Anzeige verwendet werden.

customParameters

map (key: string, value: string)

Die benutzerdefinierten Parameter zur Übergabe benutzerdefinierter Werte an die Tracking-URL-Vorlage.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

companionBanners[]

object (ImageAsset)

Die Liste der Companion-Banner, die von dieser Anzeige verwendet werden.

AdUrl

Zusätzliche URLs im Zusammenhang mit der Anzeige, einschließlich Beacons.

JSON-Darstellung
{
  "type": enum (AdUrlType),
  "url": string
}
Felder
type

enum (AdUrlType)

Der Typ der Anzeigen-URL.

url

string

Der URL-Stringwert.

AdUrlType

Mögliche Typen von Anzeigen-URLs

Enums
AD_URL_TYPE_UNSPECIFIED Unbekannt oder nicht angegeben.
AD_URL_TYPE_BEACON_IMPRESSION Ein 1:1-Tracking-Pixel, das gepingt wird, wenn eine Impression eines Creatives ausgeliefert wird.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Erweiterbares DCM-Impressions-Beacon. Zum Zeitpunkt der Auslieferung wird sie auf mehrere Beacons erweitert.
AD_URL_TYPE_BEACON_CLICK Tracking-URL, die gepingt werden soll, wenn das Klickereignis ausgelöst wird.
AD_URL_TYPE_BEACON_SKIP Tracking-URL, die gepingt werden soll, wenn das Überspringen-Ereignis ausgelöst wird.

Methoden

get

Ruft eine Anzeige in einer YouTube-Anzeigengruppe ab.

list

Listet Anzeigen auf YouTube-Anzeigengruppen auf.