Google Analytics Admin V1alpha Client - Class EventMapping (0.20.0)

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

Event setting conditions to match an event.

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ event_name
string

Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.

↳ min_event_count
int|string

At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.

↳ max_event_count
int|string

The maximum number of times the event occurred. If not set, maximum event count won't be checked.

↳ min_event_value
float

The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.

↳ max_event_value
float

The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.

getEventName

Required. Name of the GA4 event. It must always be set.

The max allowed display name length is 40 UTF-16 code units.

Returns
Type
Description
string

setEventName

Required. Name of the GA4 event. It must always be set.

The max allowed display name length is 40 UTF-16 code units.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMinEventCount

At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event.

The minimum number of times the event occurred. If not set, minimum event count won't be checked.

Returns
Type
Description
int|string

hasMinEventCount

clearMinEventCount

setMinEventCount

At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event.

The minimum number of times the event occurred. If not set, minimum event count won't be checked.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getMaxEventCount

The maximum number of times the event occurred. If not set, maximum event count won't be checked.

Returns
Type
Description
int|string

hasMaxEventCount

clearMaxEventCount

setMaxEventCount

The maximum number of times the event occurred. If not set, maximum event count won't be checked.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getMinEventValue

The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.

Returns
Type
Description
float

hasMinEventValue

clearMinEventValue

setMinEventValue

The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getMaxEventValue

The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.

Returns
Type
Description
float

hasMaxEventValue

clearMaxEventValue

setMaxEventValue

The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.

Parameter
Name
Description
var
float
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: