AdsApp.​ExcludedPlacementList

Page Summary

outlined_flag

• The content represents an excluded placement list which is a type of entity that can be identified by its type string as "ExcludedPlacementList", its ID, its name, and its resource name.

• You can add either a single URL or a list of URLs as excluded placements to the list using the addExcludedPlacement or addExcludedPlacements methods, respectively.

• You can retrieve selectors for the campaigns that the list has been applied to and the shared excluded placements within the list using the campaigns and excludedPlacements methods.

• The name of an excluded placement list can be retrieved using the getName method and set using the setName method.

Represents an excluded placement list.

Methods:

Member	Type	Description
addExcludedPlacement(url)	void	Adds a SharedExcludedPlacement to an excluded placement list.
addExcludedPlacements(urls)	void	Adds a list of SharedExcludedPlacement objects to an excluded placement list.
campaigns()	AdsApp.CampaignSelector	Returns a selector of all search and display campaigns this excluded placement list has been applied to.
excludedPlacements()	AdsApp.SharedExcludedPlacementSelector	Returns a selector of the shared excluded placements in an excluded placement list.
getEntityType()	String	Returns the type of this entity as a String , in this case, "ExcludedPlacementList" .
getId()	String	Returns the ID of the excluded placement list.
getName()	String	Returns the name of an excluded placement list.
getResourceName()	String	Returns the resource name of the excluded placement list.
setName(name)	void	Sets the name of an excluded placement list.

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:

Type	Description
AdsApp.SharedExcludedPlacementSelector	A selector of the shared excluded placements in an excluded placement list.

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.