Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.acknowledgeUserDataCollection
Stay organized with collections
Save and categorize content based on your preferences.
Acknowledges the terms of user data collection for the specified property.
This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
HTTP request
POST https://analyticsadmin.googleapis.com/v1beta/{property=properties/*}:acknowledgeUserDataCollection
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
property |
string
Required. The property for which to acknowledge user data collection.
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"acknowledgement": string
} |
Fields |
acknowledgement |
string
Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."
|
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://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 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis API endpoint acknowledges user data collection for a specified Google Analytics property.\u003c/p\u003e\n"],["\u003cp\u003eIt requires a specific acknowledgement phrase confirming the user's understanding of data collection terms.\u003c/p\u003e\n"],["\u003cp\u003eUsers need the \u003ccode\u003eanalytics.edit\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eA successful request results in an empty response body.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes an \u003ccode\u003eacknowledgement\u003c/code\u003e field containing the required phrase.\u003c/p\u003e\n"]]],["This API endpoint `acknowledgeUserDataCollection` requires a POST HTTP request to acknowledge user data collection for a specified property. The request URL includes a required `property` path parameter. The request body needs a JSON object with an `acknowledgement` field. This field must contain a specific string confirming understanding of data collection terms. Successful requests return an empty response. Authorization requires the `analytics.edit` scope. The action of acknowledgment is required before creating MeasurementProtocolSecret resources.\n"],null,["# Method: properties.acknowledgeUserDataCollection\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAcknowledges the terms of user data collection for the specified property.\n\nThis acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1beta/{property=properties/*}:acknowledgeUserDataCollection`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|--------------------------------------------------------------------------------|\n| `property` | `string` Required. The property for which to acknowledge user data collection. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------|\n| ``` { \"acknowledgement\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `acknowledgement` | `string` Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: \"I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property.\" |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]