Reference documentation and code samples for the Google Analytics Data V1beta Client class MetricMetadata.
Explains a metric.
Generated from protobuf message google.analytics.data.v1beta.MetricMetadata
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ api_name |
string
A metric name. Useable in Metric's |
↳ ui_name |
string
This metric's name within the Google Analytics user interface. For example, |
↳ description |
string
Description of how this metric is used and calculated. |
↳ deprecated_api_names |
array
Still usable but deprecated names for this metric. If populated, this metric is available by either |
↳ type |
int
The type of this metric. |
↳ expression |
string
The mathematical expression for this derived metric. Can be used in Metric's |
↳ custom_definition |
bool
True if the metric is a custom metric for this property. |
↳ blocked_reasons |
array
If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see Access and data-restriction management. |
↳ category |
string
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. |
getApiName
A metric name. Useable in Metric's name. For example,
eventCount.
| Returns | |
|---|---|
| Type | Description |
string | |
setApiName
A metric name. Useable in Metric's name. For example,
eventCount.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUiName
This metric's name within the Google Analytics user interface. For example,
Event count.
| Returns | |
|---|---|
| Type | Description |
string | |
setUiName
This metric's name within the Google Analytics user interface. For example,
Event count.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of how this metric is used and calculated.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of how this metric is used and calculated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeprecatedApiNames
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDeprecatedApiNames
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of this metric.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of this metric.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpression
The mathematical expression for this derived metric. Can be used in
Metric's expression field for equivalent reports. Most metrics
are not expressions, and for non-expressions, this field is empty.
| Returns | |
|---|---|
| Type | Description |
string | |
setExpression
The mathematical expression for this derived metric. Can be used in
Metric's expression field for equivalent reports. Most metrics
are not expressions, and for non-expressions, this field is empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomDefinition
True if the metric is a custom metric for this property.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCustomDefinition
True if the metric is a custom metric for this property.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBlockedReasons
If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.
To learn more, see Access and data-restriction management.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setBlockedReasons
If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.
To learn more, see Access and data-restriction management.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategory
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
| Returns | |
|---|---|
| Type | Description |
string | |
setCategory
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |