Documentation

Google_Service_Analytics_Resource_ManagementProfileFilterLinks extends Google_Service_Resource
in package

The "profileFilterLinks" collection of methods.

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

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
Delete a profile filter link. (profileFilterLinks.delete)
get()  : Google_Service_Analytics_ProfileFilterLink
Returns a single profile filter link. (profileFilterLinks.get)
insert()  : Google_Service_Analytics_ProfileFilterLink
Create a new profile filter link. (profileFilterLinks.insert)
listManagementProfileFilterLinks()  : Google_Service_Analytics_ProfileFilterLinks
Lists all profile filter links for a profile.
patch()  : Google_Service_Analytics_ProfileFilterLink
Update an existing profile filter link. This method supports patch semantics.
update()  : Google_Service_Analytics_ProfileFilterLink
Update an existing profile filter link. (profileFilterLinks.update)
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()

Delete a profile filter link. (profileFilterLinks.delete)

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

Account ID to which the profile filter link belongs.

$webPropertyId : string

Web property Id to which the profile filter link belongs.

$profileId : string

Profile ID to which the filter link belongs.

$linkId : string

ID of the profile filter link to delete.

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

Optional parameters.

Return values
mixed

get()

Returns a single profile filter link. (profileFilterLinks.get)

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

Account ID to retrieve profile filter link for.

$webPropertyId : string

Web property Id to retrieve profile filter link for.

$profileId : string

Profile ID to retrieve filter link for.

$linkId : string

ID of the profile filter link.

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

Optional parameters.

Return values
Google_Service_Analytics_ProfileFilterLink

insert()

Create a new profile filter link. (profileFilterLinks.insert)

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

Account ID to create profile filter link for.

$webPropertyId : string

Web property Id to create profile filter link for.

$profileId : string

Profile ID to create filter link for.

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

Optional parameters.

Return values
Google_Service_Analytics_ProfileFilterLink

Lists all profile filter links for a profile.

public listManagementProfileFilterLinks(string $accountId, string $webPropertyId, string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_ProfileFilterLinks

(profileFilterLinks.listManagementProfileFilterLinks)

Parameters
$accountId : string

Account ID to retrieve profile filter links for.

$webPropertyId : string

Web 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.

$profileId : string

Profile 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.

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

Optional parameters.

Tags
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()

Update an existing profile filter link. This method supports patch semantics.

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

(profileFilterLinks.patch)

Parameters
$accountId : string

Account ID to which profile filter link belongs.

$webPropertyId : string

Web property Id to which profile filter link belongs

$profileId : string

Profile ID to which filter link belongs

$linkId : string

ID of the profile filter link to be updated.

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

Optional parameters.

Return values
Google_Service_Analytics_ProfileFilterLink

update()

Update an existing profile filter link. (profileFilterLinks.update)

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

Account ID to which profile filter link belongs.

$webPropertyId : string

Web property Id to which profile filter link belongs

$profileId : string

Profile ID to which filter link belongs

$linkId : string

ID of the profile filter link to be updated.

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

Optional parameters.

Return values
Google_Service_Analytics_ProfileFilterLink

convertToArrayAndStripNulls()

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

Search results