Documentation

Google_Service_Analytics_Resource_ManagementCustomMetrics extends Google_Service_Resource
in package

The "customMetrics" collection of methods.

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

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.
get()  : Google_Service_Analytics_CustomMetric
Get a custom metric to which the user has access. (customMetrics.get)
insert()  : Google_Service_Analytics_CustomMetric
Create a new custom metric. (customMetrics.insert)
listManagementCustomMetrics()  : Google_Service_Analytics_CustomMetrics
Lists custom metrics to which the user has access.
patch()  : Google_Service_Analytics_CustomMetric
Updates an existing custom metric. This method supports patch semantics.
update()  : Google_Service_Analytics_CustomMetric
Updates an existing custom metric. (customMetrics.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

get()

Get a custom metric to which the user has access. (customMetrics.get)

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

Account ID for the custom metric to retrieve.

$webPropertyId : string

Web property ID for the custom metric to retrieve.

$customMetricId : string

The ID of the custom metric to retrieve.

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

Optional parameters.

Return values
Google_Service_Analytics_CustomMetric —

insert()

Create a new custom metric. (customMetrics.insert)

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

Account ID for the custom metric to create.

$webPropertyId : string

Web property ID for the custom dimension to create.

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

Optional parameters.

Return values
Google_Service_Analytics_CustomMetric —

listManagementCustomMetrics()

Lists custom metrics to which the user has access.

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

(customMetrics.listManagementCustomMetrics)

Parameters
$accountId : string

Account ID for the custom metrics to retrieve.

$webPropertyId : string

Web property ID for the custom metrics to retrieve.

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

Optional parameters.

Tags
opt_param

int max-results The maximum number of custom metrics 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_CustomMetrics —

patch()

Updates an existing custom metric. This method supports patch semantics.

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

(customMetrics.patch)

Parameters
$accountId : string

Account ID for the custom metric to update.

$webPropertyId : string

Web property ID for the custom metric to update.

$customMetricId : string

Custom metric ID for the custom metric to update.

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

Optional parameters.

Tags
opt_param

bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Return values
Google_Service_Analytics_CustomMetric —

update()

Updates an existing custom metric. (customMetrics.update)

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

Account ID for the custom metric to update.

$webPropertyId : string

Web property ID for the custom metric to update.

$customMetricId : string

Custom metric ID for the custom metric to update.

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

Optional parameters.

Tags
opt_param

bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Return values
Google_Service_Analytics_CustomMetric —

convertToArrayAndStripNulls()

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

Search results