Class protos.google.analytics.admin.v1alpha.EventMapping (7.6.0)

Represents an EventMapping.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

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

Constructs a new EventMapping.

Parameter
Name Description
properties IEventMapping

Properties to set

Properties

_maxEventCount

public _maxEventCount?: "maxEventCount";

EventMapping _maxEventCount.

_maxEventValue

public _maxEventValue?: "maxEventValue";

EventMapping _maxEventValue.

_minEventCount

public _minEventCount?: "minEventCount";

EventMapping _minEventCount.

_minEventValue

public _minEventValue?: "minEventValue";

EventMapping _minEventValue.

eventName

public eventName: string;

EventMapping eventName.

maxEventCount

public maxEventCount?: (number|Long|string|null);

EventMapping maxEventCount.

maxEventValue

public maxEventValue?: (number|null);

EventMapping maxEventValue.

minEventCount

public minEventCount?: (number|Long|string|null);

EventMapping minEventCount.

minEventValue

public minEventValue?: (number|null);

EventMapping minEventValue.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.IEventMapping): google.analytics.admin.v1alpha.EventMapping;

Creates a new EventMapping instance using the specified properties.

Parameter
Name Description
properties IEventMapping

Properties to set

Returns
Type Description
EventMapping

EventMapping instance

decode(reader, length)

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

Decodes an EventMapping 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
EventMapping

EventMapping

decodeDelimited(reader)

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

Decodes an EventMapping message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EventMapping

EventMapping

encode(message, writer)

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

Encodes the specified EventMapping message. Does not implicitly messages.

Parameters
Name Description
message IEventMapping

EventMapping 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.IEventMapping, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEventMapping

EventMapping 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.EventMapping;

Creates an EventMapping 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
EventMapping

EventMapping

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EventMapping

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EventMapping

EventMapping

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 an EventMapping 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