Google_Service_Dfareporting_OrderDocuments_Resource Class Reference

The "orderDocuments" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_OrderDocuments_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($profileId, $projectId, $id, $optParams=array())
	Gets one order document by ID.
	listOrderDocuments ($profileId, $projectId, $optParams=array())
	Retrieves a list of order documents, possibly filtered.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "orderDocuments" collection of methods.

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

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

Gets one order document by ID.

(orderDocuments.get)

Parameters

string	$profileId	User profile ID associated with this request.
string	$projectId	Project ID for order documents.
string	$id	Order document ID.
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_OrderDocument

listOrderDocuments()

Google_Service_Dfareporting_OrderDocuments_Resource::listOrderDocuments	(		$profileId,
			$projectId,
			$optParams = array() )

Retrieves a list of order documents, possibly filtered.

(orderDocuments.listOrderDocuments)

Parameters

string	$profileId	User profile ID associated with this request.
string	$projectId	Project ID for order documents.
array	$optParams	Optional parameters.

@opt_param string orderId Select only order documents for specified orders. @opt_param string searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 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 "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". @opt_param string ids Select only order documents 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 siteId Select only order documents that are associated with these sites. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string sortField Field by which to sort the list. @opt_param bool approved Select only order documents that have been approved by at least one user.

Return values

Google_Service_Dfareporting_OrderDocumentsListResponse

---

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

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