Constructor
new CalculatedMetric(propertiesopt)
Constructs a new CalculatedMetric.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.admin.v1alpha.ICalculatedMetric |
<optional> |
Properties to set |
- Implements:
-
- ICalculatedMetric
Members
calculatedMetricId
CalculatedMetric calculatedMetricId.
description
CalculatedMetric description.
displayName
CalculatedMetric displayName.
formula
CalculatedMetric formula.
invalidMetricReference
CalculatedMetric invalidMetricReference.
metricUnit
CalculatedMetric metricUnit.
name
CalculatedMetric name.
restrictedMetricType
CalculatedMetric restrictedMetricType.
MetricUnit
MetricUnit enum.
Properties:
| Name | Type | Description |
|---|---|---|
METRIC_UNIT_UNSPECIFIED |
number |
METRIC_UNIT_UNSPECIFIED value |
STANDARD |
number |
STANDARD value |
CURRENCY |
number |
CURRENCY value |
FEET |
number |
FEET value |
MILES |
number |
MILES value |
METERS |
number |
METERS value |
KILOMETERS |
number |
KILOMETERS value |
MILLISECONDS |
number |
MILLISECONDS value |
SECONDS |
number |
SECONDS value |
MINUTES |
number |
MINUTES value |
HOURS |
number |
HOURS value |
RestrictedMetricType
RestrictedMetricType enum.
Properties:
| Name | Type | Description |
|---|---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
number |
RESTRICTED_METRIC_TYPE_UNSPECIFIED value |
COST_DATA |
number |
COST_DATA value |
REVENUE_DATA |
number |
REVENUE_DATA value |
Methods
toJSON() → {Object.<string, *>}
Converts this CalculatedMetric to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.analytics.admin.v1alpha.CalculatedMetric}
Creates a new CalculatedMetric instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.admin.v1alpha.ICalculatedMetric |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CalculatedMetric |
CalculatedMetric instance |
(static) decode(reader, lengthopt) → {google.analytics.admin.v1alpha.CalculatedMetric}
Decodes a CalculatedMetric message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CalculatedMetric |
CalculatedMetric |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.analytics.admin.v1alpha.CalculatedMetric}
Decodes a CalculatedMetric message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CalculatedMetric |
CalculatedMetric |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified CalculatedMetric message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.ICalculatedMetric |
CalculatedMetric message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified CalculatedMetric message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.ICalculatedMetric |
CalculatedMetric message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.analytics.admin.v1alpha.CalculatedMetric}
Creates a CalculatedMetric message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CalculatedMetric |
CalculatedMetric |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CalculatedMetric
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a CalculatedMetric message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.CalculatedMetric |
CalculatedMetric |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CalculatedMetric message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|