AdsApp.​ResponsiveDisplayAd

Page Summary

• This document outlines the methods available for managing a responsive ad for Display.

• You can apply, remove, enable, pause, and remove responsive display ads using the provided methods.

• Access to ad details such as ad group, campaign, business name, headlines, descriptions, images, and videos is available through various getter methods.

• Information regarding the ad's policy approval status and associated policy topics can be retrieved.

• Methods are available to check the ad's status (enabled, paused, legacy) and retrieve statistics for specific date ranges.

Represents a responsive ad for Display.

Methods:

Member	Type	Description
applyLabel(name)	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.
getBusinessName()	String	Returns the ad's optional business name.
getCampaign()	AdsApp.Campaign	Returns the campaign to which this ad belongs or null if it does not belong to a search or display campaign.
getDescription()	String	Returns the description of the ad if this is a legacy responsive display ad, or null if not.
getDescriptions()	AdsApp.AdTextAsset[]	Returns the descriptions of the ad, or null if this is a legacy responsive display ad.
getEntityType()	String	Returns the type of this entity as a String, in this case, "Ad".
getHeadlines()	AdsApp.AdTextAsset[]	Returns the short-format headlines of the ad, or null if this is a legacy responsive display ad.
getId()	String	Returns the ID of the ad.
getLandscapeLogoImages()	AdsApp.Asset[]	Returns the ad's landscape logo image assets, or null if the ad has none or if the ad is a legacy responsive display ad.
getLogoImages()	AdsApp.Asset[]	Returns the ad's square logo image assets, or null if the ad has none or if the ad is a legacy responsive display ad.
getLongHeadline()	String	Returns the long headline of the ad.
getMarketingImages()	AdsApp.Asset[]	Returns the ad's rectangular marketing image assets, or null if this is a legacy responsive display 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.
getShortHeadline()	String	Returns the short headline of the ad if this is a legacy responsive display ad, or null if not.
getSquareMarketingImages()	AdsApp.Asset[]	Returns the ad's square marketing image assets, or null if this is a legacy responsive display ad.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getType()	String	Returns the type of the ad.
getYouTubeVideos()	AdsApp.Asset[]	Returns the ad's YouTube video assets, or null if the ad has none or if the ad is a legacy responsive display ad.
isEnabled()	boolean	Returns true if the ad is enabled.
isLegacy()	boolean	Returns true if this is a legacy responsive display ad, false otherwise.
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(name)	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 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.

getBusinessName()

Returns the ad's optional business name.

Return values:

Type	Description
String	The ad's business name.

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.

getDescription()

Returns the description of the ad if this is a legacy responsive display ad, or null if not.

Return values:

Type	Description
String	The description of the ad.

getDescriptions()

Returns the descriptions of the ad, or null if this is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.AdTextAsset[]	The descriptions 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".

getHeadlines()

Returns the short-format headlines of the ad, or null if this is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.AdTextAsset[]	The short-format headlines 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.

getLandscapeLogoImages()

Returns the ad's landscape logo image assets, or null if the ad has none or if the ad is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.Asset[]	The asset IDs of all landscape logo images to be used in the ad.

getLogoImages()

Returns the ad's square logo image assets, or null if the ad has none or if the ad is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.Asset[]	The asset IDs of all square logo images to be used in the ad.

getLongHeadline()

Returns the long headline of the ad.

Return values:

Type	Description
String	The long headline of the ad.

getMarketingImages()

Returns the ad's rectangular marketing image assets, or null if this is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.Asset[]	The asset IDs of all rectangular marketing images to be used in 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.

getShortHeadline()

Returns the short headline of the ad if this is a legacy responsive display ad, or null if not.

Return values:

Type	Description
String	The short headline of the ad.

getSquareMarketingImages()

Returns the ad's square marketing image assets, or null if this is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.Asset[]	The asset IDs of all square aspect ratio marketing images to be used in 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.

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 ResponsiveDisplayAd.isType for fully supported types.

Return values:

Type	Description
String	The type of the ad.

getYouTubeVideos()

Returns the ad's YouTube video assets, or null if the ad has none or if the ad is a legacy responsive display ad.

Return values:

Type	Description
AdsApp.Asset[]	The asset IDs of all YouTube videos used in the ad.

isEnabled()

Returns true if the ad is enabled.

Return values:

Type	Description
boolean	true if the ad is enabled.

isLegacy()

Returns true if this is a legacy responsive display ad, false otherwise.

Return values:

Type	Description
boolean	Boolean indicator whether or not this is a legacy repsonsive display ad.

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.