Method: properties.setAutomatedGa4ConfigurationOptOut

  • This API method sets the opt out status for the automated GA4 setup process for a Universal Analytics property.

  • The request uses a POST method to the specified analyticsadmin.googleapis.com endpoint.

  • The request body requires specifying the UA property by its internal ID and a boolean value for the opt-out status.

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

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

HTTP request

POST https://analyticsadmin.googleapis.com/v1alpha/properties:setAutomatedGa4ConfigurationOptOut

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "property": string,
  "optOut": boolean
}
Fields
property

string

Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
optOut

boolean

The status to set.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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