Represents a Google Ads video ad group.
Methods:
applyLabel(name)
Applies a label to the video ad group.
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 group cannot not have more than 50 labels.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| name |
String |
Name of the label to apply. |
bidding()
Provides access to this ad group's bidding fields.
Return values:
clearTopContentBidModifier()
Clears the top content bid modifier for this ad group. This is the equivalent as setting the
bid modifier to
1.0.
Returns nothing.
devices()
Provides access to this ad group's device-specific configuration.
Return values:
enable()
Enables the video ad group.
Returns nothing.
getAdGroupType()
Returns the video ad group type. Possible return values:
TRUE_VIEW_IN_STREAM, TRUE_VIEW_IN_DISPLAY, NON_SKIPPABLE_IN_STREAM, BUMPER,
VIDEO_EFFICIENT_REACH, VIDEO_RESPONSIVE
Return values:
| Type | Description |
|---|
String |
Video ad group type. |
getEntityType()
Returns the type of this entity as a
String, in this case,
"VideoAdGroup".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "VideoAdGroup". |
getId()
Returns the ID of the video ad group.
Return values:
| Type | Description |
|---|
long |
The ID of the video ad group. |
getName()
Returns the name of the ad group.
Return values:
| Type | Description |
|---|
String |
Name of the ad group. |
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 = videoAdGroup.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. |
getTopContentBidModifier()
Returns the top content bid modifier for this ad group.
Top content bid modifiers are multipliers applied to the ad group's bids for high quality
content in network. For instance, a top content bid modifier of 1.1 increases a bid to
110% of its original value on mobile devices, and changes a bid of $5.00 to $5.50. The Google
Ads UI would render this setting as +10%.
Return values:
| Type | Description |
|---|
double |
The top content bid modifier. |
getVideoCampaign()
Returns the campaign to which this video ad group belongs.
Return values:
isEnabled()
Returns
true if the video ad group is enabled.
Return values:
| Type | Description |
|---|
boolean |
true if the video ad group is enabled. |
isPaused()
Returns
true if the video ad group is paused.
Return values:
| Type | Description |
|---|
boolean |
true if the video ad group is paused. |
isRemoved()
Returns
true if the ad group is removed.
Return values:
| Type | Description |
|---|
boolean |
true if the ad group is removed. |
labels()
Creates a selector of all labels applied to the video ad group.
Return values:
newVideoAd()
Returns a new video ad builder space associated with this ad group.
Return values:
pause()
Pauses the video ad group.
Returns nothing.
removeLabel(name)
Removes a label from the video ad group.
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. |
setName(name)
Sets the name of the ad group.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| name |
String |
The new name for the ad group. |
setTopContentBidModifier(modifier)
Sets the top content bid modifier for this ad group to the specified value. Bid modifiers must
be between
1.0 and
6.0.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| modifier |
double |
The new top content bid modifier. |
videoAds()
Returns the selector of all ads in the video ad group.
Return values:
videoTargeting()
Provides access to this ad group's video targeting criteria. For details about video targeting,
please see
About targeting for video
campaigns.
Return values:
