Register for one of our upcoming AdWords scripts workshops.

AdWordsApp.​DisplayKeywordBuilder

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:

MemberTypeDescription
build AdWordsApp.DisplayKeywordOperation Builds the display keyword.
exclude AdWordsApp.ExcludedDisplayKeywordOperation Builds the excluded display keyword.
withCpc AdWordsApp.DisplayKeywordBuilder Sets the max CPC bid of the new display keyword to the specified value.
withCpm AdWordsApp.DisplayKeywordBuilder Sets the CPM bid of the new display keyword to the specified value.
withText AdWordsApp.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:

TypeDescription
AdWordsApp.DisplayKeywordOperation The DisplayKeywordOperation.

exclude()

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

Return values:

TypeDescription
AdWordsApp.ExcludedDisplayKeywordOperation The ExcludedDisplayKeywordOperation.

withCpc(cpc)

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

Arguments:

NameTypeDescription
cpc double The max CPC bid of the display keyword.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
cpm double The CPM bid of the display keyword.

Return values:

TypeDescription
AdWordsApp.DisplayKeywordBuilder The display keyword builder with the specified CPM.

withText(text)

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

Arguments:

NameTypeDescription
text String The display keyword text.

Return values:

TypeDescription
AdWordsApp.DisplayKeywordBuilder A DisplayKeywordBuilder with the specified text.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.