Method: properties.provisionSubproperty

  • The provisionSubproperty method is used to create a subproperty and an optional subproperty event filter.

  • This method uses a POST request to the specified analyticsadmin API endpoint.

  • The request body requires subproperty and optionally includes subpropertyEventFilter and customDimensionAndMetricSynchronizationMode.

  • The response body contains the created subproperty and optionally the created subpropertyEventFilter.

  • 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