AdsApp.​VideoYouTubeVideo

Represents a Google Ads YouTube Video in a Video Campaign.

Methods:

MemberTypeDescription
bidding AdsApp.VideoCriterionBidding Provides access to bidding fields of this video YouTube video.
getEntityType String Returns the type of this entity as a String, in this case, "VideoYouTubeVideo".
getId String Returns the ID of the video YouTube video.
getResourceName String Returns the resource name of the video YouTube video.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getVideoAdGroup AdsApp.VideoAdGroup Returns the ad group to which this video YouTube video belongs.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this video YouTube video belongs.
getVideoId String Returns the YouTube video ID.
isEnabled boolean Returns true if the video YouTube video is enabled.
isManaged boolean Returns true if the YouTube video is managed.
isPaused boolean Returns true if the video YouTube video is paused.
remove void Removes the video YouTube video.

bidding()

Provides access to bidding fields of this video YouTube video.

Return values:

TypeDescription
AdsApp.VideoCriterionBidding Access to bidding fields of this video YouTube video.

getEntityType()

Returns the type of this entity as a String, in this case, "VideoYouTubeVideo".

Return values:

TypeDescription
String Type of this entity: "VideoYouTubeVideo".

getId()

Returns the ID of the video YouTube video.

Return values:

TypeDescription
String The ID of the video YouTube video.

getResourceName()

Returns the resource name of the video YouTube video.

Return values:

TypeDescription
String The resource name of the video YouTube video.

getStatsFor(dateRange)

Returns stats for the specified date range. Supported values:

TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Example:

var stats = youTubeVideo.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getStatsFor(dateFrom, dateTo)

Returns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD form. For instance, March 24th, 2013 is represented as either {year: 2013, month: 3, day: 24} or "20130324". The date range is inclusive on both ends, so forDateRange("20130324", "20130324") defines a range of a single day.

Arguments:

NameTypeDescription
dateFrom Object Start date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.
dateTo Object End date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.

Return values:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getVideoAdGroup()

Returns the ad group to which this video YouTube video belongs.

Return values:

TypeDescription
AdsApp.VideoAdGroup The ad group to which this video YouTube video belongs.

getVideoCampaign()

Returns the campaign to which this video YouTube video belongs.

Return values:

TypeDescription
AdsApp.VideoCampaign The campaign to which this video YouTube video belongs.

getVideoId()

Returns the YouTube video ID.

Return values:

TypeDescription
String The YouTube video ID.

isEnabled()

Returns true if the video YouTube video is enabled.

Return values:

TypeDescription
boolean true if the video YouTube video is enabled.

isManaged()

Returns true if the YouTube video is managed. Returns false if the placement is automatic.

Return values:

TypeDescription
boolean true if the YouTube video is managed.

isPaused()

Returns true if the video YouTube video is paused.

Return values:

TypeDescription
boolean true if the video YouTube video is paused.

remove()

Removes the video YouTube video.

Returns nothing.