Google_Service_Dfareporting_Orders_Resource Class Reference

The "orders" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Orders_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "orders" collection of methods.

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

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

Gets one order by ID.

(orders.get)

Parameters

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

Return values

Google_Service_Dfareporting_Order

listOrders()

Google_Service_Dfareporting_Orders_Resource::listOrders	(		$profileId,
			$projectId,
			$optParams = array() )

Retrieves a list of orders, possibly filtered.

(orders.listOrders)

Parameters

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

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

Return values

Google_Service_Dfareporting_OrdersListResponse

---

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

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