AdsApp.​AdGroupDisplay

AI-generated Key Takeaways

• This page outlines how to access and manage various ad group-level display criteria using Google Ads scripts.

• It provides methods to work with audiences, keywords, placements, topics, and YouTube channels/videos, including exclusions.

• You can use these methods to retrieve existing criteria or build new ones within your ad groups.

• Selectors allow you to iterate through and access individual items within each criterion category.

• Builders facilitate the creation of new display criteria or excluded criteria directly in your ad groups.

Access to ad group-level display criteria. For example, to access all display keywords in an ad group:

var displayKeywordIterator = adGroup.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 ad group.
excludedAudiences()	AdsApp.ExcludedAudienceSelector	Returns the selector of all excluded audiences in the ad group.
excludedKeywords()	AdsApp.ExcludedDisplayKeywordSelector	Returns the selector of all excluded display keywords in the ad group.
excludedPlacements()	AdsApp.ExcludedPlacementSelector	Returns the selector of all excluded website placements in the ad group.
excludedTopics()	AdsApp.ExcludedTopicSelector	Returns the selector of all excluded topics in the ad group.
excludedYouTubeChannels()	AdsApp.ExcludedYouTubeChannelSelector	Returns the selector of all excluded YouTube channels in the ad group.
excludedYouTubeVideos()	AdsApp.ExcludedYouTubeVideoSelector	Returns the selector of all excluded YouTube videos in the ad group.
keywords()	AdsApp.DisplayKeywordSelector	Returns the selector of all display keywords in the ad group.
newAudienceBuilder()	AdsApp.AudienceBuilder	Returns a new audience builder for this ad group.
newKeywordBuilder()	AdsApp.DisplayKeywordBuilder	Returns a new display keyword builder for this ad group.
newPlacementBuilder()	AdsApp.PlacementBuilder	Returns a new placement builder for this ad group.
newTopicBuilder()	AdsApp.TopicBuilder	Returns a new topic builder for this ad group.
newYouTubeChannelBuilder()	AdsApp.YouTubeChannelBuilder	Returns a new YouTube channel builder for this ad group.
newYouTubeVideoBuilder()	AdsApp.YouTubeVideoBuilder	Returns a new YouTube video builder for this ad group.
placements()	AdsApp.PlacementSelector	Returns the selector of all website placements in the ad group.
topics()	AdsApp.TopicSelector	Returns the selector of all topics in the ad group.
youTubeChannels()	AdsApp.YouTubeChannelSelector	Returns the selector of all YouTube channels in the ad group.
youTubeVideos()	AdsApp.YouTubeVideoSelector	Returns the selector of all YouTube videos in the ad group.

audiences()

Returns the selector of all audiences in the ad group.

Return values:

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

excludedAudiences()

Returns the selector of all excluded audiences in the ad group.

Return values:

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

excludedKeywords()

Returns the selector of all excluded display keywords in the ad group.

Return values:

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

excludedPlacements()

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

Return values:

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

excludedTopics()

Returns the selector of all excluded topics in the ad group.

Return values:

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

excludedYouTubeChannels()

Returns the selector of all excluded YouTube channels in the ad group.

Return values:

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

excludedYouTubeVideos()

Returns the selector of all excluded YouTube videos in the ad group.

Return values:

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

keywords()

Returns the selector of all display keywords in the ad group.

Return values:

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

newAudienceBuilder()

Returns a new audience builder for this ad group. When AudienceBuilder.build() is called, an audience will be created in this ad group. When AudienceBuilder.exclude() is called, an excluded audience will be created in this ad group.

Return values:

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

newKeywordBuilder()

Returns a new display keyword builder for this ad group. When DisplayKeywordBuilder.build() is called, a display keyword will be created in this ad group. When DisplayKeywordBuilder.exclude() is called, an excluded display keyword will be created in this ad group.

Return values:

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

newPlacementBuilder()

Returns a new placement builder for this ad group. When PlacementBuilder.build() is called, a placement will be created in this ad group. When PlacementBuilder.exclude() is called, an excluded placement will be created in this ad group.

Return values:

Type	Description
AdsApp.PlacementBuilder	Placement builder used to create a new managed or excluded placement in the ad group.

newTopicBuilder()

Returns a new topic builder for this ad group. When TopicBuilder.build() is called, a topic will be created in this ad group. When TopicBuilder.exclude() is called, an excluded topic will be created in this ad group.

Return values:

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

newYouTubeChannelBuilder()

Returns a new YouTube channel builder for this ad group. When YouTubeChannelBuilder.build() is called, a YouTube channel will be created in this ad group. When YouTubeChannelBuilder.exclude() is called, an excluded YouTube channel will be created in this ad group.

Return values:

Type	Description
AdsApp.YouTubeChannelBuilder	YouTube channel builder used to create a new YouTube channel in the ad group.

newYouTubeVideoBuilder()

Returns a new YouTube video builder for this ad group. When YouTubeVideoBuilder.build() is called, a YouTube video will be created in this ad group. When YouTubeVideoBuilder.exclude() is called, an excluded YouTube video will be created in this ad group.

Return values:

Type	Description
AdsApp.YouTubeVideoBuilder	YouTube video builder used to create a new YouTube video in the ad group.

placements()

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

Return values:

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

topics()

Returns the selector of all topics in the ad group.

Return values:

Type	Description
AdsApp.TopicSelector	The selector of all topic in the ad group.

youTubeChannels()

Returns the selector of all YouTube channels in the ad group.

Return values:

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

youTubeVideos()

Returns the selector of all YouTube videos in the ad group.

Return values:

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