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

The "goals" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementGoals_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($accountId, $webPropertyId, $profileId, $goalId, $optParams=array())
 Gets a goal to which the user has access.
 
 insert ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_Goal $postBody, $optParams=array())
 Create a new goal.
 
 listManagementGoals ($accountId, $webPropertyId, $profileId, $optParams=array())
 Lists goals to which the user has access.
 
 patch ($accountId, $webPropertyId, $profileId, $goalId, Google_Service_Analytics_Goal $postBody, $optParams=array())
 Updates an existing view (profile).
 
 update ($accountId, $webPropertyId, $profileId, $goalId, Google_Service_Analytics_Goal $postBody, $optParams=array())
 Updates an existing view (profile).
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "goals" collection of methods.

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

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

Gets a goal to which the user has access.

(goals.get)

Parameters
string$accountIdAccount ID to retrieve the goal for.
string$webPropertyIdWeb property ID to retrieve the goal for.
string$profileIdView (Profile) ID to retrieve the goal for.
string$goalIdGoal ID to retrieve the goal for.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Goal

◆ insert()

Google_Service_Analytics_ManagementGoals_Resource::insert ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_Goal $postBody,
$optParams = array() )

Create a new goal.

(goals.insert)

Parameters
string$accountIdAccount ID to create the goal for.
string$webPropertyIdWeb property ID to create the goal for.
string$profileIdView (Profile) ID to create the goal for.
Google_Goal$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Goal

◆ listManagementGoals()

Google_Service_Analytics_ManagementGoals_Resource::listManagementGoals ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Lists goals to which the user has access.

(goals.listManagementGoals)

Parameters
string$accountIdAccount ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
string$webPropertyIdWeb property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
string$profileIdView (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.
array$optParamsOptional parameters.

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

Return values
Google_Service_Analytics_Goals

◆ patch()

Google_Service_Analytics_ManagementGoals_Resource::patch ( $accountId,
$webPropertyId,
$profileId,
$goalId,
Google_Service_Analytics_Goal $postBody,
$optParams = array() )

Updates an existing view (profile).

This method supports patch semantics. (goals.patch)

Parameters
string$accountIdAccount ID to update the goal.
string$webPropertyIdWeb property ID to update the goal.
string$profileIdView (Profile) ID to update the goal.
string$goalIdIndex of the goal to be updated.
Google_Goal$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Goal

◆ update()

Google_Service_Analytics_ManagementGoals_Resource::update ( $accountId,
$webPropertyId,
$profileId,
$goalId,
Google_Service_Analytics_Goal $postBody,
$optParams = array() )

Updates an existing view (profile).

(goals.update)

Parameters
string$accountIdAccount ID to update the goal.
string$webPropertyIdWeb property ID to update the goal.
string$profileIdView (Profile) ID to update the goal.
string$goalIdIndex of the goal to be updated.
Google_Goal$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Goal

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