REST Resource: advertisers.youtubeAdGroupAds

{
  "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.
}

string

The resource name of the ad.

string (int64 format)

The unique ID of the advertiser the ad belongs to.

string (int64 format)

The unique ID of the ad. Assigned by the system.

string (int64 format)

The unique ID of the ad group that the ad belongs to.

string

The display name of the ad.

Must be UTF-8 encoded with a maximum size of 255 bytes.

enum (EntityStatus)

The entity status of the ad.

object (AdUrl)

List of URLs used by the ad.

object (DisplayVideoSourceAd)

Details of an ad sourced from a Display & Video 360 creative.

object (MastheadAd)

Details of an ad served on the YouTube Home feed.

object (InStreamAd)

Details of an in-stream ad skippable after 5 seconds, used for brand awareness or reach marketing objectives.

object (NonSkippableAd)

Details of a non-skippable short in-stream video ad, between 6 and 15 seconds, used for reach marketing objectives.

object (BumperAd)

Details of a non-skippable short video ad, equal to or less than 6 seconds, used for reach.

object (AudioAd)

Details of an audio ad used for reach marketing objectives.

object (VideoDiscoveryAd)

Details of an ad promoting a video that shows in places of discovery.

object (VideoPerformanceAd)

Details of an ad used in a video action campaign to drive actions to the business, service or product.

{
  "creativeId": string
}

string (int64 format)

The ID of the source creative.

{
  "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)
    }
  ]
}

object (YoutubeVideoDetails)

The YouTube video used by the ad.

string

The headline of the ad.

string

The description of the ad.

enum (VideoAspectRatio)

The aspect ratio of the autoplaying YouTube video on the Masthead.

string (int64 format)

The amount of time in milliseconds after which the video will start to play.

string (Duration format)

The duration of time the video will autoplay.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

string

The text on the call-to-action button.

string

The destination URL for the call-to-action button.

string

The tracking URL for the call-to-action button.

boolean

Whether to show a background or banner that appears at the top of a YouTube page.

object (YoutubeVideoDetails)

The videos that appear next to the Masthead Ad on desktop. Can be no more than two.

{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}

string

The YouTube video ID which can be searched on YouTube webpage.

enum (VideoUnavailableReason)

The reason why the video data is not available.

{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}

object (CommonInStreamAttribute)

Common ad attributes.

map (key: string, value: string)

The custom parameters to pass custom values to tracking URL template.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

string

The webpage address that appears with the ad.

string

The URL address of the webpage that people reach after they click the ad.

string

The URL address loaded in the background for tracking purposes.

string

The text on the call-to-action button.

string

The headline of the call-to-action banner.

object (YoutubeVideoDetails)

The YouTube video of the ad.

object (ImageAsset)

The image which shows next to the video ad.

{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}

string

MIME type of the image asset.

object (Dimensions)

Metadata for this image at its original size.

string (int64 format)

File size of the image asset in bytes.

{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}

object (CommonInStreamAttribute)

Common ad attributes.

map (key: string, value: string)

The custom parameters to pass custom values to tracking URL template.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}

object (CommonInStreamAttribute)

Common ad attributes.

{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}

string

The webpage address that appears with the ad.

string

The URL address of the webpage that people reach after they click the ad.

string

The URL address loaded in the background for tracking purposes.

object (YoutubeVideoDetails)

The YouTube video of the ad.

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

string

The headline of ad.

string

First text line for the ad.

string

Second text line for the ad.

object (YoutubeVideoDetails)

The YouTube video the ad promotes.

enum (Thumbnail)

Thumbnail image used in the ad.

{
  "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)
    }
  ]
}

string

The URL address of the webpage that people reach after they click the ad.

string

The URL address loaded in the background for tracking purposes.

string

The list of text assets shown on the call-to-action button.

string

The list of headlines shown on the call-to-action banner.

string

The list of lone headlines shown on the call-to-action banner.

string

The list of descriptions shown on the call-to-action banner.

string

The first piece after the domain in the display URL.

string

The second piece after the domain in the display URL.

string

The domain of the display URL.

object (YoutubeVideoDetails)

The list of YouTube video assets used by this ad.

map (key: string, value: string)

The custom parameters to pass custom values to tracking URL template.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (ImageAsset)

The list of companion banners used by this ad.

{
  "type": enum (AdUrlType),
  "url": string
}

enum (AdUrlType)

The type of the Ad URL.

string

The URL string value.