AdsApp.​Platform

Represents a Google Ads device target (either desktop, mobile, or tablet).

Methods:

MemberTypeDescription
getBaseCampaign AdsApp.Campaign Returns the base campaign to which this platform belongs.
getBidModifier double Returns the bid modifier for this platform.
getCampaign AdsApp.Campaign Returns the campaign to which this platform belongs or null if it does not belong to a search or display campaign.
getCampaignType String Returns the campaign type.
getEntityType String Returns the type of this entity as a String, in this case, "Platform".
getId String Returns the ID of the platform.
getName String Returns the name of this platform.
getResourceName String Returns the resource name of the platform.
getShoppingCampaign AdsApp.ShoppingCampaign Returns the shopping campaign to which this platform belongs or null if it does not belong to a shopping campaign.
getVideoCampaign AdsApp.VideoCampaign Returns the video campaign to which this platform belongs or null if it does not belong to a video campaign.
setBidModifier void Sets the bid modifier for this platform.

getBaseCampaign()

Returns the base campaign to which this platform belongs.

Return values:

TypeDescription
AdsApp.Campaign The base campaign to which this platform belongs.

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 metrics.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. 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 or null if it does not belong to a search or display campaign.

Return values:

TypeDescription
AdsApp.Campaign The campaign to which this platform belongs or null if it does not belong to a search or display campaign.

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
String 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.

getResourceName()

Returns the resource name of the platform.

Return values:

TypeDescription
String The resource name of the platform.

getShoppingCampaign()

Returns the shopping campaign to which this platform belongs or null if it does not belong to a shopping campaign.

Return values:

TypeDescription
AdsApp.ShoppingCampaign The shopping campaign to which this platform belongs or null if it does not belong to a shopping campaign.

getVideoCampaign()

Returns the video campaign to which this platform belongs or null if it does not belong to a video campaign.

Return values:

TypeDescription
AdsApp.VideoCampaign The video campaign to which this platform belongs or null if it does not belong to a video campaign.

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 metrics.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:

NameTypeDescription
modifier double The new bid modifier.