Method: properties.updateGoogleSignalsSettings

  • This page explains how to update Google Signals settings for a Google Analytics 4 property using the Google Analytics Admin API.

  • The method uses an HTTP PATCH request to a specific endpoint with path and query parameters.

  • Developers need to provide an updated GoogleSignalsSettings object in the request body and will receive an updated GoogleSignalsSettings object in the response if successful.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit 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