To discuss and provide feedback on our products, join the official Google Ads Discord channel in the Google Advertising and Measurement Community server.

AdsApp.ResponsiveSearchAd

AI-generated Key Takeaways

This document describes a responsive ad for Search and its various methods.
Methods are available to apply or remove labels, enable or pause the ad, and remove it entirely.
You can retrieve information such as the ad group and campaign it belongs to, its headlines, descriptions, ID, and policy approval status.
The document provides methods to access stats for the ad based on predefined or custom date ranges.
You can check the enabled or paused status and access URL fields for the ad.

Represents a responsive ad for Search.

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.
getCampaign()	`AdsApp.Campaign`	Returns the campaign to which this ad belongs or `null` if it does not belong to a search or display campaign.
getDescriptions()	`AdsApp.AdTextAsset[]`	Returns the descriptions of the ad.
getEntityType()	`String`	Returns the type of this entity as a `String` , in this case, `"Ad"` .
getHeadlines()	`AdsApp.AdTextAsset[]`	Returns the headlines of the ad.
getId()	`String`	Returns the ID of the ad.
getPath1()	`String`	Returns the first path that appears with the ad's displayed URL, if it has one.
getPath2()	`String`	Returns the second path that appears with the ad's displayed URL, if it has one.
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(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.
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(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.

`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.

`getDescriptions()`

Returns the descriptions of the 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 headlines of the ad.

Return values:

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

`getPath1()`

Returns the first path that appears with the ad's displayed URL, if it has one.

Return values:

Type	Description
`String`	The first path that appears with the ad's displayed URL, or `null` if the ad doesn't have a display path.

`getPath2()`

Returns the second path that appears with the ad's displayed URL, if it has one.

Return values:

Type	Description
`String`	The second path that appears with the ad's displayed URL, or `null` if the ad doesn't have a second display path.

`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.

`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 ResponsiveSearchAd.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.

AdsApp.​ResponsiveSearchAd Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Methods:

applyLabel(name)

Arguments:

asType()

Return values:

enable()

getAdGroup()

Return values:

getCampaign()

Return values:

getDescriptions()

Return values:

getEntityType()

Return values:

getHeadlines()

Return values:

getId()

Return values:

getPath1()

Return values:

getPath2()

Return values:

getPolicyApprovalStatus()

Return values:

getPolicyTopics()

Return values:

getResourceName()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getType()

Return values:

isEnabled()

Return values:

isPaused()

Return values:

isType()

Return values:

labels()

Return values:

pause()

remove()

removeLabel(name)

Arguments:

urls()

Return values:

AdsApp.ResponsiveSearchAd

`applyLabel(name)`

`asType()`

`enable()`

`getAdGroup()`

`getCampaign()`

`getDescriptions()`

`getEntityType()`

`getHeadlines()`

`getId()`

`getPath1()`

`getPath2()`

`getPolicyApprovalStatus()`

`getPolicyTopics()`

`getResourceName()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`getType()`

`isEnabled()`

`isPaused()`

`isType()`

`labels()`

`pause()`

`remove()`

`removeLabel(name)`

`urls()`