Method: projects.locations.catalogs.completionData.import

Bulk import of processed completion dataset.

Request processing is asynchronous. Partial updating is not supported.

The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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 is sent to specified Pub/Sub topic. The message data is 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.