AdsApp.VideoKeyword
Stay organized with collections
Save and categorize content based on your preferences.
Represents a Google Ads Keyword in a Video Campaign.
Methods:
bidding()
Provides access to bidding fields of this video keyword.
Return values:
getEntityType()
Returns the type of this entity as a
String, in this case,
"VideoKeyword".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "VideoKeyword". |
getId()
Returns the ID of the video keyword.
Return values:
| Type | Description |
|---|
String |
The ID of the video keyword. |
getResourceName()
Returns the resource name of the video keyword.
Return values:
| Type | Description |
|---|
String |
The resource name of the video keyword. |
getStatsFor(dateRange)
Returns stats for the specified date range. Supported values:
TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK,
LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT,
THIS_MONTH, LAST_MONTH, ALL_TIME.
Example:
var stats = keyword.getStatsFor("THIS_MONTH"); Arguments:
| Name | Type | Description |
|---|
| dateRange |
String |
Date range for which the stats are requested. |
Return values:
| Type | Description |
|---|
AdsApp.Stats |
The stats for the specified date range. |
getStatsFor(dateFrom, dateTo)
Returns stats for the specified custom date range. Both parameters can be
either an object containing year, month, and day fields, or an 8-digit
string in
YYYYMMDD form. For instance,
March 24th,
2013 is represented as either
{year: 2013, month: 3, day:
24} or
"20130324". The date range is inclusive on both
ends, so
forDateRange("20130324", "20130324") defines a range
of a single day.
Arguments:
| Name | Type | Description |
|---|
| dateFrom |
Object |
Start date of the date range. Must be either a string in
YYYYMMDD form, or an object with year,
month and day properties. |
| dateTo |
Object |
End date of the date range. Must be either a string in
YYYYMMDD form, or an object with year,
month and day properties. |
Return values:
| Type | Description |
|---|
AdsApp.Stats |
The stats for the specified date range. |
getText()
Returns the text of the display keyword.
Return values:
| Type | Description |
|---|
String |
The text of the display keyword. |
getVideoAdGroup()
Returns the ad group to which this video keyword belongs.
Return values:
getVideoCampaign()
Returns the campaign to which this video keyword belongs.
Return values:
isEnabled()
Returns
true if the video keyword is enabled.
Return values:
| Type | Description |
|---|
boolean |
true if the video keyword is enabled. |
isPaused()
Returns
true if the video keyword is paused.
Return values:
| Type | Description |
|---|
boolean |
true if the video keyword is paused. |
remove()
Removes the video keyword.
Returns nothing.
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-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eRepresents a keyword associated with a Video Campaign in Google Ads.\u003c/p\u003e\n"],["\u003cp\u003eProvides methods to access and manage keyword properties, such as its ID, text, and associated ad group/campaign.\u003c/p\u003e\n"],["\u003cp\u003eEnables retrieval of performance statistics for specific date ranges.\u003c/p\u003e\n"],["\u003cp\u003eAllows for checking the keyword's status (enabled/paused) and removing it from the campaign.\u003c/p\u003e\n"]]],[],null,["# AdsApp.VideoKeyword\n\nRepresents a Google Ads Keyword in a Video Campaign.\n\n### Methods:\n\n| Member | Type | Description |\n|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [bidding()](#bidding) | [AdsApp.VideoKeywordBidding](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbidding) | Provides access to bidding fields of this video keyword. |\n| [getEntityType()](#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `\"VideoKeyword\"`. |\n| [getId()](#getId) | `String` | Returns the ID of the video keyword. |\n| [getResourceName()](#getResourceName) | `String` | Returns the resource name of the video keyword. |\n| [getStatsFor(dateRange)](#getStatsFor_dateRange) | [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | Returns stats for the specified date range. |\n| [getStatsFor(dateFrom, dateTo)](#getStatsFor_dateFrom-dateTo) | [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | Returns stats for the specified custom date range. |\n| [getText()](#getText) | `String` | Returns the text of the display keyword. |\n| [getVideoAdGroup()](#getVideoAdGroup) | [AdsApp.VideoAdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_videoadgroup) | Returns the ad group to which this video keyword belongs. |\n| [getVideoCampaign()](#getVideoCampaign) | [AdsApp.VideoCampaign](/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign) | Returns the campaign to which this video keyword belongs. |\n| [isEnabled()](#isEnabled) | `boolean` | Returns `true` if the video keyword is enabled. |\n| [isPaused()](#isPaused) | `boolean` | Returns `true` if the video keyword is paused. |\n| [remove()](#remove) | `void` | Removes the video keyword. |\n\n`bidding()`\n-----------\n\nProvides access to bidding fields of this video keyword.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------------|-------------------------------------------------|\n| [AdsApp.VideoKeywordBidding](/google-ads/scripts/docs/reference/adsapp/adsapp_videokeywordbidding) | Access to bidding fields of this video keyword. |\n\n`getEntityType()`\n-----------------\n\nReturns the type of this entity as a `String`, in this case, `\"VideoKeyword\"`.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------------|\n| `String` | Type of this entity: `\"VideoKeyword\"`. |\n\n`getId()`\n---------\n\nReturns the ID of the video keyword.\n\n### Return values:\n\n| Type | Description |\n|----------|------------------------------|\n| `String` | The ID of the video keyword. |\n\n`getResourceName()`\n-------------------\n\nReturns the resource name of the video keyword.\n\n### Return values:\n\n| Type | Description |\n|----------|-----------------------------------------|\n| `String` | The resource name of the video keyword. |\n\n`getStatsFor(dateRange)`\n------------------------\n\nReturns stats for the specified date range. Supported values:\n\n`TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK,\nLAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT,\nTHIS_MONTH, LAST_MONTH, ALL_TIME`.\n\nExample:\n\n```gdscript\nvar stats = keyword.getStatsFor(\"THIS_MONTH\");\n```\n\n### Arguments:\n\n| Name | Type | Description |\n|-----------|----------|-----------------------------------------------|\n| dateRange | `String` | Date range for which the stats are requested. |\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------|-----------------------------------------|\n| [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | The stats for the specified date range. |\n\n`getStatsFor(dateFrom, dateTo)`\n-------------------------------\n\nReturns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in `YYYYMMDD` form. For instance, `March 24th,\n2013` is represented as either `{year: 2013, month: 3, day:\n24}` or `\"20130324\"`. The date range is inclusive on both ends, so `forDateRange(\"20130324\", \"20130324\")` defines a range of a single day.\n\n### Arguments:\n\n| Name | Type | Description |\n|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------|\n| dateFrom | `Object` | Start date of the date range. Must be either a string in `YYYYMMDD` form, or an object with `year`, `month` and `day` properties. |\n| dateTo | `Object` | End date of the date range. Must be either a string in `YYYYMMDD` form, or an object with `year`, `month` and `day` properties. |\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------|-----------------------------------------|\n| [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | The stats for the specified date range. |\n\n`getText()`\n-----------\n\nReturns the text of the display keyword.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------|\n| `String` | The text of the display keyword. |\n\n`getVideoAdGroup()`\n-------------------\n\nReturns the ad group to which this video keyword belongs.\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------|---------------------------------------------------|\n| [AdsApp.VideoAdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_videoadgroup) | The ad group to which this video keyword belongs. |\n\n`getVideoCampaign()`\n--------------------\n\nReturns the campaign to which this video keyword belongs.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------|---------------------------------------------------|\n| [AdsApp.VideoCampaign](/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign) | The campaign to which this video keyword belongs. |\n\n`isEnabled()`\n-------------\n\nReturns `true` if the video keyword is enabled.\n\n### Return values:\n\n| Type | Description |\n|-----------|-----------------------------------------|\n| `boolean` | `true` if the video keyword is enabled. |\n\n`isPaused()`\n------------\n\nReturns `true` if the video keyword is paused.\n\n### Return values:\n\n| Type | Description |\n|-----------|----------------------------------------|\n| `boolean` | `true` if the video keyword is paused. |\n\n`remove()`\n----------\n\nRemoves the video keyword.\n\nReturns nothing."]]
