Google_Service_Dfareporting_Sites_Resource Class Reference

The "sites" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Sites_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "sites" collection of methods.

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

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_Sites_Resource::get	(		$profileId,
			$id,
			$optParams = array() )

Gets one site by ID.

(sites.get)

Parameters

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

Return values

Google_Service_Dfareporting_Site

insert()

Google_Service_Dfareporting_Sites_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Site	$postBody,
			$optParams = array() )

Inserts a new site.

(sites.insert)

Parameters

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

Return values

Google_Service_Dfareporting_Site

listSites()

Google_Service_Dfareporting_Sites_Resource::listSites	(		$profileId,
			$optParams = array() )

Retrieves a list of sites, possibly filtered.

(sites.listSites)

Parameters

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

@opt_param bool acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 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 "site" will match objects with name "my site", "site 2015", or simply "site". @opt_param string subaccountId Select only sites with this subaccount ID. @opt_param string directorySiteIds Select only sites with these directory site IDs. @opt_param bool acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. @opt_param string ids Select only sites 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 bool acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. @opt_param string sortField Field by which to sort the list. @opt_param bool adWordsSite Select only AdWords sites. @opt_param bool unmappedSite Select only sites that have not been mapped to a directory site. @opt_param bool approved Select only approved sites. @opt_param string campaignIds Select only sites with these campaign IDs.

Return values

Google_Service_Dfareporting_SitesListResponse

patch()

Google_Service_Dfareporting_Sites_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Site	$postBody,
			$optParams = array() )

Updates an existing site.

This method supports patch semantics. (sites.patch)

Parameters

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

Return values

Google_Service_Dfareporting_Site

update()

Google_Service_Dfareporting_Sites_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Site	$postBody,
			$optParams = array() )

Updates an existing site.

(sites.update)

Parameters

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

Return values

Google_Service_Dfareporting_Site

---

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

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