Method: properties.dataStreams.updateEnhancedMeasurementSettings

  • Updates the enhanced measurement settings for a given data stream within a Google Analytics property.

  • Requires the analytics.edit OAuth scope for authorization.

  • Utilizes an HTTP PATCH request with path and query parameters to identify the data stream and specify the updated fields.

  • Includes a request body containing the desired EnhancedMeasurementSettings and responds with the updated settings on success.

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{enhancedMeasurementSettings.name=properties/*/dataStreams/*/enhancedMeasurementSettings}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
enhancedMeasurementSettings.name

string

Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{dataStream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of EnhancedMeasurementSettings.

Response body

If successful, the response body contains an instance of EnhancedMeasurementSettings.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit