Google Analytics Admin V1alpha Client - Class AudienceEventFilter (0.20.0)

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

A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ event_name string

Required. Immutable. The name of the event to match against.

↳ event_parameter_filter_expression Google\Analytics\Admin\V1alpha\AudienceFilterExpression

Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.

getEventName

Required. Immutable. The name of the event to match against.

Returns
TypeDescription
string

setEventName

Required. Immutable. The name of the event to match against.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEventParameterFilterExpression

Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\AudienceFilterExpression|null

hasEventParameterFilterExpression

clearEventParameterFilterExpression

setEventParameterFilterExpression

Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\AudienceFilterExpression
Returns
TypeDescription
$this