Represents a Google Ads excluded location.

Excluded locations are used to restrict your ads from showing in specific
geographic areas. For instance, a campaign could show ads in all parts of a
country except for a specific city by having a [TargetedLocation](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_targetedlocation) for the entire
country and an [ExcludedLocation](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation)
for that specific city.

For more information on locations, see the [API documentation on
geotargeting](https://developers.google.com/google-ads/api/reference/data/geotargets).

See also [TargetedLocation](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_targetedlocation).

### Methods:

| Member | Type | Description |
|---|---|---|
| [getBaseCampaign()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getBaseCampaign) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_campaign` | Returns the base campaign to which this excluded location belongs. |
| [getCampaign()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getCampaign) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_campaign` | Returns the campaign to which this excluded location belongs or `null` if it does not belong to a search or display campaign. |
| [getCampaignType()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getCampaignType) | `String` | Returns the campaign type. |
| [getCountryCode()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getCountryCode) | `String` | Returns the country code of this location. |
| [getEntityType()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `"ExcludedLocation"`. |
| [getId()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getId) | `String` | Returns the ID of the excluded location. |
| [getName()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getName) | `String` | Returns the name of this location. |
| [getResourceName()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getResourceName) | `String` | Returns the resource name of the excluded location. |
| [getShoppingCampaign()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getShoppingCampaign) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingcampaign` | Returns the shopping campaign to which this excluded location belongs or `null` if it does not belong to a shopping campaign. |
| [getTargetType()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getTargetType) | `String` | Returns the target type of this location. |
| [getTargetingStatus()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getTargetingStatus) | `String` | Returns the targeting status of this location. |
| [getVideoCampaign()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#getVideoCampaign) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign` | Returns the video campaign to which this excluded location belongs or `null` if it does not belong to a video campaign. |
| [remove()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation#remove) | `void` | Removes the excluded location. |

## `getBaseCampaign()`

Returns the base campaign to which this excluded location belongs.

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_campaign` | The base campaign to which this excluded location belongs. |

## `getCampaign()`

Returns the campaign to which this excluded location belongs or `null` if it does not belong to a search or display campaign.

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_campaign` | The campaign to which this excluded location belongs or `null` if it does not belong to a search or display campaign. |

## `getCampaignType()`

Returns the campaign type. Possible return values:

`SEARCH_OR_DISPLAY, VIDEO, SHOPPING`

### Return values:

| Type | Description |
|---|---|
| `String` | Video campaign type. |

## `getCountryCode()`

Returns the country code of this location.

This is the standard two-letter country code, e.g. `"US"` or
`"BR"`.

### Return values:

| Type | Description |
|---|---|
| `String` | The country code of this location. |

## `getEntityType()`

Returns the type of this entity as a `String`, in this case, `"ExcludedLocation"`.

### Return values:

| Type | Description |
|---|---|
| `String` | Type of this entity: `"ExcludedLocation"`. |

## `getId()`

Returns the ID of the excluded location.

Location IDs are shared across campaigns. In order to uniquely identify
a location exclusion, one must specify both its campaign ID and the
location ID.

### Return values:

| Type | Description |
|---|---|
| `String` | The ID of the excluded location. |

## `getName()`

Returns the name of this location.

### Return values:

| Type | Description |
|---|---|
| `String` | The name of this location. |

## `getResourceName()`

Returns the resource name of the excluded location.

### Return values:

| Type | Description |
|---|---|
| `String` | The resource name of the excluded location. |

## `getShoppingCampaign()`

Returns the shopping campaign to which this excluded location belongs or `null` if it does not belong to a shopping campaign.

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_shoppingcampaign` | The shopping campaign to which this excluded location belongs or `null` if it does not belong to a shopping campaign. |

## `getTargetType()`

Returns the target type of this location.

The target type is a generic description of the location, such as
`"City"`, `"Postal Code"`, or `"Country"`.
For a full list of target types, see [Geo targets](https://developers.google.com/google-ads/api/reference/data/geotargets).

### Return values:

| Type | Description |
|---|---|
| `String` | The target type of this location. |

## `getTargetingStatus()`

Returns the targeting status of this location.

This can return one of three values:

- `"ACTIVE"`: indicates that the location can be targeted as normal. The vast majority of locations are active.
- `"PHASING_OUT"`: indicates that the location can be targeted, but that support will soon be removed. To get a list of which locations are phasing out, see [Geo targets](https://developers.google.com/google-ads/api/reference/data/geotargets).
- `"OBSOLETE"`: indicates that the location cannot be targeted.

### Return values:

| Type | Description |
|---|---|
| `String` | The targeting status of this location. |

## `getVideoCampaign()`

Returns the video campaign to which this excluded location belongs or `null` if it does not belong to a video campaign.

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign` | The video campaign to which this excluded location belongs or `null` if it does not belong to a video campaign. |

## `remove()`

Removes the excluded location.

Returns nothing.