Google_Service_Dfareporting_PlacementStrategies_Resource

The "placementStrategies" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Dfareporting.php  
  1. class Google_Service_Dfareporting_PlacementStrategies_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes an existing placement strategy. (placementStrategies.delete) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Placement strategy ID. 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($profileId, $id, $optParams = array()) 
  10. $params = array('profileId' => $profileId, 'id' => $id); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Gets one placement strategy by ID. (placementStrategies.get) 
  16. * @param string $profileId User profile ID associated with this request. 
  17. * @param string $id Placement strategy ID. 
  18. * @param array $optParams Optional parameters. 
  19. * @return Google_Service_Dfareporting_PlacementStrategy 
  20. */ 
  21. public function get($profileId, $id, $optParams = array()) 
  22. $params = array('profileId' => $profileId, 'id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('get', array($params), "Google_Service_Dfareporting_PlacementStrategy"); 
  25.  
  26. /** 
  27. * Inserts a new placement strategy. (placementStrategies.insert) 
  28. * @param string $profileId User profile ID associated with this request. 
  29. * @param Google_PlacementStrategy $postBody 
  30. * @param array $optParams Optional parameters. 
  31. * @return Google_Service_Dfareporting_PlacementStrategy 
  32. */ 
  33. public function insert($profileId, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams = array()) 
  34. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  35. $params = array_merge($params, $optParams); 
  36. return $this->call('insert', array($params), "Google_Service_Dfareporting_PlacementStrategy"); 
  37.  
  38. /** 
  39. * Retrieves a list of placement strategies, possibly filtered. 
  40. * (placementStrategies.listPlacementStrategies) 
  41. * @param string $profileId User profile ID associated with this request. 
  42. * @param array $optParams Optional parameters. 
  43. * @opt_param string searchString Allows searching for objects by name or ID. 
  44. * Wildcards (*) are allowed. For example, "placementstrategy*2015" will return 
  45. * objects with names like "placementstrategy June 2015", "placementstrategy 
  46. * April 2015" or simply "placementstrategy 2015". Most of the searches also add 
  47. * wildcards implicitly at the start and the end of the search string. For 
  48. * example, a search string of "placementstrategy" will match objects with name 
  49. * "my placementstrategy", "placementstrategy 2015" or simply 
  50. * "placementstrategy". 
  51. * @opt_param string sortField Field by which to sort the list. 
  52. * @opt_param string ids Select only placement strategies with these IDs. 
  53. * @opt_param int maxResults Maximum number of results to return. 
  54. * @opt_param string pageToken Value of the nextPageToken from the previous 
  55. * result page. 
  56. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  57. * @return Google_Service_Dfareporting_PlacementStrategiesListResponse 
  58. */ 
  59. public function listPlacementStrategies($profileId, $optParams = array()) 
  60. $params = array('profileId' => $profileId); 
  61. $params = array_merge($params, $optParams); 
  62. return $this->call('list', array($params), "Google_Service_Dfareporting_PlacementStrategiesListResponse"); 
  63.  
  64. /** 
  65. * Updates an existing placement strategy. This method supports patch semantics. 
  66. * (placementStrategies.patch) 
  67. * @param string $profileId User profile ID associated with this request. 
  68. * @param string $id Placement strategy ID. 
  69. * @param Google_PlacementStrategy $postBody 
  70. * @param array $optParams Optional parameters. 
  71. * @return Google_Service_Dfareporting_PlacementStrategy 
  72. */ 
  73. public function patch($profileId, $id, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams = array()) 
  74. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  75. $params = array_merge($params, $optParams); 
  76. return $this->call('patch', array($params), "Google_Service_Dfareporting_PlacementStrategy"); 
  77.  
  78. /** 
  79. * Updates an existing placement strategy. (placementStrategies.update) 
  80. * @param string $profileId User profile ID associated with this request. 
  81. * @param Google_PlacementStrategy $postBody 
  82. * @param array $optParams Optional parameters. 
  83. * @return Google_Service_Dfareporting_PlacementStrategy 
  84. */ 
  85. public function update($profileId, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams = array()) 
  86. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  87. $params = array_merge($params, $optParams); 
  88. return $this->call('update', array($params), "Google_Service_Dfareporting_PlacementStrategy");