AdsApp.​ExcludedAudience

AI-generated Key Takeaways

• Represents an excluded audience in Google Ads, allowing advertisers to prevent specific groups of users from seeing their ads.

• Provides methods to access information like the audience ID, type (USER_INTEREST or USER_LIST), and the associated ad group or campaign.

• Enables retrieval of the base ad group and campaign to which the excluded audience is linked.

• Offers functionality to remove the excluded audience, effectively ending the exclusion.

• Includes methods to get the resource name and ID of the excluded audience for management purposes.

Represents a Google Ads excluded audience.

Methods:

Member	Type	Description
getAdGroup()	AdsApp.AdGroup	Returns the ad group to which this excluded audience belongs.
getAudienceId()	String	Returns the audience ID of the excluded audience.
getAudienceType()	String	Returns the type of the excluded audience, either USER_INTEREST or USER_LIST.
getBaseAdGroup()	AdsApp.AdGroup	Returns the base ad group to which this excluded audience belongs.
getBaseCampaign()	AdsApp.Campaign	Returns the base campaign to which this excluded audience belongs.
getCampaign()	AdsApp.Campaign	Returns the campaign to which this excluded audience belongs or null if it does not belong to a search or display campaign.
getId()	String	Returns the ID of the excluded audience.
getResourceName()	String	Returns the resource name of the excluded audience.
remove()	void	Removes the excluded audience.

getAdGroup()

Returns the ad group to which this excluded audience belongs.

Return values:

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

getAudienceId()

Returns the audience ID of the excluded audience.

Return values:

Type	Description
String	The audience ID of the excluded audience.

getAudienceType()

Returns the type of the excluded audience, either USER_INTEREST or USER_LIST.

Return values:

Type	Description
String	The type of the excluded audience.

getBaseAdGroup()

Returns the base ad group to which this excluded audience belongs.

Return values:

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

getBaseCampaign()

Returns the base campaign to which this excluded audience belongs.

Return values:

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

getCampaign()

Returns the campaign to which this excluded audience 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 excluded audience belongs or null if it does not belong to a search or display campaign.

getId()

Returns the ID of the excluded audience.

Return values:

Type	Description
String	The ID of the excluded audience.

getResourceName()

Returns the resource name of the excluded audience.

Return values:

Type	Description
String	The resource name of the excluded audience.

remove()

Removes the excluded audience.

Returns nothing.