Google Analytics Admin V1alpha Client - Class SubpropertyEventFilter (0.20.0)

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

A resource message representing a GA4 Subproperty event filter.

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678

↳ apply_to_property string

Immutable. Resource name of the Subproperty that uses this filter.

↳ filter_clauses array<Google\Analytics\Admin\V1alpha\SubpropertyEventFilterClause>

Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.

getName

Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678

Returns
TypeDescription
string

setName

Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getApplyToProperty

Immutable. Resource name of the Subproperty that uses this filter.

Returns
TypeDescription
string

hasApplyToProperty

clearApplyToProperty

setApplyToProperty

Immutable. Resource name of the Subproperty that uses this filter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilterClauses

Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFilterClauses

Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.

Parameter
NameDescription
var array<Google\Analytics\Admin\V1alpha\SubpropertyEventFilterClause>
Returns
TypeDescription
$this