REST Resource: properties.subpropertySyncConfigs

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

get

Lookup for a single SubpropertySyncConfig.

list

List all SubpropertySyncConfig resources for a property.

patch

Updates a SubpropertySyncConfig.