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

The "profileFilterLinks" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementProfileFilterLinks_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())
 Delete a profile filter link.
 
 get ($accountId, $webPropertyId, $profileId, $linkId, $optParams=array())
 Returns a single profile filter link.
 
 insert ($accountId, $webPropertyId, $profileId, Google_Service_Analytics_ProfileFilterLink $postBody, $optParams=array())
 Create a new profile filter link.
 
 listManagementProfileFilterLinks ($accountId, $webPropertyId, $profileId, $optParams=array())
 Lists all profile filter links for a profile.
 
 patch ($accountId, $webPropertyId, $profileId, $linkId, Google_Service_Analytics_ProfileFilterLink $postBody, $optParams=array())
 Update an existing profile filter link.
 
 update ($accountId, $webPropertyId, $profileId, $linkId, Google_Service_Analytics_ProfileFilterLink $postBody, $optParams=array())
 Update an existing profile filter link.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "profileFilterLinks" collection of methods.

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

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

Delete a profile filter link.

(profileFilterLinks.delete)

Parameters
string$accountIdAccount ID to which the profile filter link belongs.
string$webPropertyIdWeb property Id to which the profile filter link belongs.
string$profileIdProfile ID to which the filter link belongs.
string$linkIdID of the profile filter link to delete.
array$optParamsOptional parameters.

◆ get()

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

Returns a single profile filter link.

(profileFilterLinks.get)

Parameters
string$accountIdAccount ID to retrieve profile filter link for.
string$webPropertyIdWeb property Id to retrieve profile filter link for.
string$profileIdProfile ID to retrieve filter link for.
string$linkIdID of the profile filter link.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_ProfileFilterLink

◆ insert()

Google_Service_Analytics_ManagementProfileFilterLinks_Resource::insert ( $accountId,
$webPropertyId,
$profileId,
Google_Service_Analytics_ProfileFilterLink $postBody,
$optParams = array() )

Create a new profile filter link.

(profileFilterLinks.insert)

Parameters
string$accountIdAccount ID to create profile filter link for.
string$webPropertyIdWeb property Id to create profile filter link for.
string$profileIdProfile ID to create filter link for.
Google_ProfileFilterLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_ProfileFilterLink

◆ listManagementProfileFilterLinks()

Google_Service_Analytics_ManagementProfileFilterLinks_Resource::listManagementProfileFilterLinks ( $accountId,
$webPropertyId,
$profileId,
$optParams = array() )

Lists all profile filter links for a profile.

(profileFilterLinks.listManagementProfileFilterLinks)

Parameters
string$accountIdAccount ID to retrieve profile filter links for.
string$webPropertyIdWeb property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
string$profileIdProfile ID to retrieve filter 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 filter links 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_ProfileFilterLinks

◆ patch()

Google_Service_Analytics_ManagementProfileFilterLinks_Resource::patch ( $accountId,
$webPropertyId,
$profileId,
$linkId,
Google_Service_Analytics_ProfileFilterLink $postBody,
$optParams = array() )

Update an existing profile filter link.

This method supports patch semantics. (profileFilterLinks.patch)

Parameters
string$accountIdAccount ID to which profile filter link belongs.
string$webPropertyIdWeb property Id to which profile filter link belongs
string$profileIdProfile ID to which filter link belongs
string$linkIdID of the profile filter link to be updated.
Google_ProfileFilterLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_ProfileFilterLink

◆ update()

Google_Service_Analytics_ManagementProfileFilterLinks_Resource::update ( $accountId,
$webPropertyId,
$profileId,
$linkId,
Google_Service_Analytics_ProfileFilterLink $postBody,
$optParams = array() )

Update an existing profile filter link.

(profileFilterLinks.update)

Parameters
string$accountIdAccount ID to which profile filter link belongs.
string$webPropertyIdWeb property Id to which profile filter link belongs
string$profileIdProfile ID to which filter link belongs
string$linkIdID of the profile filter link to be updated.
Google_ProfileFilterLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_ProfileFilterLink

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