AdsApp.​VideoPlacement

Represents a Google Ads Placement in a Video Campaign.

Methods:

Member	Type	Description
bidding	AdsApp.VideoCriterionBidding	Provides access to bidding fields of this video placement.
getEntityType	String	Returns the type of this entity as a String, in this case, "VideoPlacement".
getId	String	Returns the ID of the video placement.
getResourceName	String	Returns the resource name of the video placement.
getStatsFor	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor	AdsApp.Stats	Returns stats for the specified custom date range.
getUrl	String	Returns the URL of the placement.
getVideoAdGroup	AdsApp.VideoAdGroup	Returns the ad group to which this video placement belongs.
getVideoCampaign	AdsApp.VideoCampaign	Returns the campaign to which this video placement belongs.
isEnabled	boolean	Returns true if the video placement is enabled.
isManaged	boolean	Returns true if the placement is managed.
isPaused	boolean	Returns true if the video placement is paused.
remove	void	Removes the video placement.

bidding()

Provides access to bidding fields of this video placement.

Return values:

Type	Description
AdsApp.VideoCriterionBidding	Access to bidding fields of this video placement.

getEntityType()

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

Return values:

Type	Description
String	Type of this entity: "VideoPlacement".

getId()

Returns the ID of the video placement.

Return values:

Type	Description
String	The ID of the video placement.

getResourceName()

Returns the resource name of the video placement.

Return values:

Type	Description
String	The resource name of the video 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.

getVideoAdGroup()

Returns the ad group to which this video placement belongs.

Return values:

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

getVideoCampaign()

Returns the campaign to which this video placement belongs.

Return values:

Type	Description
AdsApp.VideoCampaign	The campaign to which this video placement belongs.

isEnabled()

Returns true if the video placement is enabled.

Return values:

Type	Description
boolean	true if the video placement is enabled.

isManaged()

Returns true if the placement is managed. Returns false if the placement is automatic.

Return values:

Type	Description
boolean	true if the placement is managed.

isPaused()

Returns true if the video placement is paused.

Return values:

Type	Description
boolean	true if the video placement is paused.

remove()

Removes the video placement.

Returns nothing.