REST Resource: advertisers.adGroupAds

Ressource: Anzeigengruppen-Anzeige

Eine einzelne Anzeige, die einer Anzeigengruppe zugeordnet 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 groß sein.
entityStatus

enum (EntityStatus)

Der Entitätsstatus der Anzeige.
adUrls[]

object (AdUrl)

Liste der von der Anzeige verwendeten URLs.
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 Anzeigenquelle, die aus einem Display & Video 360-Creative stammt.
mastheadAd

object (MastheadAd)

Details zu einer im YouTube-Startseitenfeed ausgelieferten Anzeige
inStreamAd

object (InStreamAd)

Details zu einer In-Stream-Anzeige, die nach fünf Sekunden übersprungen werden kann, die zur Steigerung der Markenbekanntheit oder zum Erreichen von Marketingzielen verwendet wird
nonSkippableAd

object (NonSkippableAd)

Details einer nicht überspringbaren kurzen In-Stream-Videoanzeige, die zwischen 6 und 15 Sekunden lang ist und zum Erreichen von Marketingzielen verwendet wird
bumperAd

object (BumperAd)

Details einer nicht überspringbaren kurzen Videoanzeige, die maximal sechs Sekunden lang ist und für die Reichweite verwendet wird.
audioAd

object (AudioAd)

Details zu einer Audioanzeige, die zum Erreichen von Marketingzielen verwendet wird
videoDiscoverAd

object (VideoDiscoveryAd)

Details zu einer Anzeige, in der ein Video beworben wird, das an Positionen angezeigt 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 aus einem DV360-Creative.

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 von der Anzeige verwendete YouTube-Video
headline

string

Den Anzeigentitel 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)

Die Zeitspanne in Millisekunden, nach der die Videowiedergabe des Videos beginnt.
autoplayVideoDuration

string (Duration format)

Die Dauer, während der das Video automatisch wiedergegeben wird.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".
callToActionButtonLabel

string

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 dem Computer neben der Masthead-Anzeige erscheinen. Darf nicht mehr als zwei sein.

YoutubeVideoDetails

Details zu einem YouTube-Video.

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

string

Die YouTube-Video-ID, nach der 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 möglicherweise 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 wurde 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 der obere und untere Rand werden 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)

Die benutzerdefinierten 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 mit der Anzeige erscheint.
finalUrl

string

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

string

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

string

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

string

Der Anzeigentitel des Call-to-Action-Banners.
video

object (YoutubeVideoDetails)

Das YouTube-Video der Anzeige
companionBanner

object (ImageAsset)

Das Bild, das neben der Videoanzeige zu sehen ist.

ImageAsset

Metadaten eines Bild-Assets

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

string

MIME-Typ des Image-Assets.
fullSize

object (Dimensions)

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

string (int64 format)

Dateigröße des Bild-Assets in Byte.

NonSkippableAd

Details zu nicht überspringbaren Anzeigen

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

object (CommonInStreamAttribute)

Gängige Anzeigenattribute.
customParameters

map (key: string, value: string)

Die benutzerdefinierten 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 für eine 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 mit der Anzeige erscheint.
finalUrl

string

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

string

Die URL-Adresse, die zu Tracking-Zwecken im Hintergrund 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

Der Anzeigentitel 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 die Anzeige wirbt.
thumbnail

enum (Thumbnail)

Das in der Anzeige verwendete Thumbnail.

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 von Nutzern hochgeladen werden.
THUMBNAIL_1 Aus dem Video generiertes Thumbnail 1.
THUMBNAIL_2 Aus dem Video generiertes Thumbnail 2.
THUMBNAIL_3 Aus dem Video generiertes Thumbnail 3.

VideoPerformanceAd

Details zu einer leistungsorientierten Anzeige für Videoanzeigen

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 zu Tracking-Zwecken im Hintergrund geladen wird.
actionButtonLabels[]

string

Die Liste der Text-Assets, die auf der Call-to-Action-Schaltfläche zu sehen sind
headlines[]

string

Die Liste der Anzeigentitel, die auf dem Call-to-Action-Banner zu sehen sind.
longHeadlines[]

string

Die Liste der einzelnen Anzeigentitel, die auf dem Call-to-Action-Banner zu sehen sind.
descriptions[]

string

Die Liste der Beschreibungen auf dem Call-to-Action-Banner.
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

Domain der angezeigten URL
videos[]

object (YoutubeVideoDetails)

Die Liste der YouTube-Video-Assets, die in dieser Anzeige verwendet werden.
customParameters

map (key: string, value: string)

Die benutzerdefinierten 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" }.
companionBanners[]

object (ImageAsset)

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

AdUrl

Zusätzliche URLs, die sich auf die Anzeige beziehen, einschließlich Beacons

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

enum (AdUrlType)

Der Typ der Anzeigen-URL.
url

string

Der Wert des URL-Strings.

AdUrlType

Mögliche Typen von Anzeigen-URLs.

Enums
AD_URL_TYPE_UNSPECIFIED Unbekannt oder nicht angegeben.
AD_URL_TYPE_BEACON_IMPRESSION Ein 1 x 1-Tracking-Pixel, das angepingt werden soll, wenn eine Impression eines Creatives ausgeliefert wird.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Beacon für Expandable-DCM-Impressionen Bei der Auslieferung werden mehrere Beacons unterstützt.
AD_URL_TYPE_BEACON_CLICK Tracking-URL, die angepingt werden soll, wenn das Klickereignis ausgelöst wird.
AD_URL_TYPE_BEACON_SKIP Tracking-URL, die angepingt werden soll, wenn das Ereignis „Überspringen“ ausgelöst wird.

Methoden

get

 Ruft eine Anzeigengruppenanzeige ab

list

 Listet Anzeigen der Anzeigengruppe auf.