Google_Service_Dfareporting_PlacementGroups_Resource Class Reference

The "placementGroups" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_PlacementGroups_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "placementGroups" collection of methods.

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

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

get()

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

Gets one placement group by ID.

(placementGroups.get)

Parameters

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

Return values

Google_Service_Dfareporting_PlacementGroup

insert()

Google_Service_Dfareporting_PlacementGroups_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_PlacementGroup	$postBody,
			$optParams = array() )

Inserts a new placement group.

(placementGroups.insert)

Parameters

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

Return values

Google_Service_Dfareporting_PlacementGroup

listPlacementGroups()

Google_Service_Dfareporting_PlacementGroups_Resource::listPlacementGroups	(		$profileId,
			$optParams = array() )

Retrieves a list of placement groups, possibly filtered.

(placementGroups.listPlacementGroups)

Parameters

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

@opt_param string placementStrategyIds Select only placement groups that are associated with these placement strategies. @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 placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group 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 "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". @opt_param string contentCategoryIds Select only placement groups that are associated with these content categories. @opt_param string directorySiteIds Select only placement groups that are associated with these directory sites. @opt_param string sortField Field by which to sort the list. @opt_param string advertiserIds Select only placement groups that belong to these advertisers. @opt_param string ids Select only placement groups with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. @opt_param string pricingTypes Select only placement groups with these pricing types. @opt_param string siteIds Select only placement groups that are associated with these sites. @opt_param string campaignIds Select only placement groups that belong to these campaigns.

Return values

Google_Service_Dfareporting_PlacementGroupsListResponse

patch()

Google_Service_Dfareporting_PlacementGroups_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_PlacementGroup	$postBody,
			$optParams = array() )

Updates an existing placement group.

This method supports patch semantics. (placementGroups.patch)

Parameters

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

Return values

Google_Service_Dfareporting_PlacementGroup

update()

Google_Service_Dfareporting_PlacementGroups_Resource::update	(		$profileId,
		Google_Service_Dfareporting_PlacementGroup	$postBody,
			$optParams = array() )

Updates an existing placement group.

(placementGroups.update)

Parameters

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

Return values

Google_Service_Dfareporting_PlacementGroup

---

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

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