AdWordsApp.​Platform

Represents an AdWords device target (either desktop, mobile, or tablet).

Methods:

MemberTypeDescription
getBidModifier double Returns the bid modifier for this platform.
getCampaign AdWordsApp.Campaign Returns the campaign to which this platform belongs.
getCampaignType String Returns the campaign type.
getEntityType String Returns the type of this entity as a String, in this case, "Platform".
getId long Returns the ID of the platform.
getName String Returns the name of this platform.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getVideoCampaign AdWordsApp.VideoCampaign Returns the video campaign to which this platform belongs.
setBidModifier void Sets the bid modifier for this platform.

getBidModifier()

Returns the bid modifier for this platform.

The bid modifier is a multiplier applied to bids which match this platform. So, for instance, a bid modifier of 1.1 increases the bid to 110% of its original value, and changes a bid of $5.00 to a bid of $5.50.

The bid modifiers for all matching criteria are multiplied together to calculate the actual bid modification. A campaign with the following bid modifiers:

TypeValueBid Modifier
LocationLaos1.3
Ad ScheduleSaturday 6AM-10AM0.9
PlatformMobile1.1
would have a combined bid modifier of 1.3 * 0.9 * 1.1 = 1.287, so a bid of $10 would get increased to $12.87 for clicks by Laotian smartphone users on Saturday mornings in the account timezone.

For more information about bid modifiers, please see the AdWords Help Center article.

If no bid modifier is set, the default value is 1.

Return values:

TypeDescription
double The criterion bid modifier.

getCampaign()

Returns the campaign to which this platform belongs.

Return values:

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

getCampaignType()

Returns the campaign type. Possible return values:

SEARCH_OR_DISPLAY, VIDEO, SHOPPING

Return values:

TypeDescription
String Video campaign type.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "Platform".

getId()

Returns the ID of the platform.

Platform IDs are shared across campaigns. Specifically, desktop targets have ID 30000, mobile targets have ID 30001, and tablet targets have ID 30002. In order to uniquely identify a platform target, one must specify both its campaign ID and the platform ID.

Return values:

TypeDescription
long The ID of the platform.

getName()

Returns the name of this platform.

This will be "Desktop" for desktop targets, "HighEndMobile" for mobile targets, or "Tablet" for tablet targets.

Return values:

TypeDescription
String The name of this platform.

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 = platform.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.

getVideoCampaign()

Returns the video campaign to which this platform belongs.

Return values:

TypeDescription
AdWordsApp.VideoCampaign The video campaign to which this platform belongs.

setBidModifier(modifier)

Sets the bid modifier for this platform.

The bid modifier is a multiplier applied to bids which match this platform. So, for instance, a bid modifier of 1.1 increases the bid to 110% of its original value, and changes a bid of $5.00 to a bid of $5.50.

The bid modifiers for all matching criteria are multiplied together to calculate the actual bid modification. A campaign with the following bid modifiers:

TypeValueBid Modifier
LocationLaos1.3
Ad ScheduleSaturday 6AM-10AM0.9
PlatformMobile1.1
would have a combined bid modifier of 1.3 * 0.9 * 1.1 = 1.287, so a bid of $10 would get increased to $12.87 for clicks by Laotian smartphone users on Saturday mornings in the account timezone.

For more information about bid modifiers, please see the AdWords Help Center article.

For mobile targets, acceptable bid modifiers are either 0, or in the range from 0.1 to 4.

Setting bid modifiers is only supported for mobile targets. Attempting to set a bid modifier for a desktop target or for a tablet target will fail.

Returns nothing.

Arguments:

NameTypeDescription
modifier double The new bid modifier.

发送以下问题的反馈:

此网页
AdWords Scripts
AdWords Scripts
需要帮助?请访问我们的支持页面