Google_Service_Dfareporting_Placements_Resource Class Reference

The "placements" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Placements_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	generatetags ($profileId, $optParams=array())
	Generates tags for a placement.
	get ($profileId, $id, $optParams=array())
	Gets one placement by ID.
	insert ($profileId, Google_Service_Dfareporting_Placement $postBody, $optParams=array())
	Inserts a new placement.
	listPlacements ($profileId, $optParams=array())
	Retrieves a list of placements, possibly filtered.
	patch ($profileId, $id, Google_Service_Dfareporting_Placement $postBody, $optParams=array())
	Updates an existing placement.
	update ($profileId, Google_Service_Dfareporting_Placement $postBody, $optParams=array())
	Updates an existing placement.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "placements" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $placements = $dfareportingService->placements;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

generatetags()

Google_Service_Dfareporting_Placements_Resource::generatetags	(		$profileId,
			$optParams = array() )

Generates tags for a placement.

(placements.generatetags)

Parameters

string	$profileId	User profile ID associated with this request.
array	$optParams	Optional parameters.

@opt_param string tagFormats Tag formats to generate for these placements. @opt_param string placementIds Generate tags for these placements. @opt_param string campaignId Generate placements belonging to this campaign. This is a required field.

Return values

Google_Service_Dfareporting_PlacementsGenerateTagsResponse

get()

Google_Service_Dfareporting_Placements_Resource::get	(		$profileId,
			$id,
			$optParams = array() )

Gets one placement by ID.

(placements.get)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Placement ID.
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Placement

insert()

Google_Service_Dfareporting_Placements_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Placement	$postBody,
			$optParams = array() )

Inserts a new placement.

(placements.insert)

Parameters

string	$profileId	User profile ID associated with this request.
Google_Placement	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Placement

listPlacements()

Google_Service_Dfareporting_Placements_Resource::listPlacements	(		$profileId,
			$optParams = array() )

Retrieves a list of placements, possibly filtered.

(placements.listPlacements)

Parameters

string	$profileId	User profile ID associated with this request.
array	$optParams	Optional parameters.

@opt_param string placementStrategyIds Select only placements that are associated with these placement strategies. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param bool archived Select only archived placements. Don't set this field to select both archived and non-archived placements. @opt_param string searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". @opt_param string contentCategoryIds Select only placements that are associated with these content categories. @opt_param string directorySiteIds Select only placements that are associated with these directory sites. @opt_param string sortField Field by which to sort the list. @opt_param string advertiserIds Select only placements that belong to these advertisers. @opt_param string paymentSource Select only placements with this payment source. @opt_param string ids Select only placements with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string sizeIds Select only placements that are associated with these sizes. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string compatibilities Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. @opt_param string groupIds Select only placements that belong to these placement groups. @opt_param string pricingTypes Select only placements with these pricing types. @opt_param string siteIds Select only placements that are associated with these sites. @opt_param string campaignIds Select only placements that belong to these campaigns.

Return values

Google_Service_Dfareporting_PlacementsListResponse

patch()

Google_Service_Dfareporting_Placements_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Placement	$postBody,
			$optParams = array() )

Updates an existing placement.

This method supports patch semantics. (placements.patch)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Placement ID.
Google_Placement	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Placement

update()

Google_Service_Dfareporting_Placements_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Placement	$postBody,
			$optParams = array() )

Updates an existing placement.

(placements.update)

Parameters

string	$profileId	User profile ID associated with this request.
Google_Placement	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Placement

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Dfareporting.php