Class UserSegment (0.24.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
TypeDescription
int

USER_INCLUSION_CRITERIA_FIELD_NUMBER

public static final int USER_INCLUSION_CRITERIA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UserSegment getDefaultInstance()
Returns
TypeDescription
UserSegment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UserSegment.Builder newBuilder()
Returns
TypeDescription
UserSegment.Builder

newBuilder(UserSegment prototype)

public static UserSegment.Builder newBuilder(UserSegment prototype)
Parameter
NameDescription
prototypeUserSegment
Returns
TypeDescription
UserSegment.Builder

parseDelimitedFrom(InputStream input)

public static UserSegment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UserSegment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserSegment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserSegment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UserSegment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UserSegment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserSegment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSegment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UserSegment> parser()
Returns
TypeDescription
Parser<UserSegment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UserSegment getDefaultInstanceForType()
Returns
TypeDescription
UserSegment

getExclusion()

public UserSegmentExclusion getExclusion()

Defines which users are excluded in this segment. Optional.

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

Returns
TypeDescription
UserSegmentExclusion

The exclusion.

getExclusionOrBuilder()

public UserSegmentExclusionOrBuilder getExclusionOrBuilder()

Defines which users are excluded in this segment. Optional.

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

Returns
TypeDescription
UserSegmentExclusionOrBuilder

getParserForType()

public Parser<UserSegment> getParserForType()
Returns
TypeDescription
Parser<UserSegment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUserInclusionCriteria()

public UserSegmentCriteria getUserInclusionCriteria()

Defines which users are included in this segment. Optional.

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

Returns
TypeDescription
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
TypeDescription
UserSegmentCriteriaOrBuilder

hasExclusion()

public boolean hasExclusion()

Defines which users are excluded in this segment. Optional.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the userInclusionCriteria field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UserSegment.Builder newBuilderForType()
Returns
TypeDescription
UserSegment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserSegment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UserSegment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UserSegment.Builder toBuilder()
Returns
TypeDescription
UserSegment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException