Google Analytics Admin V1alpha Client - Class CreateCalculatedMetricRequest (0.23.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class CreateCalculatedMetricRequest.

Request message for CreateCalculatedMetric RPC.

Generated from protobuf message google.analytics.admin.v1alpha.CreateCalculatedMetricRequest

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Format: properties/{property_id} Example: properties/1234

↳ calculated_metric_id string

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

↳ calculated_metric Google\Analytics\Admin\V1alpha\CalculatedMetric

Required. The CalculatedMetric to create.

getParent

Required. Format: properties/{property_id} Example: properties/1234

Returns
Type Description
string

setParent

Required. Format: properties/{property_id} Example: properties/1234

Parameter
Name Description
var string
Returns
Type Description
$this

getCalculatedMetricId

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

Returns
Type Description
string

setCalculatedMetricId

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

Parameter
Name Description
var string
Returns
Type Description
$this

getCalculatedMetric

Required. The CalculatedMetric to create.

Returns
Type Description
Google\Analytics\Admin\V1alpha\CalculatedMetric|null

hasCalculatedMetric

clearCalculatedMetric

setCalculatedMetric

Required. The CalculatedMetric to create.

Parameter
Name Description
var Google\Analytics\Admin\V1alpha\CalculatedMetric
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Format: properties/{property_id} Example: properties/1234 Please see Google\Analytics\Admin\V1alpha\AnalyticsAdminServiceClient::propertyName() for help formatting this field.

calculatedMetric Google\Analytics\Admin\V1alpha\CalculatedMetric

Required. The CalculatedMetric to create.

calculatedMetricId string

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

Returns
Type Description
Google\Analytics\Admin\V1alpha\CreateCalculatedMetricRequest