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
Namespace
Google \ Analytics \ Data \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ api_name
↳ ui_name
string
This metric's name within the Google Analytics user interface. For example, Event count
.
↳ 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 apiName
or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be available only by apiName
.
↳ type
int
The type of this metric.
↳ expression
string
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.
↳ 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
.
string
setApiName
A metric name. Useable in Metric
's name
. For example, eventCount
.
var
string
$this
getUiName
This metric's name within the Google Analytics user interface. For example, Event count
.
string
setUiName
This metric's name within the Google Analytics user interface. For example, Event count
.
var
string
$this
getDescription
Description of how this metric is used and calculated.
string
setDescription
Description of how this metric is used and calculated.
var
string
$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
.
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
.
var
string[]
$this
getType
The type of this metric.
int
setType
The type of this metric.
var
int
$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.
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.
var
string
$this
getCustomDefinition
True if the metric is a custom metric for this property.
bool
setCustomDefinition
True if the metric is a custom metric for this property.
var
bool
$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 .
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 .
var
int[]
$this
getCategory
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
string
setCategory
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
var
string
$this
