Cloud Retail tag
Stay organized with collections
Save and categorize content based on your preferences.
This article is for developers who want to move their Cloud Retail tag off
of the client and into a server container. Refer to the Google Cloud
documentation for the Cloud Retail web container tag.
Before you begin
This guide assumes that you have done the following:
Set up the Cloud Retail tag
Open Google Tag Manager
In your server container, open the Tags menu and create a New tag.
In Tag Configuration, select the Cloud Retail tag.
Set up the Cloud Retail tag:
- Under API Key, enter a valid Cloud Retail API key that supports the
projects.locations.catalogs.userEvents.collect method.
- Under Project Number, enter the Google Cloud Project number for your
Cloud Retail project.
- Under Fields to Overwrite, set up a visitor ID:
- Field Selector:
visitorId
- Field Value: Enter a variable that resolves into a unique
visitor ID from a GA4 event, for example, the client ID.
- Optional: To measure search events:
- Field Selector:
searchQuery
- Field Value: Enter a variable that extracts the search query.
The search event is constructed by combining the search event query
with the impressions for the query, which are sent in
view_item_list.
In Triggering, select when the tag should trigger. Refer to the Google
Cloud documentation for mappings between Google Analytics 4 trigger events
and Cloud Retail events.
Name and Save your tag.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis guide helps developers move the Cloud Retail tag from client-side to a server-side container in Google Tag Manager.\u003c/p\u003e\n"],["\u003cp\u003eBefore starting, ensure you have set up a server container, a tagging server, and the data flow between web and server containers in Tag Manager.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves creating a new Cloud Retail tag in your server container, configuring it with your API key and project details, and mapping it to relevant triggers based on Google Analytics 4 events.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial to provide a unique visitor ID and optionally include search queries for enhanced tracking in your Cloud Retail tag configuration.\u003c/p\u003e\n"]]],["Developers moving Cloud Retail tags to a server container should first ensure they have a server container, tagging server, and data flow from web to server containers established. In the server container, create a new Cloud Retail tag, configuring it with a valid API key, project number, and a visitor ID variable (e.g., client ID). Optionally, configure search event measurement using a search query variable. Finally, select appropriate triggers based on GA4 event mappings and save the tag.\n"],null,["# Cloud Retail tag\n\n\u003e This article is for developers who want to move their Cloud Retail tag off\n\u003e of the client and into a server container. Refer to the Google Cloud\n\u003e documentation for the [Cloud Retail web container tag](https://cloud.google.com/retail/docs/record-events#gtm-tag).\n\nBefore you begin\n----------------\n\nThis guide assumes that you have done the following:\n\n- [Set up a server container in Tag Manager](/tag-platform/tag-manager/server-side/overview#create_a_tag_manager_server_container)\n- [Set up a tagging server](/tag-platform/tag-manager/server-side/overview#set_up_a_tagging_server)\n- [Set up the data flow from the web container to the server container](/tag-platform/tag-manager/server-side/send-data)\n\nSet up the Cloud Retail tag\n---------------------------\n\n1. [Open Google Tag Manager](https://tagmanager.google.com/)\n\n2. In your server container, open the **Tags** menu and create a **New** tag.\n\n3. In **Tag Configuration** , select the **Cloud Retail** tag.\n\n4. Set up the Cloud Retail tag:\n\n - Under **API Key** , enter a valid Cloud Retail API key that supports the [`projects.locations.catalogs.userEvents.collect` method](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.userEvents/collect).\n - Under **Project Number**, enter the Google Cloud Project number for your Cloud Retail project.\n - Under **Fields to Overwrite** , set up a visitor ID:\n - **Field Selector** : `visitorId`\n - **Field Value**: Enter a variable that resolves into a unique visitor ID from a GA4 event, for example, the client ID.\n - Optional: To measure search events:\n - **Field Selector** : `searchQuery`\n - **Field Value** : Enter a variable that extracts the search query. The search event is constructed by combining the search event query with the impressions for the query, which are sent in `view_item_list`.\n5. In **Triggering** , select when the tag should trigger. Refer to the Google\n Cloud documentation for [mappings between Google Analytics 4 trigger events\n and Cloud Retail events](https://cloud.google.com/retail/docs/record-events#ee-triggers).\n\n6. Name and **Save** your tag."]]