AdsApp.​CampaignDisplay

AI-generated Key Takeaways

outlined_flag

• The content provides access to aggregated ad group-level display criteria and campaign-level excluded display criteria for a campaign.

• The keywords() method returns the selector of all display keywords across all ad groups in the campaign.

• Various methods are available to return selectors for audiences, excluded audiences, excluded keywords, excluded placements, excluded topics, excluded YouTube channels, and excluded YouTube videos at the campaign level.

• Builder methods like newAudienceBuilder() and newKeywordBuilder() allow for creating new excluded criteria at the campaign level.

• Methods such as placements(), topics(), youTubeChannels(), and youTubeVideos() return selectors for their respective criteria across all ad groups in the campaign.

Access to aggregated ad group-level display criteria for a campaign and campaign-level excluded display criteria for a campaign. For example, to access all display keywords in all ad groups in this campaign:

var displayKeywordIterator = campaign.display().keywords().get();
while (displayKeywordIterator.hasNext()) {
  var displayKeyword = displayKeywordIterator.next();
}

Methods:

Member	Type	Description
audiences()	AdsApp.AudienceSelector	Returns the selector of all audiences in the campaign.
excludedAudiences()	AdsApp.ExcludedAudienceSelector	Returns the selector of all excluded audiences in the campaign.
excludedKeywords()	AdsApp.ExcludedDisplayKeywordSelector	Returns the selector of all excluded display keywords in the campaign.
excludedPlacements()	AdsApp.ExcludedPlacementSelector	Returns the selector of all excluded website placements in the campaign.
excludedTopics()	AdsApp.ExcludedTopicSelector	Returns the selector of all excluded topics in the campaign.
excludedYouTubeChannels()	AdsApp.ExcludedYouTubeChannelSelector	Returns the selector of all excluded YouTube channels in the campaign.
excludedYouTubeVideos()	AdsApp.ExcludedYouTubeVideoSelector	Returns the selector of all excluded YouTube videos in the campaign.
keywords()	AdsApp.DisplayKeywordSelector	Returns the selector of all display keywords in all ad groups in the campaign.
newAudienceBuilder()	AdsApp.AudienceBuilder	Returns a new audience builder for this campaign.
newKeywordBuilder()	AdsApp.DisplayKeywordBuilder	Returns a new display keyword builder for this campaign.
newPlacementBuilder()	AdsApp.PlacementBuilder	Returns a new placement builder for this campaign.
newTopicBuilder()	AdsApp.TopicBuilder	Returns a new topic builder for this campaign.
newYouTubeChannelBuilder()	AdsApp.YouTubeChannelBuilder	Returns a new YouTube channel builder for this campaign.
newYouTubeVideoBuilder()	AdsApp.YouTubeVideoBuilder	Returns a new YouTube video builder for this campaign.
placements()	AdsApp.PlacementSelector	Returns the selector of all website placements in all ad groups in the campaign.
topics()	AdsApp.TopicSelector	Returns the selector of all topics in all ad groups in the campaign.
youTubeChannels()	AdsApp.YouTubeChannelSelector	Returns the selector of all YouTube channels in the campaign.
youTubeVideos()	AdsApp.YouTubeVideoSelector	Returns the selector of all YouTube videos in the campaign.

audiences()

Returns the selector of all audiences in the campaign.

Return values:

Type	Description
AdsApp.AudienceSelector	The selector of all audiences in the campaign.

excludedAudiences()

Returns the selector of all excluded audiences in the campaign.

Return values:

Type	Description
AdsApp.ExcludedAudienceSelector	The selector of all excluded audiences in the campaign.

excludedKeywords()

Returns the selector of all excluded display keywords in the campaign.

Return values:

Type	Description
AdsApp.ExcludedDisplayKeywordSelector	The selector of all excluded display keywords in the campaign.

excludedPlacements()

Returns the selector of all excluded website placements in the campaign. Mobile app placements and mobile app category placements are not supported.

Return values:

Type	Description
AdsApp.ExcludedPlacementSelector	The selector of all website excluded placements in the campaign.

excludedTopics()

Returns the selector of all excluded topics in the campaign.

Return values:

Type	Description
AdsApp.ExcludedTopicSelector	The selector of all excluded topics in the campaign.

excludedYouTubeChannels()

Returns the selector of all excluded YouTube channels in the campaign.

Return values:

Type	Description
AdsApp.ExcludedYouTubeChannelSelector	The selector of all excluded YouTube channels in the campaign.

excludedYouTubeVideos()

Returns the selector of all excluded YouTube videos in the campaign.

Return values:

Type	Description
AdsApp.ExcludedYouTubeVideoSelector	The selector of all excluded YouTube videos in the campaign.

keywords()

Returns the selector of all display keywords in all ad groups in the campaign.

Return values:

Type	Description
AdsApp.DisplayKeywordSelector	The selector of all display keywords in all ad groups in the campaign.

newAudienceBuilder()

Returns a new audience builder for this campaign. Only excluded audiences can be created at the campaign level. When AudienceBuilder.exclude() is called, an excluded audience will be created in this campaign.

Return values:

Type	Description
AdsApp.AudienceBuilder	Audience builder used to create a new excluded audience in the campaign.

newKeywordBuilder()

Returns a new display keyword builder for this campaign. Only excluded display keywords can be created at the campaign level. When DisplayKeywordBuilder.exclude() is called, an excluded display keyword will be created in this campaign.

Return values:

Type	Description
AdsApp.DisplayKeywordBuilder	Display keyword builder used to create a new excluded display keyword in the campaign.

newPlacementBuilder()

Returns a new placement builder for this campaign. Only excluded placements can be created at the campaign level. When PlacementBuilder.exclude() is called, an excluded placement will be created in this campaign.

Return values:

Type	Description
AdsApp.PlacementBuilder	Placement builder used to create a new excluded placement in the campaign.

newTopicBuilder()

Returns a new topic builder for this campaign. Only excluded topics can be created at the campaign level. When TopicBuilder.exclude() is called, an excluded topic will be created in this campaign.

Return values:

Type	Description
AdsApp.TopicBuilder	Topic builder used to create a new excluded topic in the campaign.

newYouTubeChannelBuilder()

Returns a new YouTube channel builder for this campaign. Only excluded YouTube channels can be created at the campaign level. When YouTubeChannelBuilder.exclude() is called, an excluded YouTube channel will be created in this campaign.

Return values:

Type	Description
AdsApp.YouTubeChannelBuilder	YouTube channel builder used to create a new excluded YouTube channel in the campaign.

newYouTubeVideoBuilder()

Returns a new YouTube video builder for this campaign. Only excluded YouTube videos can be created at the campaign level. When YouTubeVideoBuilder.exclude() is called, an excluded YouTube video will be created in this campaign.

Return values:

Type	Description
AdsApp.YouTubeVideoBuilder	YouTube video builder used to create a new excluded YouTube video in the campaign.

placements()

Returns the selector of all website placements in all ad groups in the campaign. Mobile app placements and mobile app category placements are not supported.

Return values:

Type	Description
AdsApp.PlacementSelector	The selector of all website placements in all ad groups in the campaign.

topics()

Returns the selector of all topics in all ad groups in the campaign.

Return values:

Type	Description
AdsApp.TopicSelector	The selector of all topics in all ad groups in the campaign.

youTubeChannels()

Returns the selector of all YouTube channels in the campaign.

Return values:

Type	Description
AdsApp.YouTubeChannelSelector	The selector of all YouTube channels in the campaign.

youTubeVideos()

Returns the selector of all YouTube videos in the campaign.

Return values:

Type	Description
AdsApp.YouTubeVideoSelector	The selector of all YouTube videos in the campaign.