AdsApp.​YouTubeVideo

Represents a Google Ads YouTube Video.

Methods:

MemberTypeDescription
bidding AdsApp.DisplayCriterionBidding Provides access to this YouTube video's bidding fields.
getAdGroup AdsApp.AdGroup Returns the ad group to which this YouTube video belongs.
getBaseAdGroup AdsApp.AdGroup Returns the base ad group to which this YouTube video belongs.
getBaseCampaign AdsApp.Campaign Returns the base campaign to which this YouTube video belongs.
getCampaign AdsApp.Campaign Returns the campaign to which this YouTube video belongs or null if it does not belong to a search or display campaign.
getEntityType String Returns the type of this entity as a String, in this case, "YouTubeVideo".
getId String Returns the ID of the YouTube video.
getResourceName String Returns the resource name of the YouTube video.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getVideoId String Returns the YouTube video ID.
isEnabled boolean Returns true if the YouTube video is enabled.
isManaged boolean This method is deprecated and will always return true.
isPaused boolean Returns true if the YouTube video is paused.
remove void Removes the YouTube video.

bidding()

Provides access to this YouTube video's bidding fields.

Return values:

TypeDescription
AdsApp.DisplayCriterionBidding Access to this YouTube video's bidding fields.

getAdGroup()

Returns the ad group to which this YouTube video belongs.

Return values:

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

getBaseAdGroup()

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

Return values:

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

getBaseCampaign()

Returns the base campaign to which this YouTube video belongs.

Return values:

TypeDescription
AdsApp.Campaign The base campaign to which this YouTube video belongs.

getCampaign()

Returns the campaign to which this YouTube video belongs or null if it does not belong to a search or display campaign.

Return values:

TypeDescription
AdsApp.Campaign The campaign to which this YouTube video belongs or null if it does not belong to a search or display campaign.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "YouTubeVideo".

getId()

Returns the ID of the YouTube video.

Return values:

TypeDescription
String The ID of the YouTube video.

getResourceName()

Returns the resource name of the YouTube video.

Return values:

TypeDescription
String The resource name of the 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.

getVideoId()

Returns the YouTube video ID.

Return values:

TypeDescription
String The YouTube video ID.

isEnabled()

Returns true if the YouTube video is enabled.

Return values:

TypeDescription
boolean true if the YouTube video is enabled.

isManaged()

This method is deprecated and will always return true. All YouTube videos returned by a YouTubeVideoIterator are managed.

Return values:

TypeDescription
boolean true.

isPaused()

Returns true if the YouTube video is paused.

Return values:

TypeDescription
boolean true if the YouTube video is paused.

remove()

Removes the YouTube video.

Returns nothing.