Edit

Share via

ExcludedLocation

  • Article

Contains the methods for managing location exclusions. For information about location criteria, see Show ads to your target audience and Geographical Location Codes.

Methods

Method Name Return Type Description
getAdGroup AdGroup Gets the ad group that this excluded location belongs to.
getCampaign Campaign Gets the campaign that this excluded location belongs to.
getCampaignType string Gets the type of campaign that this excluded location belongs to.
getCountryCode string Gets the country code of this excluded location.
getEntityType string Gets this entity's type.
getId string Gets the ID that uniquely identifies this excluded location.
getName string Gets this excluded location's name.
getTargetType string Gets the target type of this excluded location.
getTargetingStatus string Gets the targeting status of this excluded location.
remove void Removes the excluded location.

getAdGroup

Gets the ad group that this excluded location belongs to.

Note

This method is not supported with campaign level excluded locations.

Returns

Type Description
AdGroup The ad group that this excluded location belongs to.

getCampaign

Gets the campaign that this excluded location belongs to.

Returns

Type Description
Campaign The campaign that this excluded location belongs to.

getCampaignType

Gets the type of campaign that this excluded location belongs to.

Possible values include Audience, DynamicSearchAds, Search, and Shopping.

Returns

Type Description
string The type of campaign that this excluded location belongs to.

getCountryCode

Gets the country code of this excluded location.

Returns

Type Description
string The country code of this excluded location.

getEntityType

Returns this entity's type.

Returns

Type Description
string This entity's type, which is ExcludedLocation.

getId

Gets the ID that uniquely identifies this excluded location.

Returns

Type Description
string The ID that uniquely identifies this excluded location.

Location IDs can be shared across campaigns and ad groups. Use the entity ID (campaign or ad group) as well as the location ID to uniquely identify an excluded location.

getName

Gets this excluded location's name.

Returns

Type Description
string The name of this excluded location.

getTargetType

Gets the target type of this excluded location.

Returns

Type Description
string The target type of this excluded location.

getTargetingStatus

Gets the targeting status of this excluded location.

Returns

Type Description
string The targeting status of this excluded location.

remove

Removes this excluded location.

Returns

Type Description
void Returns nothing.