Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Analytics_ManagementExperiments_Resource Class Reference

The "experiments" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementExperiments_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($accountId, $webPropertyId, $profileId, $experimentId, $optParams=array())
 Delete an experiment.
 
 get ($accountId, $webPropertyId, $profileId, $experimentId, $optParams=array())
 Returns an experiment to which the user has access.
 
 insert ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_Experiment $postBody, $optParams=array())
 Create a new experiment.
 
 listManagementExperiments ($accountId, $webPropertyId, $profileId, $optParams=array())
 Lists experiments to which the user has access.
 
 patch ($accountId, $webPropertyId, $profileId, $experimentId, Google_Service_Analytics_Experiment $postBody, $optParams=array())
 Update an existing experiment.
 
 update ($accountId, $webPropertyId, $profileId, $experimentId, Google_Service_Analytics_Experiment $postBody, $optParams=array())
 Update an existing experiment.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "experiments" collection of methods.

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

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

◆ delete()

Google_Service_Analytics_ManagementExperiments_Resource::delete ( $accountId,
$webPropertyId,
$profileId,
$experimentId,
$optParams = array() )

Delete an experiment.

(experiments.delete)

Parameters
string$accountIdAccount ID to which the experiment belongs
string$webPropertyIdWeb property ID to which the experiment belongs
string$profileIdView (Profile) ID to which the experiment belongs
string$experimentIdID of the experiment to delete
array$optParamsOptional parameters.

◆ get()

Google_Service_Analytics_ManagementExperiments_Resource::get ( $accountId,
$webPropertyId,
$profileId,
$experimentId,
$optParams = array() )

Returns an experiment to which the user has access.

(experiments.get)

Parameters
string$accountIdAccount ID to retrieve the experiment for.
string$webPropertyIdWeb property ID to retrieve the experiment for.
string$profileIdView (Profile) ID to retrieve the experiment for.
string$experimentIdExperiment ID to retrieve the experiment for.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Experiment

◆ insert()

Google_Service_Analytics_ManagementExperiments_Resource::insert ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_Experiment $postBody,
$optParams = array() )

Create a new experiment.

(experiments.insert)

Parameters
string$accountIdAccount ID to create the experiment for.
string$webPropertyIdWeb property ID to create the experiment for.
string$profileIdView (Profile) ID to create the experiment for.
Google_Experiment$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Experiment

◆ listManagementExperiments()

Google_Service_Analytics_ManagementExperiments_Resource::listManagementExperiments ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Lists experiments to which the user has access.

(experiments.listManagementExperiments)

Parameters
string$accountIdAccount ID to retrieve experiments for.
string$webPropertyIdWeb property ID to retrieve experiments for.
string$profileIdView (Profile) ID to retrieve experiments for.
array$optParamsOptional parameters.

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

Return values
Google_Service_Analytics_Experiments

◆ patch()

Google_Service_Analytics_ManagementExperiments_Resource::patch ( $accountId,
$webPropertyId,
$profileId,
$experimentId,
Google_Service_Analytics_Experiment $postBody,
$optParams = array() )

Update an existing experiment.

This method supports patch semantics. (experiments.patch)

Parameters
string$accountIdAccount ID of the experiment to update.
string$webPropertyIdWeb property ID of the experiment to update.
string$profileIdView (Profile) ID of the experiment to update.
string$experimentIdExperiment ID of the experiment to update.
Google_Experiment$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Experiment

◆ update()

Google_Service_Analytics_ManagementExperiments_Resource::update ( $accountId,
$webPropertyId,
$profileId,
$experimentId,
Google_Service_Analytics_Experiment $postBody,
$optParams = array() )

Update an existing experiment.

(experiments.update)

Parameters
string$accountIdAccount ID of the experiment to update.
string$webPropertyIdWeb property ID of the experiment to update.
string$profileIdView (Profile) ID of the experiment to update.
string$experimentIdExperiment ID of the experiment to update.
Google_Experiment$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Experiment

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