Google Analytics Admin V1alpha Client - Class SubpropertySyncConfig (0.29.0)

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 message google.analytics.admin.v1alpha.SubpropertySyncConfig

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
`↳ apply_to_property`	`string` 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.

getName

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

Returns
Type	Description
`string`

setName

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getApplyToProperty

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

Returns
Type	Description
`string`

setApplyToProperty