AdsApp.​ExcludedAudience

Represents a Google Ads excluded audience.

Methods:

MemberTypeDescription
getAdGroupAdsApp.AdGroupReturns the ad group to which this excluded audience belongs.
getAudienceIdStringReturns the audience ID of the excluded audience.
getAudienceTypeStringReturns the type of the excluded audience, either USER_INTEREST or USER_LIST.
getBaseAdGroupAdsApp.AdGroupReturns the base ad group to which this excluded audience belongs.
getBaseCampaignAdsApp.CampaignReturns the base campaign to which this excluded audience belongs.
getCampaignAdsApp.CampaignReturns the campaign to which this excluded audience belongs or null if it does not belong to a search or display campaign.
getIdStringReturns the ID of the excluded audience.
getResourceNameStringReturns the resource name of the excluded audience.
removevoidRemoves the excluded audience.

getAdGroup()

Returns the ad group to which this excluded audience belongs.

Return values:

TypeDescription
AdsApp.AdGroupThe ad group to which this excluded audience belongs.

getAudienceId()

Returns the audience ID of the excluded audience.

Return values:

TypeDescription
StringThe audience ID of the excluded audience.

getAudienceType()

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

Return values:

TypeDescription
StringThe type of the excluded audience.

getBaseAdGroup()

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

Return values:

TypeDescription
AdsApp.AdGroupThe base ad group to which this excluded audience belongs.

getBaseCampaign()

Returns the base campaign to which this excluded audience belongs.

Return values:

TypeDescription
AdsApp.CampaignThe 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:

TypeDescription
AdsApp.CampaignThe 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:

TypeDescription
StringThe ID of the excluded audience.

getResourceName()

Returns the resource name of the excluded audience.

Return values:

TypeDescription
StringThe resource name of the excluded audience.

remove()

Removes the excluded audience.

Returns nothing.