AdsApp.​VideoTopic

Represents a Google Ads Topic in a Video Campaign.

Methods:

MemberTypeDescription
bidding AdsApp.VideoTopicBidding Provides access to bidding fields of this video topic.
getEntityType String Returns the type of this entity as a String, in this case, "VideoTopic".
getId long Returns the ID of the video topic.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getTopicId Long Returns the topic ID of the topic.
getVideoAdGroup AdsApp.VideoAdGroup Returns the ad group to which this video topic belongs.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this video topic belongs.
isEnabled boolean Returns true if the video topic is enabled.
isPaused boolean Returns true if the video topic is paused.
remove void Removes the video topic.

bidding()

Provides access to bidding fields of this video topic.

Return values:

TypeDescription
AdsApp.VideoTopicBidding Access to bidding fields of this video topic.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoTopic".

getId()

Returns the ID of the video topic.

Return values:

TypeDescription
long The ID of the video topic.

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 = videoTopic.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.

getTopicId()

Returns the topic ID of the topic. The topic ID identifies the topic category. A list of valid topic IDs is available on our Verticals page.

Return values:

TypeDescription
Long The topic ID of the topic.

getVideoAdGroup()

Returns the ad group to which this video topic belongs.

Return values:

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

getVideoCampaign()

Returns the campaign to which this video topic belongs.

Return values:

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

isEnabled()

Returns true if the video topic is enabled.

Return values:

TypeDescription
boolean true if the video topic is enabled.

isPaused()

Returns true if the video topic is paused.

Return values:

TypeDescription
boolean true if the video topic is paused.

remove()

Removes the video topic.

Returns nothing.

Send feedback about...

Google Ads scripts
Google Ads scripts
Need help? Visit our support page.