CustomMetric

google.analytics.admin.v1alpha. CustomMetric

Represents a CustomMetric.

Constructor

new CustomMetric(propertiesopt)

Constructs a new CustomMetric.

Parameters:
Name Type Attributes Description
properties google.analytics.admin.v1alpha.ICustomMetric <optional>

Properties to set
Implements:
  • ICustomMetric

Members

MeasurementUnit

MeasurementUnit enum.

Properties:
Name Type Description
MEASUREMENT_UNIT_UNSPECIFIED number

MEASUREMENT_UNIT_UNSPECIFIED value
STANDARD number

STANDARD value
CURRENCY number

CURRENCY value
FEET number

FEET value
METERS number

METERS value
KILOMETERS number

KILOMETERS value
MILES number

MILES value
MILLISECONDS number

MILLISECONDS value
SECONDS number

SECONDS value
MINUTES number

MINUTES value
HOURS number

HOURS value

MetricScope

MetricScope enum.

Properties:
Name Type Description
METRIC_SCOPE_UNSPECIFIED number

METRIC_SCOPE_UNSPECIFIED value
EVENT number

EVENT 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

description

CustomMetric description.

displayName

CustomMetric displayName.

measurementUnit

CustomMetric measurementUnit.

name

CustomMetric name.

parameterName

CustomMetric parameterName.

restrictedMetricType

CustomMetric restrictedMetricType.

scope

CustomMetric scope.

Methods

(static) create(propertiesopt) → {google.analytics.admin.v1alpha.CustomMetric}

Creates a new CustomMetric instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.admin.v1alpha.ICustomMetric <optional>

Properties to set
Returns:
Type Description
google.analytics.admin.v1alpha.CustomMetric

CustomMetric instance

(static) decode(reader, lengthopt) → {google.analytics.admin.v1alpha.CustomMetric}

Decodes a CustomMetric 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.CustomMetric

CustomMetric
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.CustomMetric}

Decodes a CustomMetric 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.CustomMetric

CustomMetric
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 CustomMetric message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.ICustomMetric

CustomMetric 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 CustomMetric message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.ICustomMetric

CustomMetric 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.CustomMetric}

Creates a CustomMetric 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.CustomMetric

CustomMetric

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a CustomMetric message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.CustomMetric

CustomMetric
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a CustomMetric message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this CustomMetric to JSON.

Returns:
Type Description
Object.<string, *>

JSON object