com.google.analytics.data.v1alpha

Class Segment

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.Segment

All Implemented Interfaces:

SegmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Segment
extends com.google.protobuf.GeneratedMessageV3
implements SegmentOrBuilder

 A segment is a subset of your Analytics data. For example, of your entire set
 of users, one segment might be users from a particular country or city.
 Another segment might be users who purchase a particular line of products or
 who visit a specific part of your site or trigger certain events in your app.
 To learn more, see [GA4 Segment
 Builder](https://support.google.com/analytics/answer/9304353).
 

Protobuf type google.analytics.data.v1alpha.Segment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Segment.Builder A segment is a subset of your Analytics data.
static class	Segment.OneSegmentScopeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_SEGMENT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SESSION_SEGMENT_FIELD_NUMBER
static int	USER_SEGMENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Segment	getDefaultInstance()
Segment	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
EventSegment	getEventSegment() Event segments are subsets of events that were triggered on your site or app.
EventSegmentOrBuilder	getEventSegmentOrBuilder() Event segments are subsets of events that were triggered on your site or app.
String	getName() The name for this segment.
com.google.protobuf.ByteString	getNameBytes() The name for this segment.
Segment.OneSegmentScopeCase	getOneSegmentScopeCase()
com.google.protobuf.Parser<Segment>	getParserForType()
int	getSerializedSize()
SessionSegment	getSessionSegment() Session segments are subsets of the sessions that occurred on your site or app.
SessionSegmentOrBuilder	getSessionSegmentOrBuilder() Session segments are subsets of the sessions that occurred on your site or app.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
UserSegment	getUserSegment() User segments are subsets of users who engaged with your site or app.
UserSegmentOrBuilder	getUserSegmentOrBuilder() User segments are subsets of users who engaged with your site or app.
boolean	hasEventSegment() Event segments are subsets of events that were triggered on your site or app.
int	hashCode()
boolean	hasSessionSegment() Session segments are subsets of the sessions that occurred on your site or app.
boolean	hasUserSegment() User segments are subsets of users who engaged with your site or app.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Segment.Builder	newBuilder()
static Segment.Builder	newBuilder(Segment prototype)
Segment.Builder	newBuilderForType()
protected Segment.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Segment	parseDelimitedFrom(InputStream input)
static Segment	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Segment	parseFrom(byte[] data)
static Segment	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Segment	parseFrom(ByteBuffer data)
static Segment	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Segment	parseFrom(com.google.protobuf.ByteString data)
static Segment	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Segment	parseFrom(com.google.protobuf.CodedInputStream input)
static Segment	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Segment	parseFrom(InputStream input)
static Segment	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Segment>	parser()
Segment.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

USER_SEGMENT_FIELD_NUMBER

public static final int USER_SEGMENT_FIELD_NUMBER

See Also:

Constant Field Values

SESSION_SEGMENT_FIELD_NUMBER

public static final int SESSION_SEGMENT_FIELD_NUMBER

See Also:

Constant Field Values

EVENT_SEGMENT_FIELD_NUMBER

public static final int EVENT_SEGMENT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getOneSegmentScopeCase

public Segment.OneSegmentScopeCase getOneSegmentScopeCase()

Specified by:

getOneSegmentScopeCase in interface SegmentOrBuilder

getName

public String getName()

 The name for this segment. If unspecified, segments are named "Segment".
 This name defines string value returned by the `segment` dimension. The
 `segment` dimension prefixes segment names by the 1-based index number of
 the segment in the request (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Specified by:

getName in interface SegmentOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name for this segment. If unspecified, segments are named "Segment".
 This name defines string value returned by the `segment` dimension. The
 `segment` dimension prefixes segment names by the 1-based index number of
 the segment in the request (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Specified by:

getNameBytes in interface SegmentOrBuilder

Returns:

The bytes for name.

hasUserSegment

public boolean hasUserSegment()

 User segments are subsets of users who engaged with your site or app.
 

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Specified by:

hasUserSegment in interface SegmentOrBuilder

Returns:

Whether the userSegment field is set.

getUserSegment

public UserSegment getUserSegment()

 User segments are subsets of users who engaged with your site or app.
 

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Specified by:

getUserSegment in interface SegmentOrBuilder

Returns:

The userSegment.

getUserSegmentOrBuilder

public UserSegmentOrBuilder getUserSegmentOrBuilder()

 User segments are subsets of users who engaged with your site or app.
 

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Specified by:

getUserSegmentOrBuilder in interface SegmentOrBuilder

hasSessionSegment

public boolean hasSessionSegment()

 Session segments are subsets of the sessions that occurred on your site
 or app.
 

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Specified by:

hasSessionSegment in interface SegmentOrBuilder

Returns:

Whether the sessionSegment field is set.

getSessionSegment

public SessionSegment getSessionSegment()

 Session segments are subsets of the sessions that occurred on your site
 or app.
 

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Specified by:

getSessionSegment in interface SegmentOrBuilder

Returns:

The sessionSegment.

getSessionSegmentOrBuilder

public SessionSegmentOrBuilder getSessionSegmentOrBuilder()

 Session segments are subsets of the sessions that occurred on your site
 or app.
 

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Specified by:

getSessionSegmentOrBuilder in interface SegmentOrBuilder

hasEventSegment

public boolean hasEventSegment()

 Event segments are subsets of events that were triggered on your site or
 app.
 

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Specified by:

hasEventSegment in interface SegmentOrBuilder

Returns:

Whether the eventSegment field is set.

getEventSegment

public EventSegment getEventSegment()

 Event segments are subsets of events that were triggered on your site or
 app.
 

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Specified by:

getEventSegment in interface SegmentOrBuilder

Returns:

The eventSegment.

getEventSegmentOrBuilder

public EventSegmentOrBuilder getEventSegmentOrBuilder()

 Event segments are subsets of events that were triggered on your site or
 app.
 

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Specified by:

getEventSegmentOrBuilder in interface SegmentOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Segment parseFrom(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Segment parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Segment parseFrom(InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Segment parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Segment parseDelimitedFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static Segment parseFrom(com.google.protobuf.CodedInputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Segment parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

newBuilderForType

public Segment.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Segment.Builder newBuilder()

newBuilder

public static Segment.Builder newBuilder(Segment prototype)

toBuilder

public Segment.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Segment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Segment getDefaultInstance()

parser

public static com.google.protobuf.Parser<Segment> parser()

getParserForType

public com.google.protobuf.Parser<Segment> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Segment getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder