AdsApp.​Topic

Represents a Google Ads topic.

Methods:

MemberTypeDescription
bidding AdsApp.TopicBidding Provides access to this topic's bidding fields.
getAdGroup AdsApp.AdGroup Returns the ad group to which this topic belongs.
getBaseAdGroup AdsApp.AdGroup Returns the base ad group to which this topic belongs.
getBaseCampaign AdsApp.Campaign Returns the base campaign to which this topic belongs.
getCampaign AdsApp.Campaign Returns the campaign to which this topic belongs.
getId long Returns the ID of the 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.
isEnabled boolean Returns true if the topic is enabled.
isPaused boolean Returns true if the topic is paused.
remove void Removes the topic.

bidding()

Provides access to this topic's bidding fields.

Return values:

TypeDescription
AdsApp.TopicBidding Access to this topic's bidding fields.

getAdGroup()

Returns the ad group to which this topic belongs.

Return values:

TypeDescription
AdsApp.AdGroup The ad group to which this topic belongs.

getBaseAdGroup()

Returns the base ad group to which this topic belongs.

Return values:

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

getBaseCampaign()

Returns the base campaign to which this topic belongs.

Return values:

TypeDescription
AdsApp.Campaign The base campaign to which this topic belongs.

getCampaign()

Returns the campaign to which this topic belongs.

Return values:

TypeDescription
AdsApp.Campaign The campaign to which this topic belongs.

getId()

Returns the ID of the topic.

Return values:

TypeDescription
long The ID of the 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 = topic.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.

isEnabled()

Returns true if the topic is enabled.

Return values:

TypeDescription
boolean true if the topic is enabled.

isPaused()

Returns true if the topic is paused.

Return values:

TypeDescription
boolean true if the topic is paused.

remove()

Removes the topic.

Returns nothing.

Send feedback about...

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