Class GoogleAnalyticsAdminV1alphaCalculatedMetric
A definition for a calculated metric.
Implements
Inherited Members
Namespace: Google.Apis.GoogleAnalyticsAdmin.v1alpha.Data
Assembly: Google.Apis.GoogleAnalyticsAdmin.v1alpha.dll
Syntax
public class GoogleAnalyticsAdminV1alphaCalculatedMetric : IDirectResponseSchema
Properties
CalculatedMetricId
Output only. The ID to use for the calculated metric. In the UI, this is referred to as the "API name." The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, "calcMetric:{calculated_metric_id}".
Declaration
[JsonProperty("calculatedMetricId")]
public virtual string CalculatedMetricId { get; set; }
Property Value
Type | Description |
---|---|
string |
Description
Optional. Description for this calculated metric. Max length of 4096 characters.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Formula
Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
Declaration
[JsonProperty("formula")]
public virtual string Formula { get; set; }
Property Value
Type | Description |
---|---|
string |
InvalidMetricReference
Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.
Declaration
[JsonProperty("invalidMetricReference")]
public virtual bool? InvalidMetricReference { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MetricUnit
Required. The type for the calculated metric's value.
Declaration
[JsonProperty("metricUnit")]
public virtual string MetricUnit { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
RestrictedMetricType
Output only. Types of restricted data that this metric contains.
Declaration
[JsonProperty("restrictedMetricType")]
public virtual IList<string> RestrictedMetricType { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |