Google Analytics Admin V1alpha Client - Class MatchingCondition (0.17.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class MatchingCondition.

Defines a condition for when an Event Edit or Event Creation rule applies to an event.

Generated from protobuf message google.analytics.admin.v1alpha.MatchingCondition

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field string

Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.

↳ comparison_type int

Required. The type of comparison to be applied to the value.

↳ value string

Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.

↳ negated bool

Whether or not the result of the comparison should be negated. For example, if negated is true, then 'equals' comparisons would function as 'not equals'.

getField

Required. The name of the field that is compared against for the condition.

If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.

Returns
TypeDescription
string

setField

Required. The name of the field that is compared against for the condition.

If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getComparisonType

Required. The type of comparison to be applied to the value.

Returns
TypeDescription
int

setComparisonType

Required. The type of comparison to be applied to the value.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getValue

Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.

Returns
TypeDescription
string

setValue

Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNegated

Whether or not the result of the comparison should be negated. For example, if negated is true, then 'equals' comparisons would function as 'not equals'.

Returns
TypeDescription
bool

setNegated

Whether or not the result of the comparison should be negated. For example, if negated is true, then 'equals' comparisons would function as 'not equals'.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this