This is the documentation for Recommendations AI, Retail Search, and the new Retail console. To use Retail Search in the restricted GA phase, contact Cloud sales.

If you are only using Recommendations AI, remain on the Recommendations console and refer to the Recommendations AI documentation.

Method: projects.locations.catalogs.completionData.import

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail enabled. Please submit a form here to contact cloud sales if you are interested in using Retail

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The catalog which the suggestions dataset belongs to.

Format: projects/1234/locations/global/catalogs/default_catalog.

Request body

The request body contains data with the following structure:

JSON representation
  "inputConfig": {
    object (CompletionDataInputConfig)
  "notificationPubsubTopic": string

object (CompletionDataInputConfig)

Required. The desired input location of the data.



Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.catalogs.import

For more information, see the IAM documentation.


The input config source for completion data.

JSON representation
  "bigQuerySource": {
    object (BigQuerySource)

object (BigQuerySource)

Required. BigQuery input source.

Add the IAM permission "BigQuery Data Viewer" for before using this feature otherwise an error is thrown.