AdWordsApp.​VideoAdGroup

Represents an AdWords video ad group.

Methods:

MemberTypeDescription
applyLabel void Applies a label to the video ad group.
bidding AdWordsApp.VideoAdGroupBidding Provides access to this ad group's bidding fields.
clearTopContentBidModifier void Clears the top content bid modifier for this ad group.
devices AdWordsApp.VideoAdGroupDevices Provides access to this ad group's device-specific configuration.
enable void Enables the video ad group.
getAdGroupType String Returns the video ad group type.
getEntityType String Returns the type of this entity as a String, in this case, "VideoAdGroup".
getId long Returns the ID of the video ad group.
getName String Returns the name of the ad group.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getTopContentBidModifier double Returns the top content bid modifier for this ad group.
getVideoCampaign AdWordsApp.VideoCampaign Returns the campaign to which this video ad group belongs.
isEnabled boolean Returns true if the video ad group is enabled.
isPaused boolean Returns true if the video ad group is paused.
isRemoved boolean Returns true if the ad group is removed.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the video ad group.
newVideoAd AdWordsApp.VideoAdBuilderSpace Returns a new video ad builder space associated with this ad group.
pause void Pauses the video ad group.
removeLabel void Removes a label from the video ad group.
setName void Sets the name of the ad group.
setTopContentBidModifier void Sets the top content bid modifier for this ad group to the specified value.
videoAds AdWordsApp.VideoAdSelector Returns the selector of all ads in the video ad group.
videoTargeting AdWordsApp.AdGroupVideoTargeting Provides access to this ad group's video targeting criteria.

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:

NameTypeDescription
name String Name of the label to apply.

bidding()

Provides access to this ad group's bidding fields.

Return values:

TypeDescription
AdWordsApp.VideoAdGroupBidding Access to this ad group's bidding fields.

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:

TypeDescription
AdWordsApp.VideoAdGroupDevices An VideoAdGroupDevices instance associated with the ad group.

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

Return values:

TypeDescription
String Video ad group type.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoAdGroup".

getId()

Returns the ID of the video ad group.

Return values:

TypeDescription
long The ID of the video ad group.

getName()

Returns the name of the ad group.

Return values:

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

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

Return values:

TypeDescription
AdWordsApp.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
AdWordsApp.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 AdWords UI would render this setting as +10%.

Return values:

TypeDescription
double The top content bid modifier.

getVideoCampaign()

Returns the campaign to which this video ad group belongs.

Return values:

TypeDescription
AdWordsApp.VideoCampaign The campaign to which this video ad group belongs.

isEnabled()

Returns true if the video ad group is enabled.

Return values:

TypeDescription
boolean true if the video ad group is enabled.

isPaused()

Returns true if the video ad group is paused.

Return values:

TypeDescription
boolean true if the video ad group is paused.

isRemoved()

Returns true if the ad group is removed.

Return values:

TypeDescription
boolean true if the ad group is removed.

labels()

Creates a selector of all labels applied to the video ad group.

Return values:

TypeDescription
AdWordsApp.LabelSelector Selector of all labels applied to the video ad group.

newVideoAd()

Returns a new video ad builder space associated with this ad group.

Return values:

TypeDescription
AdWordsApp.VideoAdBuilderSpace A new video ad builder space associated with this ad group.

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:

NameTypeDescription
name String Name of the label.

setName(name)

Sets the name of the ad group.

Returns nothing.

Arguments:

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

NameTypeDescription
modifier double The new top content bid modifier.

videoAds()

Returns the selector of all ads in the video ad group.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector of all ads in the video ad group.

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:

TypeDescription
AdWordsApp.AdGroupVideoTargeting Access to this ad group's video criteria.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.