Google_Service_AdExchangeBuyer_Proposals_Resource

The "proposals" collection of methods.

Defined (1)

The class is defined in the following location(s).

/vendor/google/apiclient/src/Google/Service/AdExchangeBuyer.php  
  1. class Google_Service_AdExchangeBuyer_Proposals_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Get a proposal given its id (proposals.get) 
  5. * @param string $proposalId Id of the proposal to retrieve. 
  6. * @param array $optParams Optional parameters. 
  7. * @return Google_Service_AdExchangeBuyer_Proposal 
  8. */ 
  9. public function get($proposalId, $optParams = array()) 
  10. $params = array('proposalId' => $proposalId); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('get', array($params), "Google_Service_AdExchangeBuyer_Proposal"); 
  13.  
  14. /** 
  15. * Create the given list of proposals (proposals.insert) 
  16. * @param Google_CreateOrdersRequest $postBody 
  17. * @param array $optParams Optional parameters. 
  18. * @return Google_Service_AdExchangeBuyer_CreateOrdersResponse 
  19. */ 
  20. public function insert(Google_Service_AdExchangeBuyer_CreateOrdersRequest $postBody, $optParams = array()) 
  21. $params = array('postBody' => $postBody); 
  22. $params = array_merge($params, $optParams); 
  23. return $this->call('insert', array($params), "Google_Service_AdExchangeBuyer_CreateOrdersResponse"); 
  24.  
  25. /** 
  26. * Update the given proposal. This method supports patch semantics. 
  27. * (proposals.patch) 
  28. * @param string $proposalId The proposal id to update. 
  29. * @param string $revisionNumber The last known revision number to update. If 
  30. * the head revision in the marketplace database has since changed, an error 
  31. * will be thrown. The caller should then fetch the latest proposal at head 
  32. * revision and retry the update at that revision. 
  33. * @param string $updateAction The proposed action to take on the proposal. 
  34. * @param Google_Proposal $postBody 
  35. * @param array $optParams Optional parameters. 
  36. * @return Google_Service_AdExchangeBuyer_Proposal 
  37. */ 
  38. public function patch($proposalId, $revisionNumber, $updateAction, Google_Service_AdExchangeBuyer_Proposal $postBody, $optParams = array()) 
  39. $params = array('proposalId' => $proposalId, 'revisionNumber' => $revisionNumber, 'updateAction' => $updateAction, 'postBody' => $postBody); 
  40. $params = array_merge($params, $optParams); 
  41. return $this->call('patch', array($params), "Google_Service_AdExchangeBuyer_Proposal"); 
  42.  
  43. /** 
  44. * Search for proposals using pql query (proposals.search) 
  45. * @param array $optParams Optional parameters. 
  46. * @opt_param string pqlQuery Query string to retrieve specific proposals. 
  47. * @return Google_Service_AdExchangeBuyer_GetOrdersResponse 
  48. */ 
  49. public function search($optParams = array()) 
  50. $params = array(); 
  51. $params = array_merge($params, $optParams); 
  52. return $this->call('search', array($params), "Google_Service_AdExchangeBuyer_GetOrdersResponse"); 
  53.  
  54. /** 
  55. * Update the given proposal (proposals.update) 
  56. * @param string $proposalId The proposal id to update. 
  57. * @param string $revisionNumber The last known revision number to update. If 
  58. * the head revision in the marketplace database has since changed, an error 
  59. * will be thrown. The caller should then fetch the latest proposal at head 
  60. * revision and retry the update at that revision. 
  61. * @param string $updateAction The proposed action to take on the proposal. 
  62. * @param Google_Proposal $postBody 
  63. * @param array $optParams Optional parameters. 
  64. * @return Google_Service_AdExchangeBuyer_Proposal 
  65. */ 
  66. public function update($proposalId, $revisionNumber, $updateAction, Google_Service_AdExchangeBuyer_Proposal $postBody, $optParams = array()) 
  67. $params = array('proposalId' => $proposalId, 'revisionNumber' => $revisionNumber, 'updateAction' => $updateAction, 'postBody' => $postBody); 
  68. $params = array_merge($params, $optParams); 
  69. return $this->call('update', array($params), "Google_Service_AdExchangeBuyer_Proposal");