AdsApp.​VideoYouTubeChannel

Represents a Google Ads YouTube Channel in a Video Campaign.

Methods:

MemberTypeDescription
bidding AdsApp.VideoCriterionBidding Provides access to bidding fields of this video YouTube channel.
getChannelId String Returns the YouTube channel ID.
getEntityType String Returns the type of this entity as a String, in this case, "VideoYouTubeChannel".
getId String Returns the ID of the video YouTube channel.
getResourceName String Returns the resource name of the video YouTube channel.
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 channel belongs.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this video YouTube channel belongs.
isEnabled boolean Returns true if the video YouTube channel is enabled.
isManaged boolean Returns true if the YouTube channel is managed.
isPaused boolean Returns true if the video YouTube channel is paused.
remove void Removes the video YouTube channel.

bidding()

Provides access to bidding fields of this video YouTube channel.

Return values:

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

getChannelId()

Returns the YouTube channel ID.

Return values:

TypeDescription
String The YouTube channel ID.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoYouTubeChannel".

getId()

Returns the ID of the video YouTube channel.

Return values:

TypeDescription
String The ID of the video YouTube channel.

getResourceName()

Returns the resource name of the video YouTube channel.

Return values:

TypeDescription
String The resource name of the video YouTube channel.

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 = youTubeChannel.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 channel belongs.

Return values:

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

getVideoCampaign()

Returns the campaign to which this video YouTube channel belongs.

Return values:

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

isEnabled()

Returns true if the video YouTube channel is enabled.

Return values:

TypeDescription
boolean true if the video YouTube channel is enabled.

isManaged()

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

Return values:

TypeDescription
boolean true if the YouTube channel is managed.

isPaused()

Returns true if the video YouTube channel is paused.

Return values:

TypeDescription
boolean true if the video YouTube channel is paused.

remove()

Removes the video YouTube channel.

Returns nothing.