GoogleGAL_Service_Analytics_ManagementFilters_Resource

The "filters" collection of methods.

Defined (1)

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

/core/Google/Service/Analytics.php  
  1. class GoogleGAL_Service_Analytics_ManagementFilters_Resource extends GoogleGAL_Service_Resource 
  2.  
  3. /** 
  4. * Delete a filter. (filters.delete) 
  5. * @param string $accountId Account ID to delete the filter for. 
  6. * @param string $filterId ID of the filter to be deleted. 
  7. * @param array $optParams Optional parameters. 
  8. * @return GoogleGAL_Service_Analytics_Filter 
  9. */ 
  10. public function delete($accountId, $filterId, $optParams = array()) 
  11. $params = array('accountId' => $accountId, 'filterId' => $filterId); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('delete', array($params), "GoogleGAL_Service_Analytics_Filter"); 
  14.  
  15. /** 
  16. * Returns a filters to which the user has access. (filters.get) 
  17. * @param string $accountId Account ID to retrieve filters for. 
  18. * @param string $filterId Filter ID to retrieve filters for. 
  19. * @param array $optParams Optional parameters. 
  20. * @return GoogleGAL_Service_Analytics_Filter 
  21. */ 
  22. public function get($accountId, $filterId, $optParams = array()) 
  23. $params = array('accountId' => $accountId, 'filterId' => $filterId); 
  24. $params = array_merge($params, $optParams); 
  25. return $this->call('get', array($params), "GoogleGAL_Service_Analytics_Filter"); 
  26.  
  27. /** 
  28. * Create a new filter. (filters.insert) 
  29. * @param string $accountId Account ID to create filter for. 
  30. * @param GoogleGAL_Filter $postBody 
  31. * @param array $optParams Optional parameters. 
  32. * @return GoogleGAL_Service_Analytics_Filter 
  33. */ 
  34. public function insert($accountId, GoogleGAL_Service_Analytics_Filter $postBody, $optParams = array()) 
  35. $params = array('accountId' => $accountId, 'postBody' => $postBody); 
  36. $params = array_merge($params, $optParams); 
  37. return $this->call('insert', array($params), "GoogleGAL_Service_Analytics_Filter"); 
  38.  
  39. /** 
  40. * Lists all filters for an account (filters.listManagementFilters) 
  41. * @param string $accountId Account ID to retrieve filters for. 
  42. * @param array $optParams Optional parameters. 
  43. * @opt_param int max-results The maximum number of filters to include in this 
  44. * response. 
  45. * @opt_param int start-index An index of the first entity to retrieve. Use this 
  46. * parameter as a pagination mechanism along with the max-results parameter. 
  47. * @return GoogleGAL_Service_Analytics_Filters 
  48. */ 
  49. public function listManagementFilters($accountId, $optParams = array()) 
  50. $params = array('accountId' => $accountId); 
  51. $params = array_merge($params, $optParams); 
  52. return $this->call('list', array($params), "GoogleGAL_Service_Analytics_Filters"); 
  53.  
  54. /** 
  55. * Updates an existing filter. This method supports patch semantics. 
  56. * (filters.patch) 
  57. * @param string $accountId Account ID to which the filter belongs. 
  58. * @param string $filterId ID of the filter to be updated. 
  59. * @param GoogleGAL_Filter $postBody 
  60. * @param array $optParams Optional parameters. 
  61. * @return GoogleGAL_Service_Analytics_Filter 
  62. */ 
  63. public function patch($accountId, $filterId, GoogleGAL_Service_Analytics_Filter $postBody, $optParams = array()) 
  64. $params = array('accountId' => $accountId, 'filterId' => $filterId, 'postBody' => $postBody); 
  65. $params = array_merge($params, $optParams); 
  66. return $this->call('patch', array($params), "GoogleGAL_Service_Analytics_Filter"); 
  67.  
  68. /** 
  69. * Updates an existing filter. (filters.update) 
  70. * @param string $accountId Account ID to which the filter belongs. 
  71. * @param string $filterId ID of the filter to be updated. 
  72. * @param GoogleGAL_Filter $postBody 
  73. * @param array $optParams Optional parameters. 
  74. * @return GoogleGAL_Service_Analytics_Filter 
  75. */ 
  76. public function update($accountId, $filterId, GoogleGAL_Service_Analytics_Filter $postBody, $optParams = array()) 
  77. $params = array('accountId' => $accountId, 'filterId' => $filterId, 'postBody' => $postBody); 
  78. $params = array_merge($params, $optParams); 
  79. return $this->call('update', array($params), "GoogleGAL_Service_Analytics_Filter");