Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

Method: projects.locations.catalogs.eventStores.userEvents.rejoin

Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing 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 catalog items. It can also be used to correct events joined with wrong catalog items.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Full resource name of user event, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

Authorization requires the following IAM permission on the specified resource parent:


Request body

The request body contains data with the following structure:

JSON representation
  "userEventRejoinScope": enum (UserEventRejoinScope)

enum (UserEventRejoinScope)

Required. The type of the catalog rejoin to define the scope and range of the user events to be rejoined with catalog items.

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.


The scope of events to be rejoined with latest catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting 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 catalogs with all events including both joined events and unjoined events.
JOINED_EVENTS Only rejoin catalogs with joined events.
UNJOINED_EVENTS Only rejoin catalogs with unjoined events.