Class protos.google.analytics.data.v1alpha.Segment (4.5.0)

Represents a Segment.

Package

@google-analytics/data

Constructors

(constructor)(properties)

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

Constructs a new Segment.

Parameter
Name Description
properties ISegment

Properties to set

Properties

eventSegment

public eventSegment?: (google.analytics.data.v1alpha.IEventSegment|null);

Segment eventSegment.

name

public name: string;

Segment name.

oneSegmentScope

public oneSegmentScope?: ("userSegment"|"sessionSegment"|"eventSegment");

Segment oneSegmentScope.

sessionSegment

public sessionSegment?: (google.analytics.data.v1alpha.ISessionSegment|null);

Segment sessionSegment.

userSegment

public userSegment?: (google.analytics.data.v1alpha.IUserSegment|null);

Segment userSegment.

Methods

create(properties)

public static create(properties?: google.analytics.data.v1alpha.ISegment): google.analytics.data.v1alpha.Segment;

Creates a new Segment instance using the specified properties.

Parameter
Name Description
properties ISegment

Properties to set

Returns
Type Description
Segment

Segment instance

decode(reader, length)

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

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

Segment

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Segment

Segment

encode(message, writer)

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

Encodes the specified Segment message. Does not implicitly messages.

Parameters
Name Description
message ISegment

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

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

Parameters
Name Description
message ISegment

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

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

Segment

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Segment

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Segment

Segment

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