AdsApp.​GmailMultiProductAd

Represents a Gmail multi-product ad.

Methods:

Member	Type	Description
applyLabel	void	Applies a label to the ad.
asType	AdsApp.AdViewSpace	Returns an AdViewSpace, which provides access to type-specific fields of the ad.
enable	void	Enables the ad.
getAdGroup	AdsApp.AdGroup	Returns the ad group to which this ad belongs.
getAdvertiser	String	Returns the advertiser shown in the ad.
getCampaign	AdsApp.Campaign	Returns the campaign to which this ad belongs or null if it does not belong to a search or display campaign.
getContent	String	Returns the content of the ad.
getDescription	String	Returns the description of the ad.
getEntityType	String	Returns the type of this entity as a String, in this case, "Ad".
getHeader	AdsApp.Media	Returns the ad's header image.
getHeadline	String	Returns the headline of the ad.
getHeadlineColor	String	Returns the headline color hex code of the ad.
getId	String	Returns the ID of the ad.
getItemButtonCallsToAction	String[]	Returns the calls to action for the ad's six items.
getItemButtonColors	String[]	Returns the button colors for the ad's six items.
getItemButtonFinalMobileUrls	String[]	Returns the mobile final URLs for the ad's six item buttons.
getItemButtonFinalUrls	String[]	Returns the final URLs for the ad's six item buttons.
getItemButtonTextColors	String[]	Returns the button text colors for the ad's six items.
getItemButtonTrackingTemplates	String[]	Returns the tracking templates for the ad's six item buttons.
getItemImages	AdsApp.Media[]	Returns the images for the ad's six items.
getItemTitleColors	String[]	Returns the title colors for the ad's six items.
getItemTitles	String[]	Returns the titles for the ad's six items.
getLogo	AdsApp.Media	Returns the ad's logo image.
getName	String	Returns the name of the ad.
getPolicyApprovalStatus	String	Returns the policy approval status of the ad.
getPolicyTopics	AdsApp.PolicyTopic[]	Returns the list of policy topics associated with the ad.
getResourceName	String	Returns the resource name of the ad.
getStatsFor	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor	AdsApp.Stats	Returns stats for the specified custom date range.
getSubject	String	Returns the subject of the ad.
getType	String	Returns the type of the ad.
isEnabled	boolean	Returns true if the ad is enabled.
isPaused	boolean	Returns true if the ad is paused.
isType	AdsApp.AdTypeSpace	Returns an AdTypeSpace, which determines the type of the ad.
labels	AdsApp.LabelSelector	Creates a selector of all labels applied to the ad.
pause	void	Pauses the ad.
remove	void	Removes the ad.
removeLabel	void	Removes a label from the ad.
urls	AdsApp.AdUrls	Provides access to this ad's URL fields.

applyLabel(name)

Applies a label to the 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 ad cannot not have more than 50 labels.

Returns nothing.

Arguments:

Name	Type	Description
name	String	Name of the label to apply.

asType()

Returns an AdViewSpace, which provides access to type-specific fields of the ad.

Return values:

Type	Description
AdsApp.AdViewSpace	An AdViewSpace.

enable()

Enables the ad.

Returns nothing.

getAdGroup()

Returns the ad group to which this ad belongs.

Return values:

Type	Description
AdsApp.AdGroup	The ad group to which this ad belongs.

getAdvertiser()

Returns the advertiser shown in the ad.

Return values:

Type	Description
String	The advertiser shown in the ad.

getCampaign()

Returns the campaign to which this ad belongs or null if it does not belong to a search or display campaign.

Return values:

Type	Description
AdsApp.Campaign	The campaign to which this ad belongs or null if it does not belong to a search or display campaign.

getContent()

Returns the content of the ad.

Return values:

Type	Description
String	The content of the ad.

getDescription()

Returns the description of the ad.

Return values:

Type	Description
String	The description of the ad.

getEntityType()

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

Return values:

Type	Description
String	Type of this entity: "Ad".

getHeader()

Returns the ad's header image.

Return values:

Type	Description
AdsApp.Media	The ad's header.

getHeadline()

Returns the headline of the ad.

Return values:

Type	Description
String	The headline of the ad.

getHeadlineColor()

Returns the headline color hex code of the ad.

Return values:

Type	Description
String	The headline color 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.

getItemButtonCallsToAction()

Returns the calls to action for the ad's six items.

Return values:

Type	Description
String[]	The ad's item calls to action.

getItemButtonColors()

Returns the button colors for the ad's six items.

Return values:

Type	Description
String[]	The ad's item button colors.

getItemButtonFinalMobileUrls()

Returns the mobile final URLs for the ad's six item buttons.

Return values:

Type	Description
String[]	The ad's item mobile final URLs.

getItemButtonFinalUrls()

Returns the final URLs for the ad's six item buttons.

Return values:

Type	Description
String[]	The ad's item final URLs.

getItemButtonTextColors()

Returns the button text colors for the ad's six items.

Return values:

Type	Description
String[]	The ad's item button text colors.

getItemButtonTrackingTemplates()

Returns the tracking templates for the ad's six item buttons.

Return values:

Type	Description
String[]	The ad's item tracking templates.

getItemImages()

Returns the images for the ad's six items.

Return values:

Type	Description
AdsApp.Media[]	The ad's item images.

getItemTitleColors()

Returns the title colors for the ad's six items.

Return values:

Type	Description
String[]	The ad's item title colors.

getItemTitles()

Returns the titles for the ad's six items.

Return values:

Type	Description
String[]	The ad's item titles.

getLogo()

Returns the ad's logo image.

Return values:

Type	Description
AdsApp.Media	The ad's logo.

getName()

Returns the name of the ad.

Return values:

Type	Description
String	The name of the ad.

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.

Return values:

Type	Description
AdsApp.PolicyTopic[]	The policy topics of the ad.

getResourceName()

Returns the resource name of the ad.

Return values:

Type	Description
String	The resource name of the 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 = ad.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.

getSubject()

Returns the subject of the ad.

Return values:

Type	Description
String	The subject of the ad.

getType()

Returns the type of the ad. Possible values: EXPANDED_TEXT_AD, IMAGE_AD, MOBILE_AD, MOBILE_IMAGE_AD, PRODUCT_AD, RICH_MEDIA_AD, TEMPLATE_AD, TEXT_AD.

We recommend using GmailMultiProductAd.isType for fully supported types.

Return values:

Type	Description
String	The type of the ad.

isEnabled()

Returns true if the ad is enabled.

Return values:

Type	Description
boolean	true if the ad is enabled.

isPaused()

Returns true if the ad is paused.

Return values:

Type	Description
boolean	true if the ad is paused.

isType()

Returns an AdTypeSpace, which determines the type of the ad.

Return values:

Type	Description
AdsApp.AdTypeSpace	An AdTypeSpace.

labels()

Creates a selector of all labels applied to the ad.

Return values:

Type	Description
AdsApp.LabelSelector	Selector of all labels applied to the ad.

pause()

Pauses the ad.

Returns nothing.

remove()

Removes the ad.

Returns nothing.

removeLabel(name)

Removes a label from the 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:

Type	Description
AdsApp.AdUrls	Access to this ad's URL fields.