Represents a Google Ads video ad.
Methods:
applyLabel(name)
Applies a label to the video ad.
name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.
Note that the video ad cannot have more than 50 labels.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| name | String | Name of the label to apply. |
enable()
Enables the video ad.
Returns nothing.
getChannelName()
Returns the channel ID of the ad's video.
Return values:
| Type | Description |
|---|
String | The channel ID of the ad's video. |
getDescription1()
Returns the first line of the ad description. May return
null for some types of ads.
Return values:
| Type | Description |
|---|
String | The first line of the ad description. |
getDescription2()
Returns the second line of the ad description. May return
null for some types of ads.
Return values:
| Type | Description |
|---|
String | The second line of the ad description. |
getDestinationPage()
Returns the type of destination page of the ad. Possible values:
WATCH_PAGE, CHANNEL_PAGE.
Return values:
| Type | Description |
|---|
String | The video ID of the ad. |
getDisplayUrl()
Returns the display URL of the ad. May return
null for some types of ads.
Return values:
| Type | Description |
|---|
String | The display URL of the ad. |
getEntityType()
Returns the type of this entity as a
String, in this case,
"VideoAd".
Return values:
| Type | Description |
|---|
String | Type of this entity: "VideoAd". |
getHeadline()
Returns the headline of the ad. May return
null for some types of ads.
Return values:
| Type | Description |
|---|
String | The headline of the ad. |
getId()
Returns the ID of the ad.
Ad IDs may be shared across ad groups. In order to uniquely identify one ad, one must specify both its ad group ID and its creative ID.
Return values:
| Type | Description |
|---|
String | The ID of the ad. |
getName()
Returns the ad name.
Return values:
| Type | Description |
|---|
String | The ad name. |
getPolicyApprovalStatus()
Returns the policy approval status of the ad. For a full list of policy approval statuses, please see the
Google Ads API documentation on policy approval statuses.
Return values:
| Type | Description |
|---|
String | The policy approval status of the ad. |
getPolicyTopics()
Returns the list of policy topics associated with the ad. Policy topics contain information about policy decisions taken regarding the ad.
Return values:
getResourceName()
Returns the resource name of the video ad.
Return values:
| Type | Description |
|---|
String | The resource name of the video ad. |
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 = videoAd.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. |
getType()
Returns the type of the ad. Possible values:
VIDEO_TRUEVIEW_IN_STREAM_AD, IN_FEED_VIDEO_AD, VIDEO_BUMPER_AD, VIDEO_NON_SKIPPABLE_IN_STREAM_AD, VIDEO_RESPONSIVE_AD.
Return values:
| Type | Description |
|---|
String | The type of the ad. |
getVideoAdGroup()
Returns the video ad group to which this video ad belongs.
Return values:
getVideoCampaign()
Returns the video campaign to which this video ad belongs.
Return values:
getVideoId()
Returns the video ID of the ad.
Return values:
| Type | Description |
|---|
String | The video ID of the ad. |
isEnabled()
Returns
true if the video ad is enabled.
Return values:
| Type | Description |
|---|
boolean | true if the video ad is enabled. |
isPaused()
Returns
true if the video ad is paused.
Return values:
| Type | Description |
|---|
boolean | true if the video ad is paused. |
labels()
Creates a selector of all labels applied to the video ad.
Return values:
pause()
Pauses the video ad.
Returns nothing.
remove()
Removes the video ad.
Returns nothing.
removeLabel(name)
Removes a label from the video ad.
name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| name | String | Name of the label. |
urls()
Provides access to this ad's URL fields. See
Using Upgraded URLs for more information.
Return values: