Represents a Google Ads YouTube Channel.
Methods:
bidding()
Provides access to this YouTube channel's bidding fields.
Return values:
getAdGroup()
Returns the ad group to which this YouTube channel belongs.
Return values:
Type | Description |
AdsApp.AdGroup |
The ad group to which this YouTube channel belongs. |
getBaseAdGroup()
Returns the base ad group to which this [description.entityName] belongs.
Return values:
Type | Description |
AdsApp.AdGroup |
The base ad group to which this [description.entityName] belongs. |
getBaseCampaign()
Returns the base campaign to which this [description.entityName] belongs.
Return values:
Type | Description |
AdsApp.Campaign |
The base campaign to which this [description.entityName] belongs. |
getCampaign()
Returns the campaign to which this YouTube channel belongs or
null
if it does
not belong to a search or display campaign.
Return values:
Type | Description |
AdsApp.Campaign |
The campaign to which this YouTube channel belongs or null if it does
not belong to a search or display campaign. |
getChannelId()
Returns the YouTube channel ID.
Return values:
Type | Description |
String |
The YouTube channel ID. |
getEntityType()
Returns the type of this entity as a
String
, in this case,
"YouTubeChannel"
.
Return values:
Type | Description |
String |
Type of this entity: "YouTubeChannel" . |
getId()
Returns the ID of the YouTube channel.
Return values:
Type | Description |
long |
The ID of the 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:
Name | Type | Description |
dateRange |
String |
Date range for which the stats are requested. |
Return values:
Type | Description |
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:
Name | Type | Description |
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:
Type | Description |
AdsApp.Stats |
The stats for the specified date range. |
isEnabled()
Returns
true
if the YouTube channel is enabled.
Return values:
Type | Description |
boolean |
true if the YouTube channel is enabled. |
isManaged()
Returns
true
if the YouTube channel is managed. Returns
false
if the placement
is automatic.
Return values:
Type | Description |
boolean |
true if the YouTube channel is managed. |
isPaused()
Returns
true
if the YouTube channel is paused.
Return values:
Type | Description |
boolean |
true if the YouTube channel is paused. |
remove()
Removes the YouTube channel.
Returns nothing.