Google_Service_Dfareporting_PlacementGroups_Resource

The "placementGroups" 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_PlacementGroups_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets one placement group by ID. (placementGroups.get) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Placement group ID. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Service_Dfareporting_PlacementGroup 
  9. */ 
  10. public function get($profileId, $id, $optParams = array()) 
  11. $params = array('profileId' => $profileId, 'id' => $id); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('get', array($params), "Google_Service_Dfareporting_PlacementGroup"); 
  14.  
  15. /** 
  16. * Inserts a new placement group. (placementGroups.insert) 
  17. * @param string $profileId User profile ID associated with this request. 
  18. * @param Google_PlacementGroup $postBody 
  19. * @param array $optParams Optional parameters. 
  20. * @return Google_Service_Dfareporting_PlacementGroup 
  21. */ 
  22. public function insert($profileId, Google_Service_Dfareporting_PlacementGroup $postBody, $optParams = array()) 
  23. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  24. $params = array_merge($params, $optParams); 
  25. return $this->call('insert', array($params), "Google_Service_Dfareporting_PlacementGroup"); 
  26.  
  27. /** 
  28. * Retrieves a list of placement groups, possibly filtered. 
  29. * (placementGroups.listPlacementGroups) 
  30. * @param string $profileId User profile ID associated with this request. 
  31. * @param array $optParams Optional parameters. 
  32. * @opt_param string placementStrategyIds Select only placement groups that are 
  33. * associated with these placement strategies. 
  34. * @opt_param bool archived Select only archived placements. Don't set this 
  35. * field to select both archived and non-archived placements. 
  36. * @opt_param string searchString Allows searching for placement groups by name 
  37. * or ID. Wildcards (*) are allowed. For example, "placement*2015" will return 
  38. * placement groups with names like "placement group June 2015", "placement 
  39. * group May 2015" or simply "placements 2015". Most of the searches also add 
  40. * wildcards implicitly at the start and the end of the search string. For 
  41. * example, a search string of "placementgroup" will match placement groups with 
  42. * name "my placementgroup", "placementgroup 2015" or simply "placementgroup". 
  43. * @opt_param string contentCategoryIds Select only placement groups that are 
  44. * associated with these content categories. 
  45. * @opt_param string directorySiteIds Select only placement groups that are 
  46. * associated with these directory sites. 
  47. * @opt_param string sortField Field by which to sort the list. 
  48. * @opt_param string advertiserIds Select only placement groups that belong to 
  49. * these advertisers. 
  50. * @opt_param string ids Select only placement groups with these IDs. 
  51. * @opt_param int maxResults Maximum number of results to return. 
  52. * @opt_param string pageToken Value of the nextPageToken from the previous 
  53. * result page. 
  54. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  55. * @opt_param string placementGroupType Select only placement groups belonging 
  56. * with this group type. A package is a simple group of placements that acts as 
  57. * a single pricing point for a group of tags. A roadblock is a group of 
  58. * placements that not only acts as a single pricing point but also assumes that 
  59. * all the tags in it will be served at the same time. A roadblock requires one 
  60. * of its assigned placements to be marked as primary for reporting. 
  61. * @opt_param string pricingTypes Select only placement groups with these 
  62. * pricing types. 
  63. * @opt_param string siteIds Select only placement groups that are associated 
  64. * with these sites. 
  65. * @opt_param string campaignIds Select only placement groups that belong to 
  66. * these campaigns. 
  67. * @return Google_Service_Dfareporting_PlacementGroupsListResponse 
  68. */ 
  69. public function listPlacementGroups($profileId, $optParams = array()) 
  70. $params = array('profileId' => $profileId); 
  71. $params = array_merge($params, $optParams); 
  72. return $this->call('list', array($params), "Google_Service_Dfareporting_PlacementGroupsListResponse"); 
  73.  
  74. /** 
  75. * Updates an existing placement group. This method supports patch semantics. 
  76. * (placementGroups.patch) 
  77. * @param string $profileId User profile ID associated with this request. 
  78. * @param string $id Placement group ID. 
  79. * @param Google_PlacementGroup $postBody 
  80. * @param array $optParams Optional parameters. 
  81. * @return Google_Service_Dfareporting_PlacementGroup 
  82. */ 
  83. public function patch($profileId, $id, Google_Service_Dfareporting_PlacementGroup $postBody, $optParams = array()) 
  84. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  85. $params = array_merge($params, $optParams); 
  86. return $this->call('patch', array($params), "Google_Service_Dfareporting_PlacementGroup"); 
  87.  
  88. /** 
  89. * Updates an existing placement group. (placementGroups.update) 
  90. * @param string $profileId User profile ID associated with this request. 
  91. * @param Google_PlacementGroup $postBody 
  92. * @param array $optParams Optional parameters. 
  93. * @return Google_Service_Dfareporting_PlacementGroup 
  94. */ 
  95. public function update($profileId, Google_Service_Dfareporting_PlacementGroup $postBody, $optParams = array()) 
  96. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  97. $params = array_merge($params, $optParams); 
  98. return $this->call('update', array($params), "Google_Service_Dfareporting_PlacementGroup");