google.analytics.data.v1alpha.Segment
*/
class Segment extends \Google\Protobuf\Internal\Message
{
/**
* 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.).
*
* Generated from protobuf field string name = 1;
*/
private $name = '';
protected $one_segment_scope;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $name
* 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.).
* @type \Google\Analytics\Data\V1alpha\UserSegment $user_segment
* User segments are subsets of users who engaged with your site or app.
* @type \Google\Analytics\Data\V1alpha\SessionSegment $session_segment
* Session segments are subsets of the sessions that occurred on your site
* or app.
* @type \Google\Analytics\Data\V1alpha\EventSegment $event_segment
* Event segments are subsets of events that were triggered on your site or
* app.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
parent::__construct($data);
}
/**
* 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.).
*
* Generated from protobuf field string name = 1;
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* 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.).
*
* Generated from protobuf field string name = 1;
* @param string $var
* @return $this
*/
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
}
/**
* User segments are subsets of users who engaged with your site or app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.UserSegment user_segment = 2;
* @return \Google\Analytics\Data\V1alpha\UserSegment|null
*/
public function getUserSegment()
{
return $this->readOneof(2);
}
public function hasUserSegment()
{
return $this->hasOneof(2);
}
/**
* User segments are subsets of users who engaged with your site or app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.UserSegment user_segment = 2;
* @param \Google\Analytics\Data\V1alpha\UserSegment $var
* @return $this
*/
public function setUserSegment($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\UserSegment::class);
$this->writeOneof(2, $var);
return $this;
}
/**
* Session segments are subsets of the sessions that occurred on your site
* or app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.SessionSegment session_segment = 3;
* @return \Google\Analytics\Data\V1alpha\SessionSegment|null
*/
public function getSessionSegment()
{
return $this->readOneof(3);
}
public function hasSessionSegment()
{
return $this->hasOneof(3);
}
/**
* Session segments are subsets of the sessions that occurred on your site
* or app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.SessionSegment session_segment = 3;
* @param \Google\Analytics\Data\V1alpha\SessionSegment $var
* @return $this
*/
public function setSessionSegment($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\SessionSegment::class);
$this->writeOneof(3, $var);
return $this;
}
/**
* Event segments are subsets of events that were triggered on your site or
* app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.EventSegment event_segment = 4;
* @return \Google\Analytics\Data\V1alpha\EventSegment|null
*/
public function getEventSegment()
{
return $this->readOneof(4);
}
public function hasEventSegment()
{
return $this->hasOneof(4);
}
/**
* Event segments are subsets of events that were triggered on your site or
* app.
*
* Generated from protobuf field .google.analytics.data.v1alpha.EventSegment event_segment = 4;
* @param \Google\Analytics\Data\V1alpha\EventSegment $var
* @return $this
*/
public function setEventSegment($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\EventSegment::class);
$this->writeOneof(4, $var);
return $this;
}
/**
* @return string
*/
public function getOneSegmentScope()
{
return $this->whichOneof("one_segment_scope");
}
}