Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]
(no description)
| File Size: | 1156 lines (29 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 20 classes
Google_Service_Reports:: (1 method):
__construct()
Google_Service_Reports_Activities_Resource:: (2 methods):
listActivities()
watch()
Google_Service_Reports_Channels_Resource:: (1 method):
stop()
Google_Service_Reports_CustomerUsageReports_Resource:: (1 method):
get()
Google_Service_Reports_UserUsageReport_Resource:: (1 method):
get()
Google_Service_Reports_Activities:: (8 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
Google_Service_Reports_Activity:: (14 methods):
setActor()
getActor()
setEtag()
getEtag()
setEvents()
getEvents()
setId()
getId()
setIpAddress()
getIpAddress()
setKind()
getKind()
setOwnerDomain()
getOwnerDomain()
Google_Service_Reports_ActivityActor:: (8 methods):
setCallerType()
getCallerType()
setEmail()
getEmail()
setKey()
getKey()
setProfileId()
getProfileId()
Google_Service_Reports_ActivityEvents:: (6 methods):
setName()
getName()
setParameters()
getParameters()
setType()
getType()
Google_Service_Reports_ActivityEventsParameters:: (12 methods):
setBoolValue()
getBoolValue()
setIntValue()
getIntValue()
setMultiIntValue()
getMultiIntValue()
setMultiValue()
getMultiValue()
setName()
getName()
setValue()
getValue()
Google_Service_Reports_ActivityId:: (8 methods):
setApplicationName()
getApplicationName()
setCustomerId()
getCustomerId()
setTime()
getTime()
setUniqueQualifier()
getUniqueQualifier()
Google_Service_Reports_Channel:: (20 methods):
setAddress()
getAddress()
setExpiration()
getExpiration()
setId()
getId()
setKind()
getKind()
setParams()
getParams()
setPayload()
getPayload()
setResourceId()
getResourceId()
setResourceUri()
getResourceUri()
setToken()
getToken()
setType()
getType()
Google_Service_Reports_ChannelParams:: (0 methods):
Google_Service_Reports_UsageReport:: (10 methods):
setDate()
getDate()
setEntity()
getEntity()
setEtag()
getEtag()
setKind()
getKind()
setParameters()
getParameters()
Google_Service_Reports_UsageReportEntity:: (8 methods):
setCustomerId()
getCustomerId()
setProfileId()
getProfileId()
setType()
getType()
setUserEmail()
getUserEmail()
Google_Service_Reports_UsageReportParameters:: (12 methods):
setBoolValue()
getBoolValue()
setDatetimeValue()
getDatetimeValue()
setIntValue()
getIntValue()
setMsgValue()
getMsgValue()
setName()
getName()
setStringValue()
getStringValue()
Google_Service_Reports_UsageReportParametersMsgValue:: (0 methods):
Google_Service_Reports_UsageReports:: (10 methods):
setEtag()
getEtag()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setUsageReports()
getUsageReports()
setWarnings()
getWarnings()
Google_Service_Reports_UsageReportsWarnings:: (6 methods):
setCode()
getCode()
setData()
getData()
setMessage()
getMessage()
Google_Service_Reports_UsageReportsWarningsData:: (4 methods):
setKey()
getKey()
setValue()
getValue()
Class: Google_Service_Reports - X-Ref
Service definition for Reports (reports_v1).<p>
Allows the administrators of Google Apps customers to fetch reports about the
usage, collaboration, security and risk for their users.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/admin-sdk/reports/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Reports service. param: Google_Client $client |
Class: Google_Service_Reports_Activities_Resource - X-Ref
The "activities" collection of methods.Typical usage is:
<code>
$adminService = new Google_Service_Reports(...);
$activities = $adminService->activities;
</code>
| listActivities($userKey, $applicationName, $optParams = array() X-Ref |
| Retrieves a list of activities for a specific customer and application. (activities.listActivities) param: string $userKey Represents the profile id or the user email for which param: string $applicationName Application name for which the events are to param: array $optParams Optional parameters. return: Google_Service_Reports_Activities |
| watch($userKey, $applicationName, Google_Service_Reports_Channel $postBody, $optParams = array() X-Ref |
| Push changes to activities (activities.watch) param: string $userKey Represents the profile id or the user email for which param: string $applicationName Application name for which the events are to param: Google_Channel $postBody param: array $optParams Optional parameters. return: Google_Service_Reports_Channel |
Class: Google_Service_Reports_Channels_Resource - X-Ref
The "channels" collection of methods.Typical usage is:
<code>
$adminService = new Google_Service_Reports(...);
$channels = $adminService->channels;
</code>
| stop(Google_Service_Reports_Channel $postBody, $optParams = array() X-Ref |
| Stop watching resources through this channel (channels.stop) param: Google_Channel $postBody param: array $optParams Optional parameters. |
Class: Google_Service_Reports_CustomerUsageReports_Resource - X-Ref
The "customerUsageReports" collection of methods.Typical usage is:
<code>
$adminService = new Google_Service_Reports(...);
$customerUsageReports = $adminService->customerUsageReports;
</code>
| get($date, $optParams = array() X-Ref |
| Retrieves a report which is a collection of properties / statistics for a specific customer. (customerUsageReports.get) param: string $date Represents the date in yyyy-mm-dd format for which the param: array $optParams Optional parameters. return: Google_Service_Reports_UsageReports |
Class: Google_Service_Reports_UserUsageReport_Resource - X-Ref
The "userUsageReport" collection of methods.Typical usage is:
<code>
$adminService = new Google_Service_Reports(...);
$userUsageReport = $adminService->userUsageReport;
</code>
| get($userKey, $date, $optParams = array() X-Ref |
| Retrieves a report which is a collection of properties / statistics for a set of users. (userUsageReport.get) param: string $userKey Represents the profile id or the user email for which param: string $date Represents the date in yyyy-mm-dd format for which the param: array $optParams Optional parameters. return: Google_Service_Reports_UsageReports |
Class: Google_Service_Reports_Activities - X-Ref
Class: Google_Service_Reports_Activity - X-Ref
| setActor(Google_Service_Reports_ActivityActor $actor) X-Ref |
| No description |
| getActor() X-Ref |
| No description |
| setEtag($etag) X-Ref |
| No description |
| getEtag() X-Ref |
| No description |
| setEvents($events) X-Ref |
| No description |
| getEvents() X-Ref |
| No description |
| setId(Google_Service_Reports_ActivityId $id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setIpAddress($ipAddress) X-Ref |
| No description |
| getIpAddress() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setOwnerDomain($ownerDomain) X-Ref |
| No description |
| getOwnerDomain() X-Ref |
| No description |
Class: Google_Service_Reports_ActivityActor - X-Ref
| setCallerType($callerType) X-Ref |
| No description |
| getCallerType() X-Ref |
| No description |
| setEmail($email) X-Ref |
| No description |
| getEmail() X-Ref |
| No description |
| setKey($key) X-Ref |
| No description |
| getKey() X-Ref |
| No description |
| setProfileId($profileId) X-Ref |
| No description |
| getProfileId() X-Ref |
| No description |
Class: Google_Service_Reports_ActivityEvents - X-Ref
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setParameters($parameters) X-Ref |
| No description |
| getParameters() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_Reports_ActivityEventsParameters - X-Ref
| setBoolValue($boolValue) X-Ref |
| No description |
| getBoolValue() X-Ref |
| No description |
| setIntValue($intValue) X-Ref |
| No description |
| getIntValue() X-Ref |
| No description |
| setMultiIntValue($multiIntValue) X-Ref |
| No description |
| getMultiIntValue() X-Ref |
| No description |
| setMultiValue($multiValue) X-Ref |
| No description |
| getMultiValue() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setValue($value) X-Ref |
| No description |
| getValue() X-Ref |
| No description |
Class: Google_Service_Reports_ActivityId - X-Ref
| setApplicationName($applicationName) X-Ref |
| No description |
| getApplicationName() X-Ref |
| No description |
| setCustomerId($customerId) X-Ref |
| No description |
| getCustomerId() X-Ref |
| No description |
| setTime($time) X-Ref |
| No description |
| getTime() X-Ref |
| No description |
| setUniqueQualifier($uniqueQualifier) X-Ref |
| No description |
| getUniqueQualifier() X-Ref |
| No description |
Class: Google_Service_Reports_Channel - X-Ref
| setAddress($address) X-Ref |
| No description |
| getAddress() X-Ref |
| No description |
| setExpiration($expiration) X-Ref |
| No description |
| getExpiration() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setParams($params) X-Ref |
| No description |
| getParams() X-Ref |
| No description |
| setPayload($payload) X-Ref |
| No description |
| getPayload() X-Ref |
| No description |
| setResourceId($resourceId) X-Ref |
| No description |
| getResourceId() X-Ref |
| No description |
| setResourceUri($resourceUri) X-Ref |
| No description |
| getResourceUri() X-Ref |
| No description |
| setToken($token) X-Ref |
| No description |
| getToken() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_Reports_UsageReport - X-Ref
| setDate($date) X-Ref |
| No description |
| getDate() X-Ref |
| No description |
| setEntity(Google_Service_Reports_UsageReportEntity $entity) X-Ref |
| No description |
| getEntity() X-Ref |
| No description |
| setEtag($etag) X-Ref |
| No description |
| getEtag() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setParameters($parameters) X-Ref |
| No description |
| getParameters() X-Ref |
| No description |
Class: Google_Service_Reports_UsageReportEntity - X-Ref
| setCustomerId($customerId) X-Ref |
| No description |
| getCustomerId() X-Ref |
| No description |
| setProfileId($profileId) X-Ref |
| No description |
| getProfileId() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
| setUserEmail($userEmail) X-Ref |
| No description |
| getUserEmail() X-Ref |
| No description |
Class: Google_Service_Reports_UsageReportParameters - X-Ref
| setBoolValue($boolValue) X-Ref |
| No description |
| getBoolValue() X-Ref |
| No description |
| setDatetimeValue($datetimeValue) X-Ref |
| No description |
| getDatetimeValue() X-Ref |
| No description |
| setIntValue($intValue) X-Ref |
| No description |
| getIntValue() X-Ref |
| No description |
| setMsgValue($msgValue) X-Ref |
| No description |
| getMsgValue() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setStringValue($stringValue) X-Ref |
| No description |
| getStringValue() X-Ref |
| No description |
Class: Google_Service_Reports_UsageReports - X-Ref
| setEtag($etag) X-Ref |
| No description |
| getEtag() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setUsageReports($usageReports) X-Ref |
| No description |
| getUsageReports() X-Ref |
| No description |
| setWarnings($warnings) X-Ref |
| No description |
| getWarnings() X-Ref |
| No description |
