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

The "ga" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_DataGa_Resource:
Google_Service_Resource

Public Member Functions

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

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "ga" collection of methods.

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

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

Returns Analytics data for a view (profile).

(ga.get)

Parameters
string$idsUnique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
string$startDateStart date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
string$endDateEnd date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.
string$metricsA comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. 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 Analytics data. @opt_param string dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. @opt_param int start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. @opt_param string segment An Analytics segment to be applied to data. @opt_param string samplingLevel The desired sampling level. @opt_param string filters A comma-separated list of dimension or metric filters to be applied to Analytics data. @opt_param string output The selected format for the response. Default format is JSON.

Return values
Google_Service_Analytics_GaData

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