Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_AdExchangeBuyer_Marketplaceorders_Resource Class Reference

The "marketplaceorders" collection of methods. More...

Inheritance diagram for Google_Service_AdExchangeBuyer_Marketplaceorders_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($orderId, $optParams=array())
 Get an order given its id (marketplaceorders.get)
 
 insert (Google_Service_AdExchangeBuyer_CreateOrdersRequest $postBody, $optParams=array())
 Create the given list of orders (marketplaceorders.insert)
 
 patch ($orderId, $revisionNumber, $updateAction, Google_Service_AdExchangeBuyer_MarketplaceOrder $postBody, $optParams=array())
 Update the given order.
 
 search ($optParams=array())
 Search for orders using pql query (marketplaceorders.search)
 
 update ($orderId, $revisionNumber, $updateAction, Google_Service_AdExchangeBuyer_MarketplaceOrder $postBody, $optParams=array())
 Update the given order (marketplaceorders.update)
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "marketplaceorders" collection of methods.

Typical usage is: $adexchangebuyerService = new Google_Service_AdExchangeBuyer(...); $marketplaceorders = $adexchangebuyerService->marketplaceorders;

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_AdExchangeBuyer_Marketplaceorders_Resource::get ( $orderId,
$optParams = array() )

Get an order given its id (marketplaceorders.get)

Parameters
string$orderIdId of the order to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_AdExchangeBuyer_MarketplaceOrder

◆ insert()

Google_Service_AdExchangeBuyer_Marketplaceorders_Resource::insert ( Google_Service_AdExchangeBuyer_CreateOrdersRequest $postBody,
$optParams = array() )

Create the given list of orders (marketplaceorders.insert)

Parameters
Google_CreateOrdersRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdExchangeBuyer_CreateOrdersResponse

◆ patch()

Google_Service_AdExchangeBuyer_Marketplaceorders_Resource::patch ( $orderId,
$revisionNumber,
$updateAction,
Google_Service_AdExchangeBuyer_MarketplaceOrder $postBody,
$optParams = array() )

Update the given order.

This method supports patch semantics. (marketplaceorders.patch)

Parameters
string$orderIdThe order id to update.
string$revisionNumberThe last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.
string$updateActionThe proposed action to take on the order.
Google_MarketplaceOrder$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdExchangeBuyer_MarketplaceOrder

◆ search()

Google_Service_AdExchangeBuyer_Marketplaceorders_Resource::search ( $optParams = array())

Search for orders using pql query (marketplaceorders.search)

Parameters
array$optParamsOptional parameters.

@opt_param string pqlQuery Query string to retrieve specific orders.

Return values
Google_Service_AdExchangeBuyer_GetOrdersResponse

◆ update()

Google_Service_AdExchangeBuyer_Marketplaceorders_Resource::update ( $orderId,
$revisionNumber,
$updateAction,
Google_Service_AdExchangeBuyer_MarketplaceOrder $postBody,
$optParams = array() )

Update the given order (marketplaceorders.update)

Parameters
string$orderIdThe order id to update.
string$revisionNumberThe last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.
string$updateActionThe proposed action to take on the order.
Google_MarketplaceOrder$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdExchangeBuyer_MarketplaceOrder

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