Represents a Gmail single promotion 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 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:
enable()
Enables the ad.
Returns nothing.
getAdGroup()
Returns the ad group to which this ad belongs.
Return values:
getAdvertiser()
Returns the advertiser shown in the ad.
Return values:
| Type | Description |
|---|
String |
The advertiser shown in the ad. |
getCallToAction()
Returns the call to action of the ad.
Return values:
| Type | Description |
|---|
String |
The call to action of the ad. |
Returns the call to action button color hex code of the ad.
Return values:
| Type | Description |
|---|
String |
The call to action button color of the ad. |
getCallToActionTextColor()
Returns the call to action text color hex code of the ad.
Return values:
| Type | Description |
|---|
String |
The call to action text of 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". |
Returns the ad's header image.
Return values:
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 |
|---|
long |
The ID of the ad. |
getImage()
Returns the ad's image.
Return values:
getLogo()
Returns the ad's logo image.
Return values:
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
AdWords 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:
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 GmailSinglePromotionAd.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:
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 |
String |
Name of the label. |
urls()
Provides access to this ad's URL fields. See
Using Upgraded URLs for more
information.
Return values:
