AdsApp.​Topic

Page Summary

• This Google Ads topic provides access to various methods for managing bidding, retrieving associated ad groups and campaigns, and checking its status.

• You can retrieve the topic's unique ID, resource name, and specific topic ID for category identification.

• The topic allows you to get performance statistics for predefined or custom date ranges.

• You can determine if the topic is currently enabled or paused using dedicated methods.

• There is a method available to remove the topic.

Represents a Google Ads topic.

Methods:

Member	Type	Description
bidding()	AdsApp.DisplayCriterionBidding	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 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, "Topic".
getId()	String	Returns the ID of the topic.
getResourceName()	String	Returns the resource name of the topic.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getTopicId()	String	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:

Type	Description
AdsApp.DisplayCriterionBidding	Access to this topic's bidding fields.

getAdGroup()

Returns the ad group to which this topic belongs.

Return values:

Type	Description
AdsApp.AdGroup	The ad group to which this topic belongs.

getBaseAdGroup()

Returns the base ad group to which this topic belongs.

Return values:

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

getBaseCampaign()

Returns the base campaign to which this topic belongs.

Return values:

Type	Description
AdsApp.Campaign	The base campaign to which this topic belongs.

getCampaign()

Returns the campaign to which this topic 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 topic 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, "Topic".

Return values:

Type	Description
String	Type of this entity: "Topic".

getId()

Returns the ID of the topic.

Return values:

Type	Description
String	The ID of the topic.

getResourceName()

Returns the resource name of the topic.

Return values:

Type	Description
String	The resource name 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:

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.

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:

Type	Description
String	The topic ID of the topic.

isEnabled()

Returns true if the topic is enabled.

Return values:

Type	Description
boolean	true if the topic is enabled.

isPaused()

Returns true if the topic is paused.

Return values:

Type	Description
boolean	true if the topic is paused.

remove()

Removes the topic.

Returns nothing.