Getting Started
In Unity Dashboard, the Walmart Immersive Commerce product can be found under the Grow category.
The Commerce opportunities will only be available to players in the United States for now.
In order to perform the setup steps below, you need to be the Owner of the organization or have Immersive Commerce Service Manager role assigned to your user.
In the Setup page, Walmart Commerce Terms need to be accepted in order to use this product.
Client credentials are needed to make purchases on Walmart, and they can be obtained from the Setup page, once the agreements have been accepted. A private / public key is required to safely retrieve the client’s secret. Details on how to generate and use them, can be found in the Unity Dashboard Setup Guide page (step 1).
You can define a product package to include a list of products you plan to sell in your game. In Unity Editor, you will define a commerce opportunity that will display at runtime, one of these products randomly. If you want to guarantee that a particular product is selected, simply make a singular item product package.
In order to place orders on Walmart ecommerce, you need to have a backend service that will make API calls to Walmart Services. Unity provides a reference implementation that can be used. The steps below describe how to deploy this reference implementation in Unity Cloud Code. More details can be found in the Setup Guide page (step 5).
a. Create Unity service account
A service account is needed to allow UGS CLI tools to perform deployments on Cloud Code. The following roles should be configured for the service account.
b.Install UGS CLI
Follow these instructions to install UGS CLI.
c. Clone Walmart Relay Server repository
Clone the relay server repository. You will need .NET SDK 8.0 or higher to build and publish this service.
d. Deploy Relay Server in Production environment
Using the key-id and secret-key obtained when setting up the Unity service account, run the following commands from the root folder of the cloned repo:
ugs login
ugs config set project-id <project id>
ugs config set environment-name production
Create a configuration.rc file in the root of the OrcaAuthRelay folder.
{
"$schema": "https://ugs-config-schemas.unity3d.com/v1/remote-config.schema.json", "entries": {
"WALMART_IAM_CLIENT_ID": "<client ID>",
"WALMART_IAM_HOSTNAME": "[developer.api.walmart.com](http://developer.api.walmart.com)",
"WALMART_ICS_HOSTNAME": "[developer.api.us.walmart.com](http://developer.api.us.walmart.com)",
"WALMART_ICS_KEY_VERSION" : "2",
"WALMART_ICS_TITLE_ID": "<client ID>"
},
"types": { }
}
Deploy service and configuration.
ugs deploy .
Validate that deployment was successful in Cloud Code and RemoteConfig.
e. Deploy Relay Server in Sandbox environment
Follow similar steps to do a deployment for a sandbox environment. Details of this, can be found in the Setup Guide page (step 5).
f. Add project secrets
Set the following project secrets in the Unity dashboard.
- Configuring Cat Game Sample
Clone CatGame repo
Clone the CatGame repository and open the project in Unity Editor.
Link the game to the cloud project
In Unity Editor, link the Unity project to the cloud project. More details can be found in Setup Guide page (step2).
Datastore configuration
Set the Organization Id in Assets/Resources/Commerce Opportunity Editor/CommerceOpportunityDatastore.asset.
Sync product packages from Unity Dashboard
This step will link the existing commerce opportunity from the sample game to the product package created previously. When the commerce opportunity will be displayed at runtime, it will show a random product from the product package.
Set Url to Walmart Relay Server
Set BaseUrl setting to “https://cloud-code.services.api.unity.com/v1/projects/” in Assets/Resources/Unity Immersive Commerce/ARS Configuration. This will allow the game to communicate with the Walmart Relay server to purchase Walmart products.
Set deep link for Android
This step is required to allow players to link their Walmart accounts to your in-game accounts. From the game, players will be redirected to the Walmart website to enter their credentials for their Walmart account. Once this is done, they will be redirected back to the game via the deep link. Details about this step can be found in the Setup Guide (step 12).
Update the AndroidManifest.xml based on the deeplink url, which can be found in the Unity Dashboard, Setting page.
Build & Run on Android
The Walmart Immersive Commerce experience is currently available only in the United States. You can use a US VPN Gateway, if testing from another country.
