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

The "profiles" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementProfiles_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($accountId, $webPropertyId, $profileId, $optParams=array())
 Deletes a view (profile).
 
 get ($accountId, $webPropertyId, $profileId, $optParams=array())
 Gets a view (profile) to which the user has access.
 
 insert ($accountId, $webPropertyId, Google_Service_Analytics_Profile $postBody, $optParams=array())
 Create a new view (profile).
 
 listManagementProfiles ($accountId, $webPropertyId, $optParams=array())
 Lists views (profiles) to which the user has access.
 
 patch ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_Profile $postBody, $optParams=array())
 Updates an existing view (profile).
 
 update ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_Profile $postBody, $optParams=array())
 Updates an existing view (profile).
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "profiles" collection of methods.

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

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_ManagementProfiles_Resource::delete ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Deletes a view (profile).

(profiles.delete)

Parameters
string$accountIdAccount ID to delete the view (profile) for.
string$webPropertyIdWeb property ID to delete the view (profile) for.
string$profileIdID of the view (profile) to be deleted.
array$optParamsOptional parameters.

◆ get()

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

Gets a view (profile) to which the user has access.

(profiles.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.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Profile

◆ insert()

Google_Service_Analytics_ManagementProfiles_Resource::insert ( $accountId,
$webPropertyId,
Google_Service_Analytics_Profile $postBody,
$optParams = array() )

Create a new view (profile).

(profiles.insert)

Parameters
string$accountIdAccount ID to create the view (profile) for.
string$webPropertyIdWeb property ID to create the view (profile) for.
Google_Profile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Profile

◆ listManagementProfiles()

Google_Service_Analytics_ManagementProfiles_Resource::listManagementProfiles ( $accountId,
$webPropertyId,
$optParams = array() )

Lists views (profiles) to which the user has access.

(profiles.listManagementProfiles)

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

@opt_param int max-results The maximum number of views (profiles) 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_Profiles

◆ patch()

Google_Service_Analytics_ManagementProfiles_Resource::patch ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_Profile $postBody,
$optParams = array() )

Updates an existing view (profile).

This method supports patch semantics. (profiles.patch)

Parameters
string$accountIdAccount ID to which the view (profile) belongs
string$webPropertyIdWeb property ID to which the view (profile) belongs
string$profileIdID of the view (profile) to be updated.
Google_Profile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Profile

◆ update()

Google_Service_Analytics_ManagementProfiles_Resource::update ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_Profile $postBody,
$optParams = array() )

Updates an existing view (profile).

(profiles.update)

Parameters
string$accountIdAccount ID to which the view (profile) belongs
string$webPropertyIdWeb property ID to which the view (profile) belongs
string$profileIdID of the view (profile) to be updated.
Google_Profile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Profile

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