AdWordsApp.​Html5Ad

Represents an HTML5 ad.

Methods:

MemberTypeDescription
applyLabel void Applies a label to the ad.
asType AdWordsApp.AdViewSpace Returns an AdViewSpace, which provides access to type-specific fields of the ad.
enable void Enables the ad.
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad belongs.
getApprovalStatus String Returns the approval status of the ad.
getCampaign AdWordsApp.Campaign Returns the campaign to which this ad belongs.
getDisapprovalReasons String[] Returns the array of disapproval reasons.
getEntityType String Returns the type of this entity as a String, in this case, "Ad".
getEntryPoint String Returns the entry point of the ad's media bundle.
getId long Returns the ID of the ad.
getMediaBundle AdWordsApp.Media Returns the media bundle for the ad.
getName String Returns the name of the ad.
getPolicyApprovalStatus String Returns the policy approval status of the ad.
getPolicyTopics AdWordsApp.PolicyTopic[] Returns the list of policy topics associated with the ad.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.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 AdWordsApp.AdTypeSpace Returns an AdTypeSpace, which determines the type of the ad.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the ad.
pause void Pauses the ad.
remove void Removes the ad.
removeLabel void Removes a label from the ad.
urls AdWordsApp.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 not have more than 50 labels.

Returns nothing.

Arguments:

NameTypeDescription
name String Name of the label to apply.

asType()

Returns an AdViewSpace, which provides access to type-specific fields of the ad.

Return values:

TypeDescription
AdWordsApp.AdViewSpace An AdViewSpace.

enable()

Enables the ad.

Returns nothing.

getAdGroup()

Returns the ad group to which this ad belongs.

Return values:

TypeDescription
AdWordsApp.AdGroup The ad group to which this ad belongs.

getApprovalStatus()

Returns the approval status of the ad. Possible values: APPROVED, DISAPPROVED, FAMILY_SAFE, NON_FAMILY_SAFE, PORN, UNCHECKED.

Return values:

TypeDescription
String The approval status of the ad.

getCampaign()

Returns the campaign to which this ad belongs.

Return values:

TypeDescription
AdWordsApp.Campaign The campaign to which this ad belongs.

getDisapprovalReasons()

Returns the array of disapproval reasons.

The returned array will contain entries like 'Editorial Standards-Spacing', 'Inaccurate Display URL', etc. An empty array will be returned if the ad has not been disapproved.

Return values:

TypeDescription
String[] The disapproval reasons of the ad.

getEntityType()

Returns the type of this entity as a String, in this case, "Ad".

Return values:

TypeDescription
String Type of this entity: "Ad".

getEntryPoint()

Returns the entry point of the ad's media bundle.

Return values:

TypeDescription
String The entry point of the ad's media bundle.

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:

TypeDescription
long The ID of the ad.

getMediaBundle()

Returns the media bundle for the ad.

Return values:

TypeDescription
AdWordsApp.Media The media bundle for the ad.

getName()

Returns the name of the ad.

Return values:

TypeDescription
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:

TypeDescription
String The policy approval status of the ad.

getPolicyTopics()

Returns the list of policy topics associated with the ad.

Return values:

TypeDescription
AdWordsApp.PolicyTopic[] The policy topics 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:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
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:

TypeDescription
AdWordsApp.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 Html5Ad.isType for fully supported types.

Return values:

TypeDescription
String The type of the ad.

isEnabled()

Returns true if the ad is enabled.

Return values:

TypeDescription
boolean true if the ad is enabled.

isPaused()

Returns true if the ad is paused.

Return values:

TypeDescription
boolean true if the ad is paused.

isType()

Returns an AdTypeSpace, which determines the type of the ad.

Return values:

TypeDescription
AdWordsApp.AdTypeSpace An AdTypeSpace.

labels()

Creates a selector of all labels applied to the ad.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
name String Name of the label.

urls()

Provides access to this ad's URL fields. See Using Upgraded URLs for more information.

Return values:

TypeDescription
AdWordsApp.AdUrls Access to this ad's URL fields.

Оставить отзыв о...

Текущей странице
AdWords Scripts
AdWords Scripts
Нужна помощь? Обратитесь в службу поддержки.