Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a subproperty Event Filter.
Deletes a subproperty event filter.
Lookup for a single subproperty Event Filter.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all subproperty Event Filters on a property.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a subproperty Event Filter.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a subproperty Event Filter.
Args:
parent: string, Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123 (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
}
delete(name, x__xgafv=None)
Deletes a subproperty event filter.
Args:
name: string, Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Lookup for a single subproperty Event Filter.
Args:
name: string, Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all subproperty Event Filters on a property.
Args:
parent: string, Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123 (required)
pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListSubpropertyEventFilter RPC.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"subpropertyEventFilters": [ # List of subproperty event filters.
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a subproperty Event Filter.
Args:
name: string, Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678 (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
}
updateMask: string, Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 Subproperty event filter.
"applyToProperty": "A String", # Immutable. Resource name of the Subproperty that uses this filter.
"filterClauses": [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.
{ # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
"filterClauseType": "A String", # Required. The type for the filter clause.
"filterExpression": { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
"filterCondition": { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
"fieldName": "A String", # Required. The field that is being filtered.
"nullFilter": True or False, # A filter for null values.
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value used for the matching.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
"orGroup": { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
"filterExpressions": [ # Required. Unordered list. A list of Subproperty event filter expressions
# Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
],
},
},
},
],
"name": "A String", # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
}