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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["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,["- [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\nHTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nRequest 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\nResponse body Response 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\nAuthorization 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`"]]
