Google_ActivitiesServiceResource

The "activities" collection of methods.

Defined (6)

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

/src/contrib/Google_AuditService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Retrieves a list of activities for a specific customer and application. (activities.list) 
  5. * @param string $customerId Represents the customer who is the owner of target object on which action was performed. 
  6. * @param string $applicationId Application ID of the application on which the event was performed. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string actorApplicationId Application ID of the application which interacted on behalf of the user while performing the event. 
  9. * @opt_param string actorEmail Email address of the user who performed the action. 
  10. * @opt_param string actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. 
  11. * @opt_param string caller Type of the caller. 
  12. * @opt_param string continuationToken Next page URL. 
  13. * @opt_param string endTime Return events which occured at or before this time. 
  14. * @opt_param string eventName Name of the event being queried. 
  15. * @opt_param int maxResults Number of activity records to be shown in each page. 
  16. * @opt_param string startTime Return events which occured at or after this time. 
  17. * @return Google_Activities 
  18. */ 
  19. public function listActivities($customerId, $applicationId, $optParams = array()) { 
  20. $params = array('customerId' => $customerId, 'applicationId' => $applicationId); 
  21. $params = array_merge($params, $optParams); 
  22. $data = $this->__call('list', array($params)); 
  23. if ($this->useObjects()) { 
  24. return new Google_Activities($data); 
  25. } else { 
  26. return $data; 
/src/contrib/Google_ReportsService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Retrieves a list of activities for a specific customer and application. (activities.list) 
  5. * @param string $userKey Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. 
  6. * @param string $applicationName Application name for which the events are to be retrieved. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. 
  9. * @opt_param string endTime Return events which occured at or before this time. 
  10. * @opt_param string eventName Name of the event being queried. 
  11. * @opt_param string filters Event parameters in the form [parameter1 name][operator][parameter1 value], [parameter2 name][operator][parameter2 value], ... 
  12. * @opt_param int maxResults Number of activity records to be shown in each page. 
  13. * @opt_param string pageToken Token to specify next page. 
  14. * @opt_param string startTime Return events which occured at or after this time. 
  15. * @return Google_Activities 
  16. */ 
  17. public function listActivities($userKey, $applicationName, $optParams = array()) { 
  18. $params = array('userKey' => $userKey, 'applicationName' => $applicationName); 
  19. $params = array_merge($params, $optParams); 
  20. $data = $this->__call('list', array($params)); 
  21. if ($this->useObjects()) { 
  22. return new Google_Activities($data); 
  23. } else { 
  24. return $data; 
/src/contrib/Google_OrkutService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes an existing activity, if the access controls allow it. (activities.delete) 
  5. * @param string $activityId ID of the activity to remove. 
  6. * @param array $optParams Optional parameters. 
  7. */ 
  8. public function delete($activityId, $optParams = array()) { 
  9. $params = array('activityId' => $activityId); 
  10. $params = array_merge($params, $optParams); 
  11. $data = $this->__call('delete', array($params)); 
  12. return $data; 
  13. /** 
  14. * Retrieves a list of activities. (activities.list) 
  15. * @param string $userId The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). 
  16. * @param string $collection The collection of activities to list. 
  17. * @param array $optParams Optional parameters. 
  18. * @opt_param string hl Specifies the interface language (host language) of your user interface. 
  19. * @opt_param string maxResults The maximum number of activities to include in the response. 
  20. * @opt_param string pageToken A continuation token that allows pagination. 
  21. * @return Google_ActivityList 
  22. */ 
  23. public function listActivities($userId, $collection, $optParams = array()) { 
  24. $params = array('userId' => $userId, 'collection' => $collection); 
  25. $params = array_merge($params, $optParams); 
  26. $data = $this->__call('list', array($params)); 
  27. if ($this->useObjects()) { 
  28. return new Google_ActivityList($data); 
  29. } else { 
  30. return $data; 
/src/contrib/Google_PlusDomainsService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Get an activity. (activities.get) 
  5. * @param string $activityId The ID of the activity to get. 
  6. * @param array $optParams Optional parameters. 
  7. * @return Google_Activity 
  8. */ 
  9. public function get($activityId, $optParams = array()) { 
  10. $params = array('activityId' => $activityId); 
  11. $params = array_merge($params, $optParams); 
  12. $data = $this->__call('get', array($params)); 
  13. if ($this->useObjects()) { 
  14. return new Google_Activity($data); 
  15. } else { 
  16. return $data; 
  17. /** 
  18. * Create a new activity for the authenticated user. (activities.insert) 
  19. * @param string $userId The ID of the user to create the activity on behalf of. Its value should be "me", to indicate the authenticated user. 
  20. * @param Google_Activity $postBody 
  21. * @param array $optParams Optional parameters. 
  22. * @opt_param bool preview If "true", extract the potential media attachments for a url. The response will include all possible attachments for a url, including video, photos, and articles based on the content of the page. 
  23. * @return Google_Activity 
  24. */ 
  25. public function insert($userId, Google_Activity $postBody, $optParams = array()) { 
  26. $params = array('userId' => $userId, 'postBody' => $postBody); 
  27. $params = array_merge($params, $optParams); 
  28. $data = $this->__call('insert', array($params)); 
  29. if ($this->useObjects()) { 
  30. return new Google_Activity($data); 
  31. } else { 
  32. return $data; 
  33. /** 
  34. * List all of the activities in the specified collection for a particular user. 
  35. * (activities.list) 
  36. * @param string $userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. 
  37. * @param string $collection The collection of activities to list. 
  38. * @param array $optParams Optional parameters. 
  39. * @opt_param string maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. 
  40. * @opt_param string pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. 
  41. * @return Google_ActivityFeed 
  42. */ 
  43. public function listActivities($userId, $collection, $optParams = array()) { 
  44. $params = array('userId' => $userId, 'collection' => $collection); 
  45. $params = array_merge($params, $optParams); 
  46. $data = $this->__call('list', array($params)); 
  47. if ($this->useObjects()) { 
  48. return new Google_ActivityFeed($data); 
  49. } else { 
  50. return $data; 
/src/contrib/Google_PlusService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Get an activity. (activities.get) 
  5. * @param string $activityId The ID of the activity to get. 
  6. * @param array $optParams Optional parameters. 
  7. * @return Google_Activity 
  8. */ 
  9. public function get($activityId, $optParams = array()) { 
  10. $params = array('activityId' => $activityId); 
  11. $params = array_merge($params, $optParams); 
  12. $data = $this->__call('get', array($params)); 
  13. if ($this->useObjects()) { 
  14. return new Google_Activity($data); 
  15. } else { 
  16. return $data; 
  17. /** 
  18. * List all of the activities in the specified collection for a particular user. (activities.list) 
  19. * @param string $userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. 
  20. * @param string $collection The collection of activities to list. 
  21. * @param array $optParams Optional parameters. 
  22. * @opt_param string maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. 
  23. * @opt_param string pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. 
  24. * @return Google_ActivityFeed 
  25. */ 
  26. public function listActivities($userId, $collection, $optParams = array()) { 
  27. $params = array('userId' => $userId, 'collection' => $collection); 
  28. $params = array_merge($params, $optParams); 
  29. $data = $this->__call('list', array($params)); 
  30. if ($this->useObjects()) { 
  31. return new Google_ActivityFeed($data); 
  32. } else { 
  33. return $data; 
  34. /** 
  35. * Search public activities. (activities.search) 
  36. * @param string $query Full-text search query string. 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param string language Specify the preferred language to search with. See search language codes for available values. 
  39. * @opt_param string maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. 
  40. * @opt_param string orderBy Specifies how to order search results. 
  41. * @opt_param string pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length. 
  42. * @return Google_ActivityFeed 
  43. */ 
  44. public function search($query, $optParams = array()) { 
  45. $params = array('query' => $query); 
  46. $params = array_merge($params, $optParams); 
  47. $data = $this->__call('search', array($params)); 
  48. if ($this->useObjects()) { 
  49. return new Google_ActivityFeed($data); 
  50. } else { 
  51. return $data; 
/src/contrib/Google_YouTubeService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Posts a bulletin for a specific channel. (The user submitting the request must be authorized to 
  5. * act on the channel's behalf.) (activities.insert) 
  6. * @param string $part The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. 
  7. The part names that you can include in the parameter value are snippet and contentDetails. 
  8. * @param Google_Activity $postBody 
  9. * @param array $optParams Optional parameters. 
  10. * @return Google_Activity 
  11. */ 
  12. public function insert($part, Google_Activity $postBody, $optParams = array()) { 
  13. $params = array('part' => $part, 'postBody' => $postBody); 
  14. $params = array_merge($params, $optParams); 
  15. $data = $this->__call('insert', array($params)); 
  16. if ($this->useObjects()) { 
  17. return new Google_Activity($data); 
  18. } else { 
  19. return $data; 
  20. /** 
  21. * Returns a list of channel activity events that match the request criteria. For example, you can 
  22. * retrieve events associated with a particular channel, events associated with the user's 
  23. * subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each 
  24. * user. (activities.list) 
  25. * @param string $part The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. 
  26. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. 
  27. * @param array $optParams Optional parameters. 
  28. * @opt_param string channelId The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. 
  29. * @opt_param bool home Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. 
  30. * @opt_param string maxResults USE_DESCRIPTION --- channels:list:maxResults 
  31. * @opt_param bool mine Set this parameter's value to true to retrieve a feed of the authenticated user's activities. 
  32. * @opt_param string pageToken USE_DESCRIPTION --- channels:list:pageToken 
  33. * @opt_param string publishedAfter The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 
  34. * @opt_param string publishedBefore The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 
  35. * @opt_param string regionCode The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. 
  36. * @return Google_ActivityListResponse 
  37. */ 
  38. public function listActivities($part, $optParams = array()) { 
  39. $params = array('part' => $part); 
  40. $params = array_merge($params, $optParams); 
  41. $data = $this->__call('list', array($params)); 
  42. if ($this->useObjects()) { 
  43. return new Google_ActivityListResponse($data); 
  44. } else { 
  45. return $data;