Google_Service_Reports_Activities_Resource

The "activities" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Reports.php  
  1. class Google_Service_Reports_Activities_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Retrieves a list of activities for a specific customer and application. 
  5. * (activities.listActivities) 
  6. * @param string $userKey Represents the profile id or the user email for which 
  7. * the data should be filtered. When 'all' is specified as the userKey, it 
  8. * returns usageReports for all users. 
  9. * @param string $applicationName Application name for which the events are to 
  10. * be retrieved. 
  11. * @param array $optParams Optional parameters. 
  12. * @opt_param string startTime Return events which occured at or after this 
  13. * time. 
  14. * @opt_param string actorIpAddress IP Address of host where the event was 
  15. * performed. Supports both IPv4 and IPv6 addresses. 
  16. * @opt_param int maxResults Number of activity records to be shown in each 
  17. * page. 
  18. * @opt_param string eventName Name of the event being queried. 
  19. * @opt_param string pageToken Token to specify next page. 
  20. * @opt_param string filters Event parameters in the form [parameter1 
  21. * name][operator][parameter1 value], [parameter2 name][operator][parameter2 
  22. * value], ... 
  23. * @opt_param string endTime Return events which occured at or before this time. 
  24. * @opt_param string customerId Represents the customer for which the data is to 
  25. * be fetched. 
  26. * @return Google_Service_Reports_Activities 
  27. */ 
  28. public function listActivities($userKey, $applicationName, $optParams = array()) 
  29. $params = array('userKey' => $userKey, 'applicationName' => $applicationName); 
  30. $params = array_merge($params, $optParams); 
  31. return $this->call('list', array($params), "Google_Service_Reports_Activities"); 
  32.  
  33. /** 
  34. * Push changes to activities (activities.watch) 
  35. * @param string $userKey Represents the profile id or the user email for which 
  36. * the data should be filtered. When 'all' is specified as the userKey, it 
  37. * returns usageReports for all users. 
  38. * @param string $applicationName Application name for which the events are to 
  39. * be retrieved. 
  40. * @param Google_Channel $postBody 
  41. * @param array $optParams Optional parameters. 
  42. * @opt_param string startTime Return events which occured at or after this 
  43. * time. 
  44. * @opt_param string actorIpAddress IP Address of host where the event was 
  45. * performed. Supports both IPv4 and IPv6 addresses. 
  46. * @opt_param int maxResults Number of activity records to be shown in each 
  47. * page. 
  48. * @opt_param string eventName Name of the event being queried. 
  49. * @opt_param string pageToken Token to specify next page. 
  50. * @opt_param string filters Event parameters in the form [parameter1 
  51. * name][operator][parameter1 value], [parameter2 name][operator][parameter2 
  52. * value], ... 
  53. * @opt_param string endTime Return events which occured at or before this time. 
  54. * @opt_param string customerId Represents the customer for which the data is to 
  55. * be fetched. 
  56. * @return Google_Service_Reports_Channel 
  57. */ 
  58. public function watch($userKey, $applicationName, Google_Service_Reports_Channel $postBody, $optParams = array()) 
  59. $params = array('userKey' => $userKey, 'applicationName' => $applicationName, 'postBody' => $postBody); 
  60. $params = array_merge($params, $optParams); 
  61. return $this->call('watch', array($params), "Google_Service_Reports_Channel");