Class protos.google.analytics.admin.v1alpha.CalculatedMetric (7.3.0)

Represents a CalculatedMetric.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1alpha.ICalculatedMetric);

Constructs a new CalculatedMetric.

Parameter
Name Description
properties ICalculatedMetric

Properties to set

Properties

calculatedMetricId

public calculatedMetricId: string;

CalculatedMetric calculatedMetricId.

description

public description: string;

CalculatedMetric description.

displayName

public displayName: string;

CalculatedMetric displayName.

formula

public formula: string;

CalculatedMetric formula.

invalidMetricReference

public invalidMetricReference: boolean;

CalculatedMetric invalidMetricReference.

metricUnit

public metricUnit: (google.analytics.admin.v1alpha.CalculatedMetric.MetricUnit|keyof typeof google.analytics.admin.v1alpha.CalculatedMetric.MetricUnit);

CalculatedMetric metricUnit.

name

public name: string;

CalculatedMetric name.

restrictedMetricType

public restrictedMetricType: google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType[];

CalculatedMetric restrictedMetricType.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.ICalculatedMetric): google.analytics.admin.v1alpha.CalculatedMetric;

Creates a new CalculatedMetric instance using the specified properties.

Parameter
Name Description
properties ICalculatedMetric

Properties to set

Returns
Type Description
CalculatedMetric

CalculatedMetric instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1alpha.CalculatedMetric;

Decodes a CalculatedMetric message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
CalculatedMetric

CalculatedMetric

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1alpha.CalculatedMetric;

Decodes a CalculatedMetric message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CalculatedMetric

CalculatedMetric

encode(message, writer)

public static encode(message: google.analytics.admin.v1alpha.ICalculatedMetric, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CalculatedMetric message. Does not implicitly messages.

Parameters
Name Description
message ICalculatedMetric

CalculatedMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.analytics.admin.v1alpha.ICalculatedMetric, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CalculatedMetric message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ICalculatedMetric

CalculatedMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1alpha.CalculatedMetric;

Creates a CalculatedMetric message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
CalculatedMetric

CalculatedMetric

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for CalculatedMetric

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this CalculatedMetric to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.analytics.admin.v1alpha.CalculatedMetric, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message CalculatedMetric

CalculatedMetric

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CalculatedMetric message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not