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

The "customMetrics" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementCustomMetrics_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($accountId, $webPropertyId, $customMetricId, $optParams=array())
 Get a custom metric to which the user has access.
 
 insert ($accountId, $webPropertyId, Google_Service_Analytics_CustomMetric $postBody, $optParams=array())
 Create a new custom metric.
 
 listManagementCustomMetrics ($accountId, $webPropertyId, $optParams=array())
 Lists custom metrics to which the user has access.
 
 patch ($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams=array())
 Updates an existing custom metric.
 
 update ($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams=array())
 Updates an existing custom metric.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "customMetrics" collection of methods.

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

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_ManagementCustomMetrics_Resource::get ( $accountId,
$webPropertyId,
$customMetricId,
$optParams = array() )

Get a custom metric to which the user has access.

(customMetrics.get)

Parameters
string$accountIdAccount ID for the custom metric to retrieve.
string$webPropertyIdWeb property ID for the custom metric to retrieve.
string$customMetricIdThe ID of the custom metric to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_CustomMetric

◆ insert()

Google_Service_Analytics_ManagementCustomMetrics_Resource::insert ( $accountId,
$webPropertyId,
Google_Service_Analytics_CustomMetric $postBody,
$optParams = array() )

Create a new custom metric.

(customMetrics.insert)

Parameters
string$accountIdAccount ID for the custom metric to create.
string$webPropertyIdWeb property ID for the custom dimension to create.
Google_CustomMetric$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_CustomMetric

◆ listManagementCustomMetrics()

Google_Service_Analytics_ManagementCustomMetrics_Resource::listManagementCustomMetrics ( $accountId,
$webPropertyId,
$optParams = array() )

Lists custom metrics to which the user has access.

(customMetrics.listManagementCustomMetrics)

Parameters
string$accountIdAccount ID for the custom metrics to retrieve.
string$webPropertyIdWeb property ID for the custom metrics to retrieve.
array$optParamsOptional parameters.

@opt_param int max-results The maximum number of custom metrics to include in this response. @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.

Return values
Google_Service_Analytics_CustomMetrics

◆ patch()

Google_Service_Analytics_ManagementCustomMetrics_Resource::patch ( $accountId,
$webPropertyId,
$customMetricId,
Google_Service_Analytics_CustomMetric $postBody,
$optParams = array() )

Updates an existing custom metric.

This method supports patch semantics. (customMetrics.patch)

Parameters
string$accountIdAccount ID for the custom metric to update.
string$webPropertyIdWeb property ID for the custom metric to update.
string$customMetricIdCustom metric ID for the custom metric to update.
Google_CustomMetric$postBody
array$optParamsOptional parameters.

@opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Return values
Google_Service_Analytics_CustomMetric

◆ update()

Google_Service_Analytics_ManagementCustomMetrics_Resource::update ( $accountId,
$webPropertyId,
$customMetricId,
Google_Service_Analytics_CustomMetric $postBody,
$optParams = array() )

Updates an existing custom metric.

(customMetrics.update)

Parameters
string$accountIdAccount ID for the custom metric to update.
string$webPropertyIdWeb property ID for the custom metric to update.
string$customMetricIdCustom metric ID for the custom metric to update.
Google_CustomMetric$postBody
array$optParamsOptional parameters.

@opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Return values
Google_Service_Analytics_CustomMetric

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