Method: properties.dataStreams.updateDataRedactionSettings

  • This document details how to update DataRedactionSettings on a property using a PATCH request to a specified URL.

  • The request requires a path parameter for the dataRedactionSettings.name and a required query parameter updateMask to specify which fields to update.

  • The request body should contain an instance of DataRedactionSettings, and a successful response will also contain an instance of DataRedactionSettings.

  • The operation requires authorization with the https://www.googleapis.com/auth/analytics.edit OAuth scope.

Updates a DataRedactionSettings on a property.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataRedactionSettings.name

string

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{dataStream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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 DataRedactionSettings.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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