AdsApp.​VideoKeyword

Represents a Google Ads Keyword in a Video Campaign.

Methods:

MemberTypeDescription
bidding AdsApp.VideoKeywordBidding Provides access to bidding fields of this video keyword.
getEntityType String Returns the type of this entity as a String, in this case, "VideoKeyword".
getId String Returns the ID of the video keyword.
getResourceName String Returns the resource name of the video keyword.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getText String Returns the text of the display keyword.
getVideoAdGroup AdsApp.VideoAdGroup Returns the ad group to which this video keyword belongs.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this video keyword belongs.
isEnabled boolean Returns true if the video keyword is enabled.
isPaused boolean Returns true if the video keyword is paused.
remove void Removes the video keyword.

bidding()

Provides access to bidding fields of this video keyword.

Return values:

TypeDescription
AdsApp.VideoKeywordBidding Access to bidding fields of this video keyword.

getEntityType()

Returns the type of this entity as a String, in this case, "VideoKeyword".

Return values:

TypeDescription
String Type of this entity: "VideoKeyword".

getId()

Returns the ID of the video keyword.

Return values:

TypeDescription
String The ID of the video keyword.

getResourceName()

Returns the resource name of the video keyword.

Return values:

TypeDescription
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:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
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:

NameTypeDescription
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:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getText()

Returns the text of the display keyword.

Return values:

TypeDescription
String The text of the display keyword.

getVideoAdGroup()

Returns the ad group to which this video keyword belongs.

Return values:

TypeDescription
AdsApp.VideoAdGroup The ad group to which this video keyword belongs.

getVideoCampaign()

Returns the campaign to which this video keyword belongs.

Return values:

TypeDescription
AdsApp.VideoCampaign The campaign to which this video keyword belongs.

isEnabled()

Returns true if the video keyword is enabled.

Return values:

TypeDescription
boolean true if the video keyword is enabled.

isPaused()

Returns true if the video keyword is paused.

Return values:

TypeDescription
boolean true if the video keyword is paused.

remove()

Removes the video keyword.

Returns nothing.