Google_Service_Dfareporting_DirectorySites_Resource Class Reference

The "directorySites" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_DirectorySites_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "directorySites" collection of methods.

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

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

Gets one directory site by ID.

(directorySites.get)

Parameters

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

Return values

Google_Service_Dfareporting_DirectorySite

insert()

Google_Service_Dfareporting_DirectorySites_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_DirectorySite	$postBody,
			$optParams = array() )

Inserts a new directory site.

(directorySites.insert)

Parameters

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

Return values

Google_Service_Dfareporting_DirectorySite

listDirectorySites()

Google_Service_Dfareporting_DirectorySites_Resource::listDirectorySites	(		$profileId,
			$optParams = array() )

Retrieves a list of directory sites, possibly filtered.

(directorySites.listDirectorySites)

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 URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". @opt_param string countryId Select only directory sites with this country ID. @opt_param string sortField Field by which to sort the list. @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 directory 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 directory sites that accept publisher paid placements. This field can be left blank. @opt_param string parentId Select only directory sites with this parent ID. @opt_param bool active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. @opt_param string dfp_network_code Select only directory sites with this DFP network code.

Return values

Google_Service_Dfareporting_DirectorySitesListResponse

---

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

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