REST Resource: advertisers.adGroupAds

Ressource: AdGroupAd

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 Status 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 einer Anzeige, die aus einem Display & Video 360-Creative stammt.

mastheadAd

object (MastheadAd)

Details zu einer Anzeige, die im YouTube-Startseitenfeed ausgeliefert wird.

inStreamAd

object (InStreamAd)

Details zu einer In-Stream-Anzeige, die nach 5 Sekunden übersprungen werden kann und mit der Marketingziele in Bezug auf Markenbekanntheit oder Reichweite erreicht werden sollen.

nonSkippableAd

object (NonSkippableAd)

Details zu einer nicht überspringbaren kurzen In-Stream-Videoanzeige mit einer Länge von 6 bis 15 Sekunden, die für Reichweitenmarketingziele verwendet wird.

bumperAd

object (BumperAd)

Details zu einer nicht überspringbaren kurzen Videoanzeige mit einer Länge von höchstens 6 Sekunden, die für die Reichweite verwendet wird.

audioAd

object (AudioAd)

Details zu einer Audioanzeige, die zur Erreichung von Reichweiten-Marketingzielen verwendet wird.

videoDiscoverAd

object (VideoDiscoveryAd)

Details zu einer Anzeige, in der ein Video beworben wird, die an Orten für die Suche und Entdeckung ausgeliefert wird.

videoPerformanceAd

object (VideoPerformanceAd)

Details zu einer Anzeige in einer Video-Aktionskampagne, mit der Interaktionen für das Unternehmen, die Dienstleistung oder das Produkt erzielt werden sollen.

DisplayVideoSourceAd

Die Anzeige stammt 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 YouTube-Video, das in der Anzeige verwendet wird.

headline

string

Der Titel der Anzeige.

description

string

Die Beschreibung der Anzeige.

videoAspectRatio

enum (VideoAspectRatio)

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

autoplayVideoStartMillisecond

string (int64 format)

Die Zeit in Millisekunden, nach der die Videowiedergabe beginnt.

autoplayVideoDuration

string (Duration format)

Die Dauer, für die das Video automatisch abgespielt wird.

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 Hintergrundbild oder Banner oben auf einer YouTube-Seite angezeigt werden soll.

companionYoutubeVideos[]

object (YoutubeVideoDetails)

Die Videos, die auf Computern neben der Masthead-Anzeige zu sehen sind. Es dürfen maximal 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 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 ist 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)

Allgemeine Anzeigenattribute

customParameters

map (key: string, value: string)

Die benutzerdefinierten Parameter zum Übergeben 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" }.

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 zu Tracking-Zwecken im Hintergrund 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 zu sehen ist.

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)

Allgemeine Anzeigenattribute

customParameters

map (key: string, value: string)

Die benutzerdefinierten Parameter zum Übergeben 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" }.

BumperAd

Details zu einer Bumper-Anzeige

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

object (CommonInStreamAttribute)

Allgemeine 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 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 Titel der Anzeige.

description1

string

Die erste Textzeile der Anzeige.

description2

string

Die zweite Textzeile für die Anzeige.

video

object (YoutubeVideoDetails)

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

thumbnail

enum (Thumbnail)

Thumbnail, das in der Anzeige verwendet wird.

Thumbnail

Mögliche Thumbnail-Optionen bei 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 Miniaturansicht 1, die aus dem Video generiert wurde.
THUMBNAIL_2 Miniaturansicht 2, die aus dem Video generiert wurde.
THUMBNAIL_3 Miniaturansicht 3, die aus dem Video generiert wurde.

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

actionButtonLabels[]

string

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

headlines[]

string

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

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)

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

customParameters

map (key: string, value: string)

Die benutzerdefinierten Parameter zum Übergeben 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 Anzeigentypen für URLs

Enums
AD_URL_TYPE_UNSPECIFIED Unbekannt oder nicht angegeben.
AD_URL_TYPE_BEACON_IMPRESSION Ein 1‑×‑1-Tracking-Pixel, das angepingt wird, wenn eine Impression eines Creatives ausgeliefert wird.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Beacon für erweiterbare DCM-Impressionen. Bei der Auslieferung wird sie auf mehrere Beacons erweitert.
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 wird, wenn das Ereignis „skip“ ausgelöst wird.

Methoden

get

Ruft eine Anzeige in einer Anzeigengruppe ab.

list

Listet Anzeigen der Anzeigengruppe auf.