outlined_flag
This content provides methods to manage and access information about a Google Ads ad within AdsApp.
You can apply, remove, and select labels associated with an ad using the provided methods.
Methods are available to enable, pause, and remove an ad.
You can retrieve details about the ad's structure, such as its associated ad group and campaign.
Information about the ad's content, including description lines, headline, and display URL, can be accessed.
Methods are included to check the policy approval status and retrieve policy topics for the ad.
You can get performance statistics for the ad based on predefined or custom date ranges.
Methods are available to check the enabled and paused status of the ad, as well as its mobile preference.
Access to type-specific fields and URL fields of the ad is provided through dedicated methods.
Represents a Google Ads ad.
Methods:
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
StringName of the label to apply.
asType()
Returns an
AdViewSpace , which
provides access to type-specific fields of the ad.
Return values:
enable()
Enables the ad.
Returns nothing.
getAdGroup()
Returns the ad group to which this ad belongs.
Return values:
getBaseAdGroup()
Returns the base ad group to which this ad belongs.
Return values:
Type Description
AdsApp.AdGroup The base ad group to which this ad belongs.
getBaseCampaign()
Returns the base campaign to which this ad belongs.
Return values:
Type Description
AdsApp.Campaign The base campaign 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.
getDescription1()
Returns the first line of the ad description or
null if the ad
is not a text ad.
Return values:
Type Description
StringThe first line of the ad description or null.
getDescription2()
Returns the second line of the ad description or
null if the
ad is not a text ad.
Return values:
Type Description
StringThe second line of the ad description or null.
getDisplayUrl()
Returns the display URL of the ad. Returns
null for some types
of ads.
Return values:
Type Description
StringThe display URL of the ad or null.
getEntityType()
Returns the type of this entity as a
String, in this case,
"Ad".
Return values:
Type Description
StringType of this entity: "Ad".
getHeadline()
Returns the headline of the ad or
null if the ad is not a text
ad.
Return values:
Type Description
StringThe headline of the ad or null.
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
StringThe ID 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
StringThe policy approval status of the ad.
getPolicyTopics()
Returns the list of policy topics associated with the ad.
Return values:
getResourceName()
Returns the resource name of the ad.
Return values:
Type Description
StringThe 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
StringDate 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
ObjectStart date of the date range. Must be either a string in
YYYYMMDD form, or an object with year,
month and day properties.
dateTo
ObjectEnd 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 Ad.isType for fully supported types.
Return values:
Type Description
StringThe type of the ad.
isEnabled()
Returns
true if the ad is enabled.
Return values:
Type Description
booleantrue if the ad is enabled.
isMobilePreferred()
Returns
true if the ad specifies mobile device preference or
false otherwise.
Return values:
Type Description
booleanWhether the ad is mobile-preferred.
isPaused()
Returns
true if the ad is paused.
Return values:
Type Description
booleantrue if the ad is paused.
isType()
Returns an
AdTypeSpace , which
determines the type of the ad.
Return values:
labels()
Creates a selector of all labels applied to the ad.
Return values:
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
StringName of the label.
urls()
Provides access to this ad's URL fields. See
Using Upgraded
URLs for more information.
Return values:
