This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

Method: projects.locations.collections.dataStores.userEvents.import

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
IAM Permissions
Try it!

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`

parent

string

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

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`. }

{
  "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.
}

Fields
`errorConfig`	`object (ImportErrorConfig)` The desired location of errors incurred during the Import. Cannot be set for inline user event imports.
Union field `source`. Required - The desired input source of the user event data. `source` can be only one of the following:
`inlineSource`	`object (InlineSource)` The Inline source for the input content for UserEvents.
`gcsSource`	`object (GcsSource)` Cloud Storage location for the input content.
`bigquerySource`	`object (BigQuerySource)` BigQuery input source.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

discoveryengine.userEvents.import

For more information, see the IAM documentation.