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

The "profileUserLinks" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementProfileUserLinks_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($accountId, $webPropertyId, $profileId, $linkId, $optParams=array())
 Removes a user from the given view (profile).
 
 insert ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_EntityUserLink $postBody, $optParams=array())
 Adds a new user to the given view (profile).
 
 listManagementProfileUserLinks ($accountId, $webPropertyId, $profileId, $optParams=array())
 Lists profile-user links for a given view (profile).
 
 update ($accountId, $webPropertyId, $profileId, $linkId, Google_Service_Analytics_EntityUserLink $postBody, $optParams=array())
 Updates permissions for an existing user on the given view (profile).
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "profileUserLinks" collection of methods.

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

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

Removes a user from the given view (profile).

(profileUserLinks.delete)

Parameters
string$accountIdAccount ID to delete the user link for.
string$webPropertyIdWeb Property ID to delete the user link for.
string$profileIdView (Profile) ID to delete the user link for.
string$linkIdLink ID to delete the user link for.
array$optParamsOptional parameters.

◆ insert()

Google_Service_Analytics_ManagementProfileUserLinks_Resource::insert ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_EntityUserLink $postBody,
$optParams = array() )

Adds a new user to the given view (profile).

(profileUserLinks.insert)

Parameters
string$accountIdAccount ID to create the user link for.
string$webPropertyIdWeb Property ID to create the user link for.
string$profileIdView (Profile) ID to create the user link for.
Google_EntityUserLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_EntityUserLink

◆ listManagementProfileUserLinks()

Google_Service_Analytics_ManagementProfileUserLinks_Resource::listManagementProfileUserLinks ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Lists profile-user links for a given view (profile).

(profileUserLinks.listManagementProfileUserLinks)

Parameters
string$accountIdAccount ID which the given view (profile) belongs to.
string$webPropertyIdWeb Property ID which the given view (profile) belongs to. 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 the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.
array$optParamsOptional parameters.

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

Return values
Google_Service_Analytics_EntityUserLinks

◆ update()

Google_Service_Analytics_ManagementProfileUserLinks_Resource::update ( $accountId,
$webPropertyId,
$profileId,
$linkId,
Google_Service_Analytics_EntityUserLink $postBody,
$optParams = array() )

Updates permissions for an existing user on the given view (profile).

(profileUserLinks.update)

Parameters
string$accountIdAccount ID to update the user link for.
string$webPropertyIdWeb Property ID to update the user link for.
string$profileIdView (Profile ID) to update the user link for.
string$linkIdLink ID to update the user link for.
Google_EntityUserLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_EntityUserLink

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