Method: properties.updateGoogleSignalsSettings

  • This page provides documentation for updating Google Signals settings for a property using a PATCH request.

  • The HTTP request URL uses gRPC Transcoding syntax and includes a googleSignalsSettings.name path parameter to identify the specific settings to update.

  • A required updateMask query parameter, in FieldMask format, specifies which fields within the Google Signals settings should be updated.

  • Both the request and response bodies contain an instance of GoogleSignalsSettings.

  • Updating Google Signals settings requires the https://www.googleapis.com/auth/analytics.edit authorization scope.

Updates Google Signals settings for a property.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
googleSignalsSettings.name

string

Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

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

Response body

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

Authorization scopes

Requires the following OAuth scope:

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