Segment

google.analytics.data.v1alpha. Segment

Represents a Segment.

Constructor

new Segment(propertiesopt)

Constructs a new Segment.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.ISegment <optional>

Properties to set

Implements:
  • ISegment

Members

eventSegment

Segment eventSegment.

name

Segment name.

oneSegmentScope

Segment oneSegmentScope.

sessionSegment

Segment sessionSegment.

userSegment

Segment userSegment.

Methods

(static) create(propertiesopt) → {google.analytics.data.v1alpha.Segment}

Creates a new Segment instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.ISegment <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.Segment

Segment instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.Segment}

Decodes a Segment message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.data.v1alpha.Segment

Segment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.data.v1alpha.Segment}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.data.v1alpha.Segment

Segment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Segment message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ISegment

Segment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ISegment

Segment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.data.v1alpha.Segment}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.data.v1alpha.Segment

Segment

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.Segment

Segment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Segment message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Segment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object