Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Reports_UserUsageReport_Resource Class Reference

The "userUsageReport" collection of methods. More...

Inheritance diagram for Google_Service_Reports_UserUsageReport_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($userKey, $date, $optParams=array())
 Retrieves a report which is a collection of properties / statistics for a set of users.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "userUsageReport" collection of methods.

Typical usage is: $adminService = new Google_Service_Reports(...); $userUsageReport = $adminService->userUsageReport;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ get()

Google_Service_Reports_UserUsageReport_Resource::get ( $userKey,
$date,
$optParams = array() )

Retrieves a report which is a collection of properties / statistics for a set of users.

(userUsageReport.get)

Parameters
string$userKeyRepresents the profile id or the user email for which the data should be filtered.
string$dateRepresents the date in yyyy-mm-dd format for which the data is to be fetched.
array$optParamsOptional parameters.

@opt_param string parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. @opt_param string maxResults Maximum number of results to return. Maximum allowed is 1000 @opt_param string pageToken Token to specify next page. @opt_param string filters Represents the set of filters including parameter operator value. @opt_param string customerId Represents the customer for which the data is to be fetched.

Return values
Google_Service_Reports_UsageReports

The documentation for this class was generated from the following file: