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

The "webproperties" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementWebproperties_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($accountId, $webPropertyId, $optParams=array())
 Gets a web property to which the user has access.
 
 insert ($accountId, Google_Service_Analytics_Webproperty $postBody, $optParams=array())
 Create a new property if the account has fewer than 20 properties.
 
 listManagementWebproperties ($accountId, $optParams=array())
 Lists web properties to which the user has access.
 
 patch ($accountId, $webPropertyId, Google_Service_Analytics_Webproperty $postBody, $optParams=array())
 Updates an existing web property.
 
 update ($accountId, $webPropertyId, Google_Service_Analytics_Webproperty $postBody, $optParams=array())
 Updates an existing web property.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "webproperties" collection of methods.

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

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

Gets a web property to which the user has access.

(webproperties.get)

Parameters
string$accountIdAccount ID to retrieve the web property for.
string$webPropertyIdID to retrieve the web property for.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Webproperty

◆ insert()

Google_Service_Analytics_ManagementWebproperties_Resource::insert ( $accountId,
Google_Service_Analytics_Webproperty $postBody,
$optParams = array() )

Create a new property if the account has fewer than 20 properties.

Web properties are visible in the Google Analytics interface only if they have at least one profile. (webproperties.insert)

Parameters
string$accountIdAccount ID to create the web property for.
Google_Webproperty$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Webproperty

◆ listManagementWebproperties()

Google_Service_Analytics_ManagementWebproperties_Resource::listManagementWebproperties ( $accountId,
$optParams = array() )

Lists web properties to which the user has access.

(webproperties.listManagementWebproperties)

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

@opt_param int max-results The maximum number of web properties 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_Webproperties

◆ patch()

Google_Service_Analytics_ManagementWebproperties_Resource::patch ( $accountId,
$webPropertyId,
Google_Service_Analytics_Webproperty $postBody,
$optParams = array() )

Updates an existing web property.

This method supports patch semantics. (webproperties.patch)

Parameters
string$accountIdAccount ID to which the web property belongs
string$webPropertyIdWeb property ID
Google_Webproperty$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Webproperty

◆ update()

Google_Service_Analytics_ManagementWebproperties_Resource::update ( $accountId,
$webPropertyId,
Google_Service_Analytics_Webproperty $postBody,
$optParams = array() )

Updates an existing web property.

(webproperties.update)

Parameters
string$accountIdAccount ID to which the web property belongs
string$webPropertyIdWeb property ID
Google_Webproperty$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Webproperty

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