Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_Analytics_DataRealtime_Resource Class Reference

The "realtime" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_DataRealtime_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($ids, $metrics, $optParams=array())
 Returns real time data for a view (profile).
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "realtime" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $realtime = $analyticsService->realtime;

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_Analytics_DataRealtime_Resource::get ( $ids,
$metrics,
$optParams = array() )

Returns real time data for a view (profile).

(realtime.get)

Parameters
string$idsUnique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
string$metricsA comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
array$optParamsOptional parameters.

@opt_param int max-results The maximum number of entries to include in this feed. @opt_param string sort A comma-separated list of dimensions or metrics that determine the sort order for real time data. @opt_param string dimensions A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. @opt_param string filters A comma-separated list of dimension or metric filters to be applied to real time data.

Return values
Google_Service_Analytics_RealtimeData

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