Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
REST Resource: properties.subpropertySyncConfigs
Stay organized with collections
Save and categorize content based on your preferences.
Resource: SubpropertySyncConfig
Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
JSON representation |
{
"name": string,
"applyToProperty": string,
"customDimensionAndMetricSyncMode": enum (SynchronizationMode )
} |
Fields |
name |
string
Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
|
applyToProperty |
string
Output only. Immutable. Resource name of the subproperty that these settings apply to.
|
customDimensionAndMetricSyncMode |
enum (SynchronizationMode )
Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
|
SynchronizationMode
Synchronization modes for a subproperty
Enums |
SYNCHRONIZATION_MODE_UNSPECIFIED |
Synchronization mode unknown or not specified. |
NONE |
Entities are not synchronized. Local edits are allowed on the subproperty. |
ALL |
Entities are synchronized from parent property. Local mutations are not allowed on the subproperty (Create / Update / Delete) |
Methods |
|
Lookup for a single SubpropertySyncConfig . |
|
List all SubpropertySyncConfig resources for a property. |
|
Updates a SubpropertySyncConfig . |
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."],[],[],null,["# REST Resource: properties.subpropertySyncConfigs\n\n- [Resource: SubpropertySyncConfig](#SubpropertySyncConfig)\n - [JSON representation](#SubpropertySyncConfig.SCHEMA_REPRESENTATION)\n- [SynchronizationMode](#SynchronizationMode)\n- [Methods](#METHODS_SUMMARY)\n\nResource: SubpropertySyncConfig\n-------------------------------\n\nSubproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"applyToProperty\": string, \"customDimensionAndMetricSyncMode\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs#SynchronizationMode) } ``` |\n\n| Fields ||\n|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 |\n| `applyToProperty` | `string` Output only. Immutable. Resource name of the subproperty that these settings apply to. |\n| `customDimensionAndMetricSyncMode` | `enum (`[SynchronizationMode](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs#SynchronizationMode)`)` Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. |\n\nSynchronizationMode\n-------------------\n\nSynchronization modes for a subproperty\n\n| Enums ||\n|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `SYNCHRONIZATION_MODE_UNSPECIFIED` | Synchronization mode unknown or not specified. |\n| `NONE` | Entities are not synchronized. Local edits are allowed on the subproperty. |\n| `ALL` | Entities are synchronized from parent property. Local mutations are not allowed on the subproperty (Create / Update / Delete) |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------|\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs/get) | Lookup for a single `SubpropertySyncConfig`. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs/list) | List all `SubpropertySyncConfig` resources for a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.subpropertySyncConfigs/patch) | Updates a `SubpropertySyncConfig`. |"]]