Methods:
Member | Type | Description |
---|---|---|
getBidModifier | double |
Returns the bid modifier for this shopping platform. |
getCampaign | AdsApp.ShoppingCampaign |
Returns the campaign to which this platform belongs. |
getEntityType | String |
Returns the type of this entity as a String , in this case, "ShoppingPlatform" . |
getId | long |
Returns the ID of the shopping platform. |
getName | String |
Returns the name of this platform. |
getStatsFor | AdsApp.Stats |
Returns stats for the specified date range. |
getStatsFor | AdsApp.Stats |
Returns stats for the specified custom date range. |
setBidModifier | void |
Sets the bid modifier for this shopping platform. |
getBidModifier()
Returns the bid modifier for this shopping platform.
The bid modifier is a multiplier applied to bids which match this shopping 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:
Type | Value | Bid Modifier |
---|---|---|
Location | Laos | 1.3 |
Ad Schedule | Saturday 6AM-10AM | 0.9 |
Platform | Mobile | 1.1 |
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 Google Ads Help Center article. Platform bid modifiers are only set for mobile targets.
Desktop and tablet targets will always return a bid modifier of 1
to reflect that
their bid is not modified.
Return values:
Type | Description |
---|---|
double |
The criterion bid modifier. |
getCampaign()
Returns the campaign to which this platform belongs.Return values:
Type | Description |
---|---|
AdsApp.ShoppingCampaign |
The campaign to which this platform belongs. |
getEntityType()
Returns the type of this entity as a String
, in this case, "ShoppingPlatform"
.Return values:
Type | Description |
---|---|
String |
Type of this entity: "ShoppingPlatform" . |
getId()
Returns the ID of the shopping 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:
Type | Description |
---|---|
long |
The ID of the shopping 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:
Type | Description |
---|---|
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 = shopping platform.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. |
setBidModifier(modifier)
Sets the bid modifier for this shopping platform.
The bid modifier is a multiplier applied to bids which match this shopping 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:
Type | Value | Bid Modifier |
---|---|---|
Location | Laos | 1.3 |
Ad Schedule | Saturday 6AM-10AM | 0.9 |
Platform | Mobile | 1.1 |
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 Google Ads 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:
Name | Type | Description |
---|---|---|
modifier | double |
The new bid modifier. |