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

The "unsampledReports" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementUnsampledReports_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($accountId, $webPropertyId, $profileId, $unsampledReportId, $optParams=array())
 Returns a single unsampled report.
 
 insert ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_UnsampledReport $postBody, $optParams=array())
 Create a new unsampled report.
 
 listManagementUnsampledReports ($accountId, $webPropertyId, $profileId, $optParams=array())
 Lists unsampled reports to which the user has access.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "unsampledReports" collection of methods.

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

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_ManagementUnsampledReports_Resource::get ( $accountId,
$webPropertyId,
$profileId,
$unsampledReportId,
$optParams = array() )

Returns a single unsampled report.

(unsampledReports.get)

Parameters
string$accountIdAccount ID to retrieve unsampled report for.
string$webPropertyIdWeb property ID to retrieve unsampled reports for.
string$profileIdView (Profile) ID to retrieve unsampled report for.
string$unsampledReportIdID of the unsampled report to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_UnsampledReport

◆ insert()

Google_Service_Analytics_ManagementUnsampledReports_Resource::insert ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_UnsampledReport $postBody,
$optParams = array() )

Create a new unsampled report.

(unsampledReports.insert)

Parameters
string$accountIdAccount ID to create the unsampled report for.
string$webPropertyIdWeb property ID to create the unsampled report for.
string$profileIdView (Profile) ID to create the unsampled report for.
Google_UnsampledReport$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_UnsampledReport

◆ listManagementUnsampledReports()

Google_Service_Analytics_ManagementUnsampledReports_Resource::listManagementUnsampledReports ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Lists unsampled reports to which the user has access.

(unsampledReports.listManagementUnsampledReports)

Parameters
string$accountIdAccount ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.
string$webPropertyIdWeb property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.
string$profileIdView (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.
array$optParamsOptional parameters.

@opt_param int max-results The maximum number of unsampled reports to include in this response. @opt_param int start-index An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max- results parameter.

Return values
Google_Service_Analytics_UnsampledReports

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