outlined_flag
The content represents an expanded text ad and provides methods for interacting with it.
You can apply, remove, and select labels associated with the ad.
Methods are available to get details about the ad, such as its description, headlines, paths, ID, and policy status.
You can retrieve statistics for the ad based on specified date ranges.
The ad can be enabled, paused, or removed using the provided methods.
Represents an expanded text 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:
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.
Return values:
Type Description
StringThe description of the ad.
getDescription1()
Returns the first description of the ad. This method returns the same as
ExpandedTextAd.getDescription Return values:
Type Description
StringThe first description of the ad.
getDescription2()
Returns the second description of the ad, if it has one.
Return values:
Type Description
StringThe second description of the ad, or null if the ad
doesn't have a second
description.
getEntityType()
Returns the type of this entity as a
String, in this case,
"Ad".
Return values:
Type Description
StringType of this entity: "Ad".
getHeadlinePart1()
Returns the first part of the ad's headline.
Return values:
Type Description
StringThe first part of the ad's headline.
getHeadlinePart2()
Returns the second part of the ad's headline.
Return values:
Type Description
StringThe second part of the ad's headline.
getHeadlinePart3()
Returns the third part of the ad's headline, if it has one.
Return values:
Type Description
StringThe third part of the ad's headline, or null if the ad
doesn't have a third
headline.
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.
getPath1()
Returns the first path that appears with the ad's displayed URL, if it has
one.
Return values:
Type Description
StringThe 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
StringThe 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
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 ExpandedTextAd.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.
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:
