Method: properties.acknowledgeUserDataCollection

  • This API endpoint is used to acknowledge the terms of user data collection for a specified Google Analytics property.

  • Acknowledgement is required before creating MeasurementProtocolSecret resources and involves confirming understanding of data collection and user privacy.

  • The request must include a specific acknowledgement phrase stating the user understands the implications of data collection and has necessary user consent.

  • The API uses a POST request to a specific endpoint and includes the property ID in the path.

  • Upon successful acknowledgement, the response body will be empty.

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/v1alpha/{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