Method: properties.subpropertyEventFilters.list

  • This page describes how to list all subproperty event filters on a property using a GET HTTP request.

  • The request requires a parent path parameter specifying the resource name of the ordinary property.

  • Optional query parameters include pageSize to control the number of results and pageToken for pagination.

  • The request body must be empty.

  • The response body contains a list of subproperty event filters and an optional nextPageToken for pagination.

  • The request requires specific OAuth authorization scopes.

List all subproperty Event Filters on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/subpropertyEventFilters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123

Query parameters

Parameters
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 subpropertyEventFilters.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to subpropertyEventFilters.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for ListSubpropertyEventFilter RPC.

If successful, the response body contains data with the following structure:

JSON representation
{
  "subpropertyEventFilters": [
    {
      object (SubpropertyEventFilter)
    }
  ],
  "nextPageToken": string
}
Fields
subpropertyEventFilters[]

object (SubpropertyEventFilter)

List of subproperty event filters.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit