Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.fetchAutomatedGa4ConfigurationOptOut
Stay organized with collections
Save and categorize content based on your preferences.
Fetches 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:fetchAutomatedGa4ConfigurationOptOut
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"property": string
} |
| Fields |
property |
string
Required. The UA property to get 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
|
Response body
Response message for fetching the opt out status for the automated GA4 setup process.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"optOut": boolean
} |
| Fields |
optOut |
boolean
The opt out status for the UA property.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eFetches the automated GA4 setup opt-out status for a Universal Analytics (UA) property, having no impact on GA4 properties.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the internal property ID of the UA property, not the tracking ID.\u003c/p\u003e\n"],["\u003cp\u003eThe response indicates whether the automated GA4 setup is opted out for the specified UA property.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["The core action is to fetch the opt-out status of a UA property for the automated GA4 setup. This is done via a POST request to `https://analyticsadmin.googleapis.com/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut`. The request body requires a JSON object with the `property` field specifying the UA property's internal ID. The response body contains a JSON object with the `optOut` field indicating the property's opt-out status. Two authorization scopes are available:`analytics.readonly` or `analytics.edit`.\n"],null,["# Method: properties.fetchAutomatedGa4ConfigurationOptOut\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FetchAutomatedGa4ConfigurationOptOutResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nFetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------|\n| ``` { \"property\": string } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `property` | `string` Required. The UA property to get 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 |\n\n### Response body\n\nResponse message for fetching the opt out status for the automated GA4 setup process.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------|\n| ``` { \"optOut\": boolean } ``` |\n\n| Fields ||\n|----------|---------------------------------------------------|\n| `optOut` | `boolean` The opt out status for the UA property. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]
