AdsApp.ExcludedPlacementList
Stay organized with collections
Save and categorize content based on your preferences.
Represents an excluded placement list.
Methods:
addExcludedPlacement(url)
Adds a
SharedExcludedPlacement to
an excluded placement list.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| url |
String |
The excluded placement URL. |
addExcludedPlacements(urls)
Adds a list of
SharedExcludedPlacement
objects to an excluded placement list.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| urls |
String[] |
The excluded placement URL. |
campaigns()
Returns a selector of all search and display campaigns this excluded
placement list has been applied to.
Return values:
| Type | Description |
|---|
AdsApp.CampaignSelector |
A selector of all search and display campaigns this excluded
placement list has been applied to. |
excludedPlacements()
Returns a selector of the shared excluded placements in an excluded
placement list.
Return values:
getEntityType()
Returns the type of this entity as a
String, in this case,
"ExcludedPlacementList".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "ExcludedPlacementList". |
getId()
Returns the ID of the excluded placement list.
Return values:
| Type | Description |
|---|
String |
The ID of the excluded placement list. |
getName()
Returns the name of an excluded placement list.
Return values:
| Type | Description |
|---|
String |
The name of an excluded placement list. |
getResourceName()
Returns the resource name of the excluded placement list.
Return values:
| Type | Description |
|---|
String |
The resource name of the excluded placement list. |
setName(name)
Sets the name of an excluded placement list.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| name |
String |
The new name of the excluded placement list. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eRepresents a list of placements where ads will be excluded from showing.\u003c/p\u003e\n"],["\u003cp\u003eProvides methods to manage excluded placements such as adding, retrieving, and manipulating the list.\u003c/p\u003e\n"],["\u003cp\u003eAllows users to retrieve and set the name, ID and resource name of the exclusion list.\u003c/p\u003e\n"],["\u003cp\u003eEnables the retrieval of campaigns that utilize this excluded placement list and the specific placements being excluded.\u003c/p\u003e\n"]]],[],null,["# AdsApp.ExcludedPlacementList\n\nRepresents an excluded placement list.\n\n### Methods:\n\n| Member | Type | Description |\n|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [addExcludedPlacement(url)](#addExcludedPlacement_url) | `void` | Adds a [SharedExcludedPlacement](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacement) to an excluded placement list. |\n| [addExcludedPlacements(urls)](#addExcludedPlacements_urls) | `void` | Adds a list of [SharedExcludedPlacement](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacement) objects to an excluded placement list. |\n| [campaigns()](#campaigns) | [AdsApp.CampaignSelector](/google-ads/scripts/docs/reference/adsapp/adsapp_campaignselector) | Returns a selector of all search and display campaigns this excluded placement list has been applied to. |\n| [excludedPlacements()](#excludedPlacements) | [AdsApp.SharedExcludedPlacementSelector](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacementselector) | Returns a selector of the shared excluded placements in an excluded placement list. |\n| [getEntityType()](#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `\"ExcludedPlacementList\"`. |\n| [getId()](#getId) | `String` | Returns the ID of the excluded placement list. |\n| [getName()](#getName) | `String` | Returns the name of an excluded placement list. |\n| [getResourceName()](#getResourceName) | `String` | Returns the resource name of the excluded placement list. |\n| [setName(name)](#setName_name) | `void` | Sets the name of an excluded placement list. |\n\n`addExcludedPlacement(url)`\n---------------------------\n\nAdds a [SharedExcludedPlacement](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacement) to an excluded placement list.\n\nReturns nothing.\n\n### Arguments:\n\n| Name | Type | Description |\n|------|----------|-----------------------------|\n| url | `String` | The excluded placement URL. |\n\n`addExcludedPlacements(urls)`\n-----------------------------\n\nAdds a list of [SharedExcludedPlacement](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacement) objects to an excluded placement list.\n\nReturns nothing.\n\n### Arguments:\n\n| Name | Type | Description |\n|------|------------|-----------------------------|\n| urls | `String[]` | The excluded placement URL. |\n\n`campaigns()`\n-------------\n\nReturns a selector of all search and display campaigns this excluded placement list has been applied to.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| [AdsApp.CampaignSelector](/google-ads/scripts/docs/reference/adsapp/adsapp_campaignselector) | A selector of all search and display campaigns this excluded placement list has been applied to. |\n\n`excludedPlacements()`\n----------------------\n\nReturns a selector of the shared excluded placements in an excluded placement list.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|\n| [AdsApp.SharedExcludedPlacementSelector](/google-ads/scripts/docs/reference/adsapp/adsapp_sharedexcludedplacementselector) | A selector of the shared excluded placements in an excluded placement list. |\n\n`getEntityType()`\n-----------------\n\nReturns the type of this entity as a `String`, in this case, `\"ExcludedPlacementList\"`.\n\n### Return values:\n\n| Type | Description |\n|----------|-------------------------------------------------|\n| `String` | Type of this entity: `\"ExcludedPlacementList\"`. |\n\n`getId()`\n---------\n\nReturns the ID of the excluded placement list.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------------|\n| `String` | The ID of the excluded placement list. |\n\n`getName()`\n-----------\n\nReturns the name of an excluded placement list.\n\n### Return values:\n\n| Type | Description |\n|----------|-----------------------------------------|\n| `String` | The name of an excluded placement list. |\n\n`getResourceName()`\n-------------------\n\nReturns the resource name of the excluded placement list.\n\n### Return values:\n\n| Type | Description |\n|----------|---------------------------------------------------|\n| `String` | The resource name of the excluded placement list. |\n\n`setName(name)`\n---------------\n\nSets the name of an excluded placement list.\n\nReturns nothing.\n\n### Arguments:\n\n| Name | Type | Description |\n|------|----------|----------------------------------------------|\n| name | `String` | The new name of the excluded placement list. |"]]
