Documentation

Google_Service_Analytics_Resource_ManagementWebpropertyUserLinks extends Google_Service_Resource
in package

The "webpropertyUserLinks" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Removes a user from the given web property. (webpropertyUserLinks.delete)
insert()  : Google_Service_Analytics_EntityUserLink
Adds a new user to the given web property. (webpropertyUserLinks.insert)
listManagementWebpropertyUserLinks()  : Google_Service_Analytics_EntityUserLinks
Lists webProperty-user links for a given web property.
update()  : Google_Service_Analytics_EntityUserLink
Updates permissions for an existing user on the given web property.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Removes a user from the given web property. (webpropertyUserLinks.delete)

public delete(string $accountId, string $webPropertyId, string $linkId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$accountId : string

Account ID to delete the user link for.

$webPropertyId : string

Web Property ID to delete the user link for.

$linkId : string

Link ID to delete the user link for.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

insert()

Adds a new user to the given web property. (webpropertyUserLinks.insert)

public insert(string $accountId, string $webPropertyId, Google_Service_Analytics_EntityUserLink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_EntityUserLink
Parameters
$accountId : string

Account ID to create the user link for.

$webPropertyId : string

Web Property ID to create the user link for.

$postBody : Google_Service_Analytics_EntityUserLink
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_EntityUserLink —

listManagementWebpropertyUserLinks()

Lists webProperty-user links for a given web property.

public listManagementWebpropertyUserLinks(string $accountId, string $webPropertyId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_EntityUserLinks

(webpropertyUserLinks.listManagementWebpropertyUserLinks)

Parameters
$accountId : string

Account ID which the given web property belongs to.

$webPropertyId : string

Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int max-results The maximum number of webProperty-user Links to include in this response.

opt_param

int start-index An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max- results parameter.

Return values
Google_Service_Analytics_EntityUserLinks —

update()

Updates permissions for an existing user on the given web property.

public update(string $accountId, string $webPropertyId, string $linkId, Google_Service_Analytics_EntityUserLink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_EntityUserLink

(webpropertyUserLinks.update)

Parameters
$accountId : string

Account ID to update the account-user link for.

$webPropertyId : string

Web property ID to update the account-user link for.

$linkId : string

Link ID to update the account-user link for.

$postBody : Google_Service_Analytics_EntityUserLink
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_EntityUserLink —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results