Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.provisionSubproperty
Stay organized with collections
Save and categorize content based on your preferences.
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:
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:
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[null,null,["Last updated 2025-06-16 UTC."],[[["\u003cp\u003eProvision a new subproperty and an optional subproperty event filter within a Google Analytics property using the \u003ccode\u003eproperties.provisionSubproperty\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003esubproperty\u003c/code\u003e object and optionally includes a \u003ccode\u003esubpropertyEventFilter\u003c/code\u003e for defining event filtering criteria.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the created \u003ccode\u003esubproperty\u003c/code\u003e and the \u003ccode\u003esubpropertyEventFilter\u003c/code\u003e if provided.\u003c/p\u003e\n"],["\u003cp\u003eThis operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This content outlines how to provision a subproperty and its event filter using an HTTP POST request. The request, sent to `https://analyticsadmin.googleapis.com/v1alpha/properties:provisionSubproperty`, requires a JSON body containing the `subproperty` object and an optional `subpropertyEventFilter` object. Upon success, the response body will include the created `subproperty` and the `subpropertyEventFilter`, as objects. Authorization using the `analytics.edit` scope is required.\n"],null,["# Method: properties.provisionSubproperty\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ProvisionSubpropertyResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreate a subproperty and a subproperty event filter that applies to the created subproperty.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/properties:provisionSubproperty`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subproperty\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property) }, \"subpropertyEventFilter\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter) }, \"customDimensionAndMetricSynchronizationMode\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs#SynchronizationMode) } ``` |\n\n| Fields ||\n|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subproperty` | `object (`[Property](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property)`)` Required. The subproperty to create. |\n| `subpropertyEventFilter` | `object (`[SubpropertyEventFilter](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter)`)` Optional. The subproperty event filter to create on an ordinary property. |\n| `customDimensionAndMetricSynchronizationMode` | `enum (`[SynchronizationMode](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs#SynchronizationMode)`)` Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics |\n\n### Response body\n\nResponse message for properties.provisionSubproperty RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subproperty\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property) }, \"subpropertyEventFilter\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter) } } ``` |\n\n| Fields ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subproperty` | `object (`[Property](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property)`)` The created subproperty. |\n| `subpropertyEventFilter` | `object (`[SubpropertyEventFilter](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertyEventFilters#SubpropertyEventFilter)`)` The created subproperty event filter. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]