AdsApp.​VideoKeywordBuilder

  • The VideoKeywordBuilder is used to create VideoKeyword objects.

  • You can set the keyword text using withText(), which is a required field.

  • You can optionally set the maximum CPV bid using withCpv().

  • The build() method creates a standard video keyword, while exclude() creates an excluded video keyword.

 Builder for VideoKeyword objects.

Example usage: 

var videoKeywordBuilder = videoAdGroup.videoTargeting().newKeywordBuilder();
var videoKeywordOperation = videoKeywordBuilder
  .withText('keyword')     // required
  .withCpv(0.11)           // optional
  .build();                // create the keyword

Methods:

MemberTypeDescription
build() AdsApp.VideoKeywordOperation Builds the video keyword.
exclude() AdsApp.ExcludedVideoKeywordOperation Builds the excluded video keyword.
withCpv(cpv) AdsApp.VideoKeywordBuilder Sets the max CPV bid of the new video keyword to the specified value.
withText(text) AdsApp.VideoKeywordBuilder Sets the text of the video keyword.

build()

Builds the video keyword. Returns a VideoKeywordOperation that corresponds to the creation of the VideoKeyword.

Return values:

TypeDescription
AdsApp.VideoKeywordOperation The VideoKeywordOperation.

exclude()

Builds the excluded video keyword. Returns an ExcludedVideoKeywordOperation that corresponds to the creation of the ExcludedVideoKeyword.

Return values:

TypeDescription
AdsApp.ExcludedVideoKeywordOperation The ExcludedVideoKeywordOperation.

withCpv(cpv)

Sets the max CPV bid of the new video keyword to the specified value.

Arguments:

NameTypeDescription
cpv double The max CPV bid of the video keyword.

Return values:

TypeDescription
AdsApp.VideoKeywordBuilder The video keyword builder with the specified max CPV.

withText(text)

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

Arguments:

NameTypeDescription
text String The video keyword text.

Return values:

TypeDescription
AdsApp.VideoKeywordBuilder A VideoKeywordBuilder with the specified text.