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 (for example "1. Segment", "2. Segment", etc.).
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 (for example "1. Segment", "2. Segment", etc.).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Interface SegmentOrBuilder (0.83.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.83.0 (latest)](/java/docs/reference/google-analytics-data/latest/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.81.0](/java/docs/reference/google-analytics-data/0.81.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.79.0](/java/docs/reference/google-analytics-data/0.79.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.78.0](/java/docs/reference/google-analytics-data/0.78.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.75.0](/java/docs/reference/google-analytics-data/0.75.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.74.0](/java/docs/reference/google-analytics-data/0.74.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.73.0](/java/docs/reference/google-analytics-data/0.73.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.71.0](/java/docs/reference/google-analytics-data/0.71.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.70.0](/java/docs/reference/google-analytics-data/0.70.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.69.0](/java/docs/reference/google-analytics-data/0.69.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.68.0](/java/docs/reference/google-analytics-data/0.68.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.67.0](/java/docs/reference/google-analytics-data/0.67.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.66.0](/java/docs/reference/google-analytics-data/0.66.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.65.0](/java/docs/reference/google-analytics-data/0.65.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.64.0](/java/docs/reference/google-analytics-data/0.64.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.63.0](/java/docs/reference/google-analytics-data/0.63.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.62.0](/java/docs/reference/google-analytics-data/0.62.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.60.0](/java/docs/reference/google-analytics-data/0.60.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.59.0](/java/docs/reference/google-analytics-data/0.59.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.58.0](/java/docs/reference/google-analytics-data/0.58.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.57.0](/java/docs/reference/google-analytics-data/0.57.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.56.0](/java/docs/reference/google-analytics-data/0.56.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.55.0](/java/docs/reference/google-analytics-data/0.55.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.54.0](/java/docs/reference/google-analytics-data/0.54.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.53.0](/java/docs/reference/google-analytics-data/0.53.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.52.0](/java/docs/reference/google-analytics-data/0.52.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.51.0](/java/docs/reference/google-analytics-data/0.51.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.50.0](/java/docs/reference/google-analytics-data/0.50.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.48.0](/java/docs/reference/google-analytics-data/0.48.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.47.0](/java/docs/reference/google-analytics-data/0.47.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.46.0](/java/docs/reference/google-analytics-data/0.46.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.45.0](/java/docs/reference/google-analytics-data/0.45.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.44.0](/java/docs/reference/google-analytics-data/0.44.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.43.0](/java/docs/reference/google-analytics-data/0.43.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.42.0](/java/docs/reference/google-analytics-data/0.42.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.41.0](/java/docs/reference/google-analytics-data/0.41.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.40.0](/java/docs/reference/google-analytics-data/0.40.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.39.0](/java/docs/reference/google-analytics-data/0.39.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.38.0](/java/docs/reference/google-analytics-data/0.38.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.35.0](/java/docs/reference/google-analytics-data/0.35.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.34.0](/java/docs/reference/google-analytics-data/0.34.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.33.0](/java/docs/reference/google-analytics-data/0.33.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.32.0](/java/docs/reference/google-analytics-data/0.32.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.31.0](/java/docs/reference/google-analytics-data/0.31.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.30.0](/java/docs/reference/google-analytics-data/0.30.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.29.0](/java/docs/reference/google-analytics-data/0.29.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.28.0](/java/docs/reference/google-analytics-data/0.28.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.27.0](/java/docs/reference/google-analytics-data/0.27.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.26.0](/java/docs/reference/google-analytics-data/0.26.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.25.0](/java/docs/reference/google-analytics-data/0.25.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.24.0](/java/docs/reference/google-analytics-data/0.24.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.23.0](/java/docs/reference/google-analytics-data/0.23.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.22.0](/java/docs/reference/google-analytics-data/0.22.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.21.0](/java/docs/reference/google-analytics-data/0.21.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.20.0](/java/docs/reference/google-analytics-data/0.20.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.19.0](/java/docs/reference/google-analytics-data/0.19.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.18.0](/java/docs/reference/google-analytics-data/0.18.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.17.0](/java/docs/reference/google-analytics-data/0.17.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.16.0](/java/docs/reference/google-analytics-data/0.16.0/com.google.analytics.data.v1alpha.SegmentOrBuilder)\n- [0.15.0](/java/docs/reference/google-analytics-data/0.15.0/com.google.analytics.data.v1alpha.SegmentOrBuilder) \n\n public interface SegmentOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getEventSegment()\n\n public abstract EventSegment getEventSegment()\n\nEvent segments are subsets of events that were triggered on your site or\napp.\n\n`.google.analytics.data.v1alpha.EventSegment event_segment = 4;`\n\n### getEventSegmentOrBuilder()\n\n public abstract EventSegmentOrBuilder getEventSegmentOrBuilder()\n\nEvent segments are subsets of events that were triggered on your site or\napp.\n\n`.google.analytics.data.v1alpha.EventSegment event_segment = 4;`\n\n### getName()\n\n public abstract String getName()\n\nThe name for this segment. If unspecified, segments are named \"Segment\".\nThis name defines string value returned by the `segment` dimension. The\n`segment` dimension prefixes segment names by the 1-based index number of\nthe segment in the request (for example \"1. Segment\", \"2. Segment\", etc.).\n\n`string name = 1;`\n\n### getNameBytes()\n\n public abstract ByteString getNameBytes()\n\nThe name for this segment. If unspecified, segments are named \"Segment\".\nThis name defines string value returned by the `segment` dimension. The\n`segment` dimension prefixes segment names by the 1-based index number of\nthe segment in the request (for example \"1. Segment\", \"2. Segment\", etc.).\n\n`string name = 1;`\n\n### getOneSegmentScopeCase()\n\n public abstract Segment.OneSegmentScopeCase getOneSegmentScopeCase()\n\n### getSessionSegment()\n\n public abstract SessionSegment getSessionSegment()\n\nSession segments are subsets of the sessions that occurred on your site\nor app.\n\n`.google.analytics.data.v1alpha.SessionSegment session_segment = 3;`\n\n### getSessionSegmentOrBuilder()\n\n public abstract SessionSegmentOrBuilder getSessionSegmentOrBuilder()\n\nSession segments are subsets of the sessions that occurred on your site\nor app.\n\n`.google.analytics.data.v1alpha.SessionSegment session_segment = 3;`\n\n### getUserSegment()\n\n public abstract UserSegment getUserSegment()\n\nUser segments are subsets of users who engaged with your site or app.\n\n`.google.analytics.data.v1alpha.UserSegment user_segment = 2;`\n\n### getUserSegmentOrBuilder()\n\n public abstract UserSegmentOrBuilder getUserSegmentOrBuilder()\n\nUser segments are subsets of users who engaged with your site or app.\n\n`.google.analytics.data.v1alpha.UserSegment user_segment = 2;`\n\n### hasEventSegment()\n\n public abstract boolean hasEventSegment()\n\nEvent segments are subsets of events that were triggered on your site or\napp.\n\n`.google.analytics.data.v1alpha.EventSegment event_segment = 4;`\n\n### hasSessionSegment()\n\n public abstract boolean hasSessionSegment()\n\nSession segments are subsets of the sessions that occurred on your site\nor app.\n\n`.google.analytics.data.v1alpha.SessionSegment session_segment = 3;`\n\n### hasUserSegment()\n\n public abstract boolean hasUserSegment()\n\nUser segments are subsets of users who engaged with your site or app.\n\n`.google.analytics.data.v1alpha.UserSegment user_segment = 2;`"]]
