AdsApp.​DisplayKeywordBuilder

AI-generated Key Takeaways

• The DisplayKeywordBuilder facilitates the creation and management of display keywords within Google Ads scripts.

• It offers methods like withText, withCpc, and withCpm to define keyword attributes, with withText being mandatory.

• The build() method finalizes the display keyword creation, while exclude() specifically builds excluded display keywords.

• Both build() and exclude() return corresponding operation objects for the respective keyword types, such as DisplayKeywordOperation and ExcludedDisplayKeywordOperation.

Builder for DisplayKeyword objects.

Example usage:

var displayKeywordBuilder = adGroup.display().newKeywordBuilder();
var displayKeyword = displayKeywordBuilder
  .withText("keyword text")     // required
  .withCpc(0.50)                // optional
  .build()                      // create the display keyword

Methods:

Member	Type	Description
build()	AdsApp.DisplayKeywordOperation	Builds the display keyword.
exclude()	AdsApp.ExcludedDisplayKeywordOperation	Builds the excluded display keyword.
withCpc(cpc)	AdsApp.DisplayKeywordBuilder	Sets the max CPC bid of the new display keyword to the specified value.
withCpm(cpm)	AdsApp.DisplayKeywordBuilder	Sets the CPM bid of the new display keyword to the specified value.
withText(text)	AdsApp.DisplayKeywordBuilder	Sets the text of the display keyword.

build()

Builds the display keyword. Returns a DisplayKeywordOperation that corresponds to the creation of the DisplayKeyword.

Return values:

Type	Description
AdsApp.DisplayKeywordOperation	The DisplayKeywordOperation.

exclude()

Builds the excluded display keyword. Returns an ExcludedDisplayKeywordOperation that corresponds to the creation of the ExcludedDisplayKeyword.

Return values:

Type	Description
AdsApp.ExcludedDisplayKeywordOperation	The ExcludedDisplayKeywordOperation.

withCpc(cpc)

Sets the max CPC bid of the new display keyword to the specified value.

Arguments:

Name	Type	Description
cpc	double	The max CPC bid of the display keyword.

Return values:

Type	Description
AdsApp.DisplayKeywordBuilder	The display keyword builder with the specified max CPC.

withCpm(cpm)

Sets the CPM bid of the new display keyword to the specified value.

See Cost-per-thousand impressions (CPM) for more information.

Arguments:

Name	Type	Description
cpm	double	The CPM bid of the display keyword.

Return values:

Type	Description
AdsApp.DisplayKeywordBuilder	The display keyword builder with the specified CPM.

withText(text)

Sets the text of the display keyword. This field is required.

Arguments:

Name	Type	Description
text	String	The display keyword text.

Return values:

Type	Description
AdsApp.DisplayKeywordBuilder	A DisplayKeywordBuilder with the specified text.