Reference documentation and code samples for the Google Analytics Admin V1alpha Client class SubpropertySyncConfig.
Subproperty synchronization configuration controls how ordinary property
configurations are synchronized to subproperties. This resource is
provisioned automatically for each subproperty.
Generated from protobuf messagegoogle.analytics.admin.v1alpha.SubpropertySyncConfig
Output only. Immutable. Resource name of the Subproperty that these settings apply to.
↳ custom_dimension_and_metric_sync_mode
int
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.
Output only. Immutable. Resource name of the Subproperty that these
settings apply to.
Returns
Type
Description
string
setApplyToProperty
Output only. Immutable. Resource name of the Subproperty that these
settings apply to.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCustomDimensionAndMetricSyncMode
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.
Returns
Type
Description
int
setCustomDimensionAndMetricSyncMode
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Admin V1alpha Client - Class SubpropertySyncConfig (0.29.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.29.1 (latest)](/php/docs/reference/analytics-admin/latest/V1alpha.SubpropertySyncConfig)\n- [0.29.0](/php/docs/reference/analytics-admin/0.29.0/V1alpha.SubpropertySyncConfig)\n- [0.28.1](/php/docs/reference/analytics-admin/0.28.1/V1alpha.SubpropertySyncConfig)\n- [0.27.0](/php/docs/reference/analytics-admin/0.27.0/V1alpha.SubpropertySyncConfig)\n- [0.26.0](/php/docs/reference/analytics-admin/0.26.0/V1alpha.SubpropertySyncConfig)\n- [0.25.2](/php/docs/reference/analytics-admin/0.25.2/V1alpha.SubpropertySyncConfig)\n- [0.24.2](/php/docs/reference/analytics-admin/0.24.2/V1alpha.SubpropertySyncConfig)\n- [0.23.0](/php/docs/reference/analytics-admin/0.23.0/V1alpha.SubpropertySyncConfig)\n- [0.22.5](/php/docs/reference/analytics-admin/0.22.5/V1alpha.SubpropertySyncConfig)\n- [0.20.0](/php/docs/reference/analytics-admin/0.20.0/V1alpha.SubpropertySyncConfig)\n- [0.19.0](/php/docs/reference/analytics-admin/0.19.0/V1alpha.SubpropertySyncConfig)\n- [0.18.1](/php/docs/reference/analytics-admin/0.18.1/V1alpha.SubpropertySyncConfig)\n- [0.17.0](/php/docs/reference/analytics-admin/0.17.0/V1alpha.SubpropertySyncConfig)\n- [0.16.0](/php/docs/reference/analytics-admin/0.16.0/V1alpha.SubpropertySyncConfig)\n- [0.15.1](/php/docs/reference/analytics-admin/0.15.1/V1alpha.SubpropertySyncConfig)\n- [0.14.0](/php/docs/reference/analytics-admin/0.14.0/V1alpha.SubpropertySyncConfig)\n- [0.13.0](/php/docs/reference/analytics-admin/0.13.0/V1alpha.SubpropertySyncConfig)\n- [0.12.0](/php/docs/reference/analytics-admin/0.12.0/V1alpha.SubpropertySyncConfig)\n- [0.11.1](/php/docs/reference/analytics-admin/0.11.1/V1alpha.SubpropertySyncConfig)\n- [0.10.0](/php/docs/reference/analytics-admin/0.10.0/V1alpha.SubpropertySyncConfig)\n- [0.9.0](/php/docs/reference/analytics-admin/0.9.0/V1alpha.SubpropertySyncConfig)\n- [0.8.2](/php/docs/reference/analytics-admin/0.8.2/V1alpha.SubpropertySyncConfig) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Admin V1alpha Client class SubpropertySyncConfig.\n\nSubproperty synchronization configuration controls how ordinary property\nconfigurations are synchronized to subproperties. This resource is\nprovisioned automatically for each subproperty.\n\nGenerated from protobuf message `google.analytics.admin.v1alpha.SubpropertySyncConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Admin \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Identifier. Format:\nproperties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id}\nExample: properties/1234/subpropertySyncConfigs/5678\n\n### setName\n\nOutput only. Identifier. Format:\nproperties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id}\nExample: properties/1234/subpropertySyncConfigs/5678\n\n### getApplyToProperty\n\nOutput only. Immutable. Resource name of the Subproperty that these\nsettings apply to.\n\n### setApplyToProperty\n\nOutput only. Immutable. Resource name of the Subproperty that these\nsettings apply to.\n\n### getCustomDimensionAndMetricSyncMode\n\nRequired. Specifies the Custom Dimension / Metric synchronization mode for\nthe Subproperty.\n\nIf set to ALL, Custom Dimension / Metric synchronization will be\nimmediately enabled. Local configuration of Custom Dimensions / Metrics\nwill not be allowed on the Subproperty so long as the synchronization mode\nis set to ALL.\nIf set to NONE, Custom Dimensions / Metric synchronization is disabled.\nCustom Dimensions / Metrics must be configured explicitly on the\nSubproperty.\n\n### setCustomDimensionAndMetricSyncMode\n\nRequired. Specifies the Custom Dimension / Metric synchronization mode for\nthe Subproperty.\n\nIf set to ALL, Custom Dimension / Metric synchronization will be\nimmediately enabled. Local configuration of Custom Dimensions / Metrics\nwill not be allowed on the Subproperty so long as the synchronization mode\nis set to ALL.\nIf set to NONE, Custom Dimensions / Metric synchronization is disabled.\nCustom Dimensions / Metrics must be configured explicitly on the\nSubproperty."]]
