Google Analytics Data V1alpha Client - Class UserSegmentExclusion (0.20.0)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class UserSegmentExclusion.

Specifies which users are excluded in this segment.

Generated from protobuf message google.analytics.data.v1alpha.UserSegmentExclusion

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ user_exclusion_duration int

Specifies how long an exclusion will last if a user matches the userExclusionCriteria. Optional. If unspecified, userExclusionDuration of USER_EXCLUSION_TEMPORARY is used.

↳ user_exclusion_criteria Google\Analytics\Data\V1alpha\UserSegmentCriteria

If a user meets this condition, the user is excluded from membership in the segment for the userExclusionDuration.

getUserExclusionDuration

Specifies how long an exclusion will last if a user matches the userExclusionCriteria.

Optional. If unspecified, userExclusionDuration of USER_EXCLUSION_TEMPORARY is used.

Returns
Type Description
int

setUserExclusionDuration

Specifies how long an exclusion will last if a user matches the userExclusionCriteria.

Optional. If unspecified, userExclusionDuration of USER_EXCLUSION_TEMPORARY is used.

Parameter
Name Description
var int
Returns
Type Description
$this

getUserExclusionCriteria

If a user meets this condition, the user is excluded from membership in the segment for the userExclusionDuration.

Returns
Type Description
Google\Analytics\Data\V1alpha\UserSegmentCriteria|null

hasUserExclusionCriteria

clearUserExclusionCriteria

setUserExclusionCriteria

If a user meets this condition, the user is excluded from membership in the segment for the userExclusionDuration.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\UserSegmentCriteria
Returns
Type Description
$this