AdsApp.VideoKeywordBuilder
Stay organized with collections
Save and categorize content based on your preferences.
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:
build()
Builds the video keyword. Returns a
VideoKeywordOperation that corresponds to the creation of the
VideoKeyword.
Return values:
exclude()
Builds the excluded video keyword. Returns an
ExcludedVideoKeywordOperation that corresponds to the creation of the
ExcludedVideoKeyword.
Return values:
withCpv(cpv)
Sets the max CPV bid of the new video keyword to the specified value.
Arguments:
| Name | Type | Description |
|---|
| cpv |
double |
The max CPV bid of the video keyword. |
Return values:
withText(text)
Sets the text of the video keyword. This field is required.
Arguments:
| Name | Type | Description |
|---|
| text |
String |
The video keyword text. |
Return values:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThe VideoKeywordBuilder facilitates the creation and management of video keywords within Google Ads campaigns.\u003c/p\u003e\n"],["\u003cp\u003eIt enables setting essential parameters like keyword text (mandatory) and maximum cost-per-view (optional).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ebuild()\u003c/code\u003e and \u003ccode\u003eexclude()\u003c/code\u003e methods generate operations for creating or excluding video keywords respectively.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ewithText()\u003c/code\u003e and \u003ccode\u003ewithCpv()\u003c/code\u003e configure the keyword's text and maximum CPV bid.\u003c/p\u003e\n"]]],[],null,["# AdsApp.VideoKeywordBuilder\n\nBuilder for [VideoKeyword](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeyword) objects.\n\nExample usage:\n\n```gdscript\nvar videoKeywordBuilder = videoAdGroup.videoTargeting().newKeywordBuilder();\nvar videoKeywordOperation = videoKeywordBuilder\n .withText('keyword') // required\n .withCpv(0.11) // optional\n .build(); // create the keyword\n```\n\n### Methods:\n\n| Member | Type | Description |\n|----------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [build()](#build) | [AdsApp.VideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordoperation) | Builds the video keyword. |\n| [exclude()](#exclude) | [AdsApp.ExcludedVideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedvideokeywordoperation) | Builds the excluded video keyword. |\n| [withCpv(cpv)](#withCpv_cpv) | [AdsApp.VideoKeywordBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbuilder) | Sets the max CPV bid of the new video keyword to the specified value. |\n| [withText(text)](#withText_text) | [AdsApp.VideoKeywordBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbuilder) | Sets the text of the video keyword. |\n\n`build()`\n---------\n\nBuilds the video keyword. Returns a [VideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordoperation) that corresponds to the creation of the [VideoKeyword](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeyword).\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------------------|----------------------------|\n| [AdsApp.VideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordoperation) | The VideoKeywordOperation. |\n\n`exclude()`\n-----------\n\nBuilds the excluded video keyword. Returns an [ExcludedVideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedvideokeywordoperation) that corresponds to the creation of the [ExcludedVideoKeyword](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedvideokeyword).\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------------------------------------------------------|------------------------------------|\n| [AdsApp.ExcludedVideoKeywordOperation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedvideokeywordoperation) | The ExcludedVideoKeywordOperation. |\n\n`withCpv(cpv)`\n--------------\n\nSets the max CPV bid of the new video keyword to the specified value.\n\n### Arguments:\n\n| Name | Type | Description |\n|------|----------|---------------------------------------|\n| cpv | `double` | The max CPV bid of the video keyword. |\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------------|-------------------------------------------------------|\n| [AdsApp.VideoKeywordBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbuilder) | The video keyword builder with the specified max CPV. |\n\n`withText(text)`\n----------------\n\nSets the text of the video keyword. This field is required.\n\n### Arguments:\n\n| Name | Type | Description |\n|------|----------|-------------------------|\n| text | `String` | The video keyword text. |\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------------|------------------------------------------------|\n| [AdsApp.VideoKeywordBuilder](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbuilder) | A VideoKeywordBuilder with the specified text. |"]]
