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 |
long |
The ID 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 = videoKeyword.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.