Class protos.google.analytics.data.v1alpha.EventSegmentExclusion (4.6.0)

Represents an EventSegmentExclusion.

Package

@google-analytics/data

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.data.v1alpha.IEventSegmentExclusion);

Constructs a new EventSegmentExclusion.

Parameter
Name Description
properties IEventSegmentExclusion

Properties to set

Properties

eventExclusionCriteria

public eventExclusionCriteria?: (google.analytics.data.v1alpha.IEventSegmentCriteria|null);

EventSegmentExclusion eventExclusionCriteria.

eventExclusionDuration

public eventExclusionDuration: (google.analytics.data.v1alpha.EventExclusionDuration|keyof typeof google.analytics.data.v1alpha.EventExclusionDuration);

EventSegmentExclusion eventExclusionDuration.

Methods

create(properties)

public static create(properties?: google.analytics.data.v1alpha.IEventSegmentExclusion): google.analytics.data.v1alpha.EventSegmentExclusion;

Creates a new EventSegmentExclusion instance using the specified properties.

Parameter
Name Description
properties IEventSegmentExclusion

Properties to set

Returns
Type Description
EventSegmentExclusion

EventSegmentExclusion instance

decode(reader, length)

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

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

EventSegmentExclusion

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EventSegmentExclusion

EventSegmentExclusion

encode(message, writer)

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

Encodes the specified EventSegmentExclusion message. Does not implicitly messages.

Parameters
Name Description
message IEventSegmentExclusion

EventSegmentExclusion 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.data.v1alpha.IEventSegmentExclusion, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEventSegmentExclusion

EventSegmentExclusion 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.data.v1alpha.EventSegmentExclusion;

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

EventSegmentExclusion

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EventSegmentExclusion

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EventSegmentExclusion

EventSegmentExclusion

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