Page Summary
-
DisplayKeywordBuilder is used to create DisplayKeyword objects.
-
The
withTextmethod is required when building a display keyword. -
Optional methods include setting CPC or CPM bids using
withCpcorwithCpm. -
The
build()method creates the display keyword, whileexclude()creates an excluded display keyword.
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 |
|---|---|---|
AdsApp.DisplayKeywordOperation
|
Builds the display keyword. | |
AdsApp.ExcludedDisplayKeywordOperation
|
Builds the excluded display keyword. | |
AdsApp.DisplayKeywordBuilder
|
Sets the max CPC bid of the new display keyword to the specified value. | |
AdsApp.DisplayKeywordBuilder
|
Sets the CPM bid of the new display keyword to the specified value. | |
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. |
