- Resource: AdGroupAd
- DisplayVideoSourceAd
- MastheadAd
- YoutubeVideoDetails
- VideoUnavailableReason
- VideoAspectRatio
- InStreamAd
- CommonInStreamAttribute
- ImageAsset
- NonSkippableAd
- BumperAd
- AudioAd
- VideoDiscoveryAd
- Thumbnail
- VideoPerformanceAd
- AdUrl
- AdUrlType
- Methods
Resource: AdGroupAd
A single ad associated with an ad group.
JSON representation |
---|
{ "name": string, "advertiserId": string, "adGroupAdId": string, "adGroupId": string, "displayName": string, "entityStatus": enum ( |
Fields | |
---|---|
name |
The resource name of the ad. |
advertiserId |
The unique ID of the advertiser the ad belongs to. |
adGroupAdId |
The unique ID of the ad. Assigned by the system. |
adGroupId |
The unique ID of the ad group that the ad belongs to. |
displayName |
The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. |
entityStatus |
The entity status of the ad. |
adUrls[] |
List of URLs used by the ad. |
Union field ad_details . The details of the ad. ad_details can be only one of the following: |
|
displayVideoSourceAd |
Details of an ad sourced from a Display & Video 360 creative. |
mastheadAd |
Details of an ad served on the YouTube Home feed. |
inStreamAd |
Details of an in-stream ad skippable after 5 seconds, used for brand awareness or reach marketing objectives. |
nonSkippableAd |
Details of a non-skippable short in-stream video ad, between 6 and 15 seconds, used for reach marketing objectives. |
bumperAd |
Details of a non-skippable short video ad, equal to or less than 6 seconds, used for reach. |
audioAd |
Details of an audio ad used for reach marketing objectives. |
videoDiscoverAd |
Details of an ad promoting a video that shows in places of discovery. |
videoPerformanceAd |
Details of an ad used in a video action campaign to drive actions to the business, service or product. |
DisplayVideoSourceAd
The ad sourced from a DV360 creative.
JSON representation |
---|
{ "creativeId": string } |
Fields | |
---|---|
creativeId |
The ID of the source creative. |
MastheadAd
Details for a Masthead Ad.
JSON representation |
---|
{ "video": { object ( |
Fields | |
---|---|
video |
The YouTube video used by the ad. |
headline |
The headline of the ad. |
description |
The description of the ad. |
videoAspectRatio |
The aspect ratio of the autoplaying YouTube video on the Masthead. |
autoplayVideoStartMillisecond |
The amount of time in milliseconds after which the video will start to play. |
autoplayVideoDuration |
The duration of time the video will autoplay. A duration in seconds with up to nine fractional digits, ending with ' |
callToActionButtonLabel |
The text on the call-to-action button. |
callToActionFinalUrl |
The destination URL for the call-to-action button. |
callToActionTrackingUrl |
The tracking URL for the call-to-action button. |
showChannelArt |
Whether to show a background or banner that appears at the top of a YouTube page. |
companionYoutubeVideos[] |
The videos that appear next to the Masthead Ad on desktop. Can be no more than two. |
YoutubeVideoDetails
Details of a YouTube video.
JSON representation |
---|
{
"id": string,
"unavailableReason": enum ( |
Fields | |
---|---|
id |
The YouTube video ID which can be searched on YouTube webpage. |
unavailableReason |
The reason why the video data is not available. |
VideoAspectRatio
Possible aspect ratios for a YouTube video.
Enums | |
---|---|
VIDEO_ASPECT_RATIO_UNSPECIFIED |
Not specified or unknown. |
VIDEO_ASPECT_RATIO_WIDESCREEN |
The video is stretched and the top and bottom are cropped. |
VIDEO_ASPECT_RATIO_FIXED_16_9 |
The video uses a fixed 16:9 aspect ratio. |
InStreamAd
Details for an in-stream ad.
JSON representation |
---|
{
"commonInStreamAttribute": {
object ( |
Fields | |
---|---|
commonInStreamAttribute |
Common ad attributes. |
customParameters |
The custom parameters to pass custom values to tracking URL template. An object containing a list of |
CommonInStreamAttribute
Common attributes for in-stream, non-skippable and bumper ads.
JSON representation |
---|
{ "displayUrl": string, "finalUrl": string, "trackingUrl": string, "actionButtonLabel": string, "actionHeadline": string, "video": { object ( |
Fields | |
---|---|
displayUrl |
The webpage address that appears with the ad. |
finalUrl |
The URL address of the webpage that people reach after they click the ad. |
trackingUrl |
The URL address loaded in the background for tracking purposes. |
actionButtonLabel |
The text on the call-to-action button. |
actionHeadline |
The headline of the call-to-action banner. |
video |
The YouTube video of the ad. |
companionBanner |
The image which shows next to the video ad. |
ImageAsset
Meta data of an image asset.
JSON representation |
---|
{
"mimeType": string,
"fullSize": {
object ( |
Fields | |
---|---|
mimeType |
MIME type of the image asset. |
fullSize |
Metadata for this image at its original size. |
fileSize |
File size of the image asset in bytes. |
NonSkippableAd
Details for a non-skippable ad.
JSON representation |
---|
{
"commonInStreamAttribute": {
object ( |
Fields | |
---|---|
commonInStreamAttribute |
Common ad attributes. |
customParameters |
The custom parameters to pass custom values to tracking URL template. An object containing a list of |
BumperAd
Details for a bumper ad.
JSON representation |
---|
{
"commonInStreamAttribute": {
object ( |
Fields | |
---|---|
commonInStreamAttribute |
Common ad attributes. |
AudioAd
Details for an audio ad.
JSON representation |
---|
{
"displayUrl": string,
"finalUrl": string,
"trackingUrl": string,
"video": {
object ( |
Fields | |
---|---|
displayUrl |
The webpage address that appears with the ad. |
finalUrl |
The URL address of the webpage that people reach after they click the ad. |
trackingUrl |
The URL address loaded in the background for tracking purposes. |
video |
The YouTube video of the ad. |
VideoDiscoveryAd
Details for a video discovery ad.
JSON representation |
---|
{ "headline": string, "description1": string, "description2": string, "video": { object ( |
Fields | |
---|---|
headline |
The headline of ad. |
description1 |
First text line for the ad. |
description2 |
Second text line for the ad. |
video |
The YouTube video the ad promotes. |
thumbnail |
Thumbnail image used in the ad. |
Thumbnail
Possible thumbnail options in Video Discovery Ads.
Enums | |
---|---|
THUMBNAIL_UNSPECIFIED |
Unknown or unspecified. |
THUMBNAIL_DEFAULT |
The default thumbnail, can be auto-generated or user-uploaded. |
THUMBNAIL_1 |
Thumbnail 1, generated from the video. |
THUMBNAIL_2 |
Thumbnail 2, generated from the video. |
THUMBNAIL_3 |
Thumbnail 3, generated from the video. |
VideoPerformanceAd
Details for a video performance ad.
JSON representation |
---|
{ "finalUrl": string, "trackingUrl": string, "actionButtonLabels": [ string ], "headlines": [ string ], "longHeadlines": [ string ], "descriptions": [ string ], "displayUrlBreadcrumb1": string, "displayUrlBreadcrumb2": string, "domain": string, "videos": [ { object ( |
Fields | |
---|---|
finalUrl |
The URL address of the webpage that people reach after they click the ad. |
trackingUrl |
The URL address loaded in the background for tracking purposes. |
actionButtonLabels[] |
The list of text assets shown on the call-to-action button. |
headlines[] |
The list of headlines shown on the call-to-action banner. |
longHeadlines[] |
The list of lone headlines shown on the call-to-action banner. |
descriptions[] |
The list of descriptions shown on the call-to-action banner. |
displayUrlBreadcrumb1 |
The first piece after the domain in the display URL. |
displayUrlBreadcrumb2 |
The second piece after the domain in the display URL. |
domain |
The domain of the display URL. |
videos[] |
The list of YouTube video assets used by this ad. |
customParameters |
The custom parameters to pass custom values to tracking URL template. An object containing a list of |
companionBanners[] |
The list of companion banners used by this ad. |
AdUrl
Additional URLs related to the ad, including beacons.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The type of the Ad URL. |
url |
The URL string value. |
AdUrlType
Possible ad URL types.
Enums | |
---|---|
AD_URL_TYPE_UNSPECIFIED |
Unknown or unspecified. |
AD_URL_TYPE_BEACON_IMPRESSION |
A 1x1 tracking pixel to ping when an impression of a creative is delivered. |
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION |
Expandable DCM impression beacon. At serving time, it is expanded to several beacons. |
AD_URL_TYPE_BEACON_CLICK |
Tracking URL to ping when the click event is triggered. |
AD_URL_TYPE_BEACON_SKIP |
Tracking URL to ping when the skip event is triggered. |
Methods |
|
---|---|
|
Gets an ad group ad. |
|
Lists ad group ads. |