Google_Service_Dfareporting_FloodlightActivityGroups_Resource

The "floodlightActivityGroups" 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_FloodlightActivityGroups_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes an existing floodlight activity group. 
  5. * (floodlightActivityGroups.delete) 
  6. * @param string $profileId User profile ID associated with this request. 
  7. * @param string $id Floodlight activity Group ID. 
  8. * @param array $optParams Optional parameters. 
  9. */ 
  10. public function delete($profileId, $id, $optParams = array()) 
  11. $params = array('profileId' => $profileId, 'id' => $id); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('delete', array($params)); 
  14.  
  15. /** 
  16. * Gets one floodlight activity group by ID. (floodlightActivityGroups.get) 
  17. * @param string $profileId User profile ID associated with this request. 
  18. * @param string $id Floodlight activity Group ID. 
  19. * @param array $optParams Optional parameters. 
  20. * @return Google_Service_Dfareporting_FloodlightActivityGroup 
  21. */ 
  22. public function get($profileId, $id, $optParams = array()) 
  23. $params = array('profileId' => $profileId, 'id' => $id); 
  24. $params = array_merge($params, $optParams); 
  25. return $this->call('get', array($params), "Google_Service_Dfareporting_FloodlightActivityGroup"); 
  26.  
  27. /** 
  28. * Inserts a new floodlight activity group. (floodlightActivityGroups.insert) 
  29. * @param string $profileId User profile ID associated with this request. 
  30. * @param Google_FloodlightActivityGroup $postBody 
  31. * @param array $optParams Optional parameters. 
  32. * @return Google_Service_Dfareporting_FloodlightActivityGroup 
  33. */ 
  34. public function insert($profileId, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams = array()) 
  35. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  36. $params = array_merge($params, $optParams); 
  37. return $this->call('insert', array($params), "Google_Service_Dfareporting_FloodlightActivityGroup"); 
  38.  
  39. /** 
  40. * Retrieves a list of floodlight activity groups, possibly filtered. 
  41. * (floodlightActivityGroups.listFloodlightActivityGroups) 
  42. * @param string $profileId User profile ID associated with this request. 
  43. * @param array $optParams Optional parameters. 
  44. * @opt_param string searchString Allows searching for objects by name or ID. 
  45. * Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will 
  46. * return objects with names like "floodlightactivitygroup June 2015",  
  47. * "floodlightactivitygroup April 2015" or simply "floodlightactivitygroup 
  48. * 2015". Most of the searches also add wildcards implicitly at the start and 
  49. * the end of the search string. For example, a search string of 
  50. * "floodlightactivitygroup" will match objects with name "my 
  51. * floodlightactivitygroup activity", "floodlightactivitygroup 2015" or simply 
  52. * "floodlightactivitygroup". 
  53. * @opt_param string sortField Field by which to sort the list. 
  54. * @opt_param string floodlightConfigurationId Select only floodlight activity 
  55. * groups with the specified floodlight configuration ID. Must specify either 
  56. * ids, advertiserId, or floodlightConfigurationId for a non-empty result. 
  57. * @opt_param string ids Select only floodlight activity groups with the 
  58. * specified IDs. Must specify either ids, advertiserId, or 
  59. * floodlightConfigurationId for a non-empty result. 
  60. * @opt_param int maxResults Maximum number of results to return. 
  61. * @opt_param string advertiserId Select only floodlight activity groups with 
  62. * the specified advertiser ID. Must specify either ids, advertiserId, or 
  63. * floodlightConfigurationId for a non-empty result. 
  64. * @opt_param string pageToken Value of the nextPageToken from the previous 
  65. * result page. 
  66. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  67. * @opt_param string type Select only floodlight activity groups with the 
  68. * specified floodlight activity group type. 
  69. * @return Google_Service_Dfareporting_FloodlightActivityGroupsListResponse 
  70. */ 
  71. public function listFloodlightActivityGroups($profileId, $optParams = array()) 
  72. $params = array('profileId' => $profileId); 
  73. $params = array_merge($params, $optParams); 
  74. return $this->call('list', array($params), "Google_Service_Dfareporting_FloodlightActivityGroupsListResponse"); 
  75.  
  76. /** 
  77. * Updates an existing floodlight activity group. This method supports patch 
  78. * semantics. (floodlightActivityGroups.patch) 
  79. * @param string $profileId User profile ID associated with this request. 
  80. * @param string $id Floodlight activity Group ID. 
  81. * @param Google_FloodlightActivityGroup $postBody 
  82. * @param array $optParams Optional parameters. 
  83. * @return Google_Service_Dfareporting_FloodlightActivityGroup 
  84. */ 
  85. public function patch($profileId, $id, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams = array()) 
  86. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  87. $params = array_merge($params, $optParams); 
  88. return $this->call('patch', array($params), "Google_Service_Dfareporting_FloodlightActivityGroup"); 
  89.  
  90. /** 
  91. * Updates an existing floodlight activity group. 
  92. * (floodlightActivityGroups.update) 
  93. * @param string $profileId User profile ID associated with this request. 
  94. * @param Google_FloodlightActivityGroup $postBody 
  95. * @param array $optParams Optional parameters. 
  96. * @return Google_Service_Dfareporting_FloodlightActivityGroup 
  97. */ 
  98. public function update($profileId, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams = array()) 
  99. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  100. $params = array_merge($params, $optParams); 
  101. return $this->call('update', array($params), "Google_Service_Dfareporting_FloodlightActivityGroup");