Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
HTTP request
POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import
Required. Parent DataStore resource name, of the form projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
Request body
The request body contains data with the following structure:
JSON representation
{"errorConfig": {object (ImportErrorConfig)},// Union field source can be only one of the following:"inlineSource": {object (InlineSource)},"gcsSource": {object (GcsSource)},"bigquerySource": {object (BigQuerySource)}// End of list of possible types for union field source.}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis API facilitates the bulk import of user events, which can be processed synchronously, with the system skipping events that already exist, making it ideal for backfilling.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a POST method to the specified URL, which incorporates gRPC Transcoding syntax, and requires a parent DataStore resource name in the path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a source, which can be an \u003ccode\u003einlineSource\u003c/code\u003e, \u003ccode\u003egcsSource\u003c/code\u003e, or \u003ccode\u003ebigquerySource\u003c/code\u003e for the user event data, alongside an optional \u003ccode\u003eerrorConfig\u003c/code\u003e to manage import errors.\u003c/p\u003e\n"],["\u003cp\u003eA successful import operation returns an \u003ccode\u003eOperation\u003c/code\u003e instance, which may contain a subset of successfully inserted items.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003ediscoveryengine.userEvents.import\u003c/code\u003e on the parent resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.collections.dataStores.userEvents.import\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- [IAM Permissions](#body.aspect_1)\n\nBulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.\n\nOperation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.\n\n### HTTP request\n\n`POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/generative-ai-app-builder/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `discoveryengine.userEvents.import`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
