Class UserSegment (0.53.0)

public final class UserSegment extends GeneratedMessageV3 implements UserSegmentOrBuilder

User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn’t complete a purchase.

Protobuf type google.analytics.data.v1alpha.UserSegment

Static Fields

EXCLUSION_FIELD_NUMBER

public static final int EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

USER_INCLUSION_CRITERIA_FIELD_NUMBER

public static final int USER_INCLUSION_CRITERIA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserSegment getDefaultInstance()
Returns
Type Description
UserSegment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UserSegment.Builder newBuilder()
Returns
Type Description
UserSegment.Builder

newBuilder(UserSegment prototype)

public static UserSegment.Builder newBuilder(UserSegment prototype)
Parameter
Name Description
prototype UserSegment
Returns
Type Description
UserSegment.Builder

parseDelimitedFrom(InputStream input)

public static UserSegment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UserSegment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserSegment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserSegment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UserSegment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UserSegment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSegment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UserSegment> parser()
Returns
Type Description
Parser<UserSegment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UserSegment getDefaultInstanceForType()
Returns
Type Description
UserSegment

getExclusion()

public UserSegmentExclusion getExclusion()

Defines which users are excluded in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentExclusion exclusion = 2;

Returns
Type Description
UserSegmentExclusion

The exclusion.

getExclusionOrBuilder()

public UserSegmentExclusionOrBuilder getExclusionOrBuilder()

Defines which users are excluded in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentExclusion exclusion = 2;

Returns
Type Description
UserSegmentExclusionOrBuilder

getParserForType()

public Parser<UserSegment> getParserForType()
Returns
Type Description
Parser<UserSegment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserInclusionCriteria()

public UserSegmentCriteria getUserInclusionCriteria()

Defines which users are included in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentCriteria user_inclusion_criteria = 1;

Returns
Type Description
UserSegmentCriteria

The userInclusionCriteria.

getUserInclusionCriteriaOrBuilder()

public UserSegmentCriteriaOrBuilder getUserInclusionCriteriaOrBuilder()

Defines which users are included in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentCriteria user_inclusion_criteria = 1;

Returns
Type Description
UserSegmentCriteriaOrBuilder

hasExclusion()

public boolean hasExclusion()

Defines which users are excluded in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentExclusion exclusion = 2;

Returns
Type Description
boolean

Whether the exclusion field is set.

hasUserInclusionCriteria()

public boolean hasUserInclusionCriteria()

Defines which users are included in this segment. Optional.

.google.analytics.data.v1alpha.UserSegmentCriteria user_inclusion_criteria = 1;

Returns
Type Description
boolean

Whether the userInclusionCriteria field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UserSegment.Builder newBuilderForType()
Returns
Type Description
UserSegment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserSegment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UserSegment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UserSegment.Builder toBuilder()
Returns
Type Description
UserSegment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException