This is the documentation for Recommendations AI only. To try Retail Search and the unified Retail console in the restricted GA phase, contact Cloud sales. If you are not planning to use Retail Search, remain on the Recommendations console until further notice.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Method: projects.locations.catalogs.userEvents.rejoin

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Request body

The request body contains data with the following structure:

JSON representation
  "userEventRejoinScope": enum (UserEventRejoinScope)

enum (UserEventRejoinScope)

The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an invalid integer value.

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.userEvents.rejoin

For more information, see the IAM documentation.


The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.

USER_EVENT_REJOIN_SCOPE_UNSPECIFIED Rejoin all events with the latest product catalog, including both joined events and unjoined events.
JOINED_EVENTS Only rejoin joined events with the latest product catalog.
UNJOINED_EVENTS Only rejoin unjoined events with the latest product catalog.