Reference documentation and code samples for the Google Analytics Data V1alpha Client class Segment.
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 Segment
Builder.
Generated from protobuf message google.analytics.data.v1alpha.Segment
Namespace
Google \ Analytics \ Data \ V1alpha
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
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.).
Event segments are subsets of events that were triggered on your site or app.
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 (for example "1. Segment", "2. Segment", etc.).
Returns
Type
Description
string
setName
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.).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUserSegment
User segments are subsets of users who engaged with your site or app.
[[["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-09-04 UTC."],[],[],null,["# Google Analytics Data V1alpha Client - Class Segment (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.Segment)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.Segment)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.Segment)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.Segment)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.Segment)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.Segment)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.Segment)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.Segment)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.Segment)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.Segment)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.Segment)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.Segment)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.Segment)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.Segment) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1alpha Client class Segment.\n\nA segment is a subset of your Analytics data. For example, of your entire set\nof users, one segment might be users from a particular country or city.\n\nAnother segment might be users who purchase a particular line of products or\nwho visit a specific part of your site or trigger certain events in your app.\nTo learn more, see [Segment\nBuilder](https://support.google.com/analytics/answer/9304353).\n\nGenerated from protobuf message `google.analytics.data.v1alpha.Segment`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name for this segment. If unspecified, segments are named \"Segment\".\n\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### setName\n\nThe name for this segment. If unspecified, segments are named \"Segment\".\n\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### getUserSegment\n\nUser segments are subsets of users who engaged with your site or app.\n\n### hasUserSegment\n\n### setUserSegment\n\nUser segments are subsets of users who engaged with your site or app.\n\n### getSessionSegment\n\nSession segments are subsets of the sessions that occurred on your site\nor app.\n\n### hasSessionSegment\n\n### setSessionSegment\n\nSession segments are subsets of the sessions that occurred on your site\nor app.\n\n### getEventSegment\n\nEvent segments are subsets of events that were triggered on your site or\napp.\n\n### hasEventSegment\n\n### setEventSegment\n\nEvent segments are subsets of events that were triggered on your site or\napp.\n\n### getOneSegmentScope"]]
