MetricMetadata

google.analytics.data.v1beta. MetricMetadata

Represents a MetricMetadata.

Constructor

new MetricMetadata(propertiesopt)

Constructs a new MetricMetadata.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1beta.IMetricMetadata <optional>

Properties to set

Implements:
  • IMetricMetadata

Members

BlockedReason

BlockedReason enum.

Properties:
Name Type Description
BLOCKED_REASON_UNSPECIFIED number

BLOCKED_REASON_UNSPECIFIED value

NO_REVENUE_METRICS number

NO_REVENUE_METRICS value

NO_COST_METRICS number

NO_COST_METRICS value

apiName

MetricMetadata apiName.

blockedReasons

MetricMetadata blockedReasons.

category

MetricMetadata category.

customDefinition

MetricMetadata customDefinition.

deprecatedApiNames

MetricMetadata deprecatedApiNames.

description

MetricMetadata description.

expression

MetricMetadata expression.

type

MetricMetadata type.

uiName

MetricMetadata uiName.

Methods

(static) create(propertiesopt) → {google.analytics.data.v1beta.MetricMetadata}

Creates a new MetricMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1beta.IMetricMetadata <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1beta.MetricMetadata

MetricMetadata instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1beta.MetricMetadata}

Decodes a MetricMetadata 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.data.v1beta.MetricMetadata

MetricMetadata

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.data.v1beta.MetricMetadata}

Decodes a MetricMetadata 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.data.v1beta.MetricMetadata

MetricMetadata

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.IMetricMetadata

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.IMetricMetadata

MetricMetadata 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.data.v1beta.MetricMetadata}

Creates a MetricMetadata 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.data.v1beta.MetricMetadata

MetricMetadata

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

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.MetricMetadata

MetricMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a MetricMetadata 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 MetricMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object