AdsApp.​Placement

Represents a Google Ads website placement.

Mobile app placements and mobile app category placements are not supported.

Methods:

Member Type Description
AdsApp.DisplayCriterionBidding Provides access to this placement's bidding fields.
AdsApp.AdGroup Returns the ad group to which this placement belongs.
AdsApp.AdGroup Returns the base ad group to which this placement belongs.
AdsApp.Campaign Returns the base campaign to which this placement belongs.
AdsApp.Campaign Returns the campaign to which this placement belongs or null if it does not belong to a search or display campaign.
String Returns the ID of the placement.
String Returns the resource name of the placement.
AdsApp.Stats Returns stats for the specified date range.
AdsApp.Stats Returns stats for the specified custom date range.
String Returns the URL of the placement.
boolean Returns true if the placement is enabled.
boolean This method is deprecated and will always return true .
boolean Returns true if the placement is paused.
void Removes the placement.

bidding()

Provides access to this placement's bidding fields.

Return values:

Type Description
AdsApp.DisplayCriterionBidding Access to this placement's bidding fields.

getAdGroup()

Returns the ad group to which this placement belongs.

Return values:

Type Description
AdsApp.AdGroup The ad group to which this placement belongs.

getBaseAdGroup()

Returns the base ad group to which this placement belongs.

Return values:

Type Description
AdsApp.AdGroup The base ad group to which this placement belongs.

getBaseCampaign()

Returns the base campaign to which this placement belongs.

Return values:

Type Description
AdsApp.Campaign The base campaign to which this placement belongs.

getCampaign()

Returns the campaign to which this placement 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 placement belongs or null if it does not belong to a search or display campaign.

getId()

Returns the ID of the placement.

Returns 0 if the placement is automatic.

Return values:

Type Description
String The ID of the placement.

getResourceName()

Returns the resource name of the placement.

Return values:

Type Description
String The resource name of the placement.

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

getUrl()

Returns the URL of the placement.

Return values:

Type Description
String The URL of the placement.

isEnabled()

Returns true if the placement is enabled.

Return values:

Type Description
boolean true if the placement is enabled.

isManaged()

This method is deprecated and will always return true . All placements returned by a PlacementIterator are managed.

Return values:

Type Description
boolean true .

isPaused()

Returns true if the placement is paused.

Return values:

Type Description
boolean true if the placement is paused.

remove()

Removes the placement.

Returns nothing.

Create a Mobile Website
View Site in Mobile | Classic
Share by: