Class protos.google.analytics.admin.v1beta.CustomMetric (7.3.0)

Represents a CustomMetric.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1beta.ICustomMetric);

Constructs a new CustomMetric.

Parameter
Name Description
properties ICustomMetric

Properties to set

Properties

description

public description: string;

CustomMetric description.

displayName

public displayName: string;

CustomMetric displayName.

measurementUnit

public measurementUnit: (google.analytics.admin.v1beta.CustomMetric.MeasurementUnit|keyof typeof google.analytics.admin.v1beta.CustomMetric.MeasurementUnit);

CustomMetric measurementUnit.

name

public name: string;

CustomMetric name.

parameterName

public parameterName: string;

CustomMetric parameterName.

restrictedMetricType

public restrictedMetricType: google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType[];

CustomMetric restrictedMetricType.

scope

public scope: (google.analytics.admin.v1beta.CustomMetric.MetricScope|keyof typeof google.analytics.admin.v1beta.CustomMetric.MetricScope);

CustomMetric scope.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1beta.ICustomMetric): google.analytics.admin.v1beta.CustomMetric;

Creates a new CustomMetric instance using the specified properties.

Parameter
Name Description
properties ICustomMetric

Properties to set

Returns
Type Description
CustomMetric

CustomMetric instance

decode(reader, length)

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

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

CustomMetric

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CustomMetric

CustomMetric

encode(message, writer)

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

Encodes the specified CustomMetric message. Does not implicitly messages.

Parameters
Name Description
message ICustomMetric

CustomMetric 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.v1beta.ICustomMetric, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICustomMetric

CustomMetric 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.v1beta.CustomMetric;

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

CustomMetric

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CustomMetric

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 CustomMetric to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CustomMetric

CustomMetric

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