Google Vertex AI Search for Commerce Connector Setup Guide

API Information

This connector uses the following vendor API:

Go to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

Google Cloud Platform Project ID: (Required) Your Google Cloud project ID. The project must have Vertex Search AI enabled.
Private key JSON file: (Required) Paste the JSON key generated for your service account.
- The service account requires access to retail.userEvents.import. Google recommends using the Retail Editor role.

Action Name	AudienceStream	EventStream
Write User Event	✗	✓

Enter a name for the action and select the action type.

The following section describes how to set up parameters and options for each action.

Parameter	Description
Catalog	Select the Vertex AI Search for Commerce catalog where user events will be recorded.
Event Type	Choose the type of user event to send to Vertex AI Search for Commerce. This determines how the event is interpreted and which fields are required in the payload. `add-to-cart` `remove-from-cart` `category-page-view` `detail-page-view` `home-page-view` `purchase-complete` `search` `shopping-cart-page-view`

Parameter	Description
Attributes	Map extra user event features to include in the recommendation model
Template Variables	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, `{{SomeTemplateName}}`. When using OAuth, the template variable `{{webhook_access_token}}` refers to the token returned by the authentication request.