Method: properties.provisionSubproperty

  • Provision a new subproperty and an optional subproperty event filter within a Google Analytics property using the properties.provisionSubproperty method.

  • The request body requires a subproperty object and optionally includes a subpropertyEventFilter for defining event filtering criteria.

  • A successful response returns the created subproperty and the subpropertyEventFilter if provided.

  • This operation requires the https://www.googleapis.com/auth/analytics.edit OAuth scope for authorization.

Create a subproperty and a subproperty event filter that applies to the created subproperty.

HTTP request

POST https://analyticsadmin.googleapis.com/v1alpha/properties:provisionSubproperty

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "subproperty": {
    object (Property)
  },
  "subpropertyEventFilter": {
    object (SubpropertyEventFilter)
  },
  "customDimensionAndMetricSynchronizationMode": enum (SynchronizationMode)
}
Fields
subproperty

object (Property)

Required. The subproperty to create.
subpropertyEventFilter

object (SubpropertyEventFilter)

Optional. The subproperty event filter to create on an ordinary property.
customDimensionAndMetricSynchronizationMode

enum (SynchronizationMode)

Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics

Response body

Response message for properties.provisionSubproperty RPC.

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

JSON representation 
{
  "subproperty": {
    object (Property)
  },
  "subpropertyEventFilter": {
    object (SubpropertyEventFilter)
  }
}
Fields
subproperty

object (Property)

The created subproperty.
subpropertyEventFilter

object (SubpropertyEventFilter)

The created subproperty event filter.

Authorization scopes

Requires the following OAuth scope:

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