Actions on Google: Transactions Sample

⚠️ Warning: Conversational Actions will be deprecated on June 13, 2023. For more information, see Conversational Actions Sunset.

This sample demonstrates Actions on Google features for use on Google Assistant including physical transactions -- using the Node.js client library and deployed on Cloud Functions for Firebase.

This sample shows everything you need to facilitate transactions, including:

• Check for transaction requirements
• Get the delivery address
• Confirm the transaction
• Examples of Google Pay and merchant-managed payment options
• Asynchronously update order status at any time (via order-update.js)

⚠️ This code sample was built using Dialogflow. We now recommend using Actions Builder or the Actions SDK to develop, test, and deploy Conversational Actions.

⚠️ Warning: Due to new regulatory requirements, transaction functionalities for Conversational Actions are no longer available in the following countries: Denmark, France, Germany, Italy, the Netherlands, Norway, Spain, Sweden, Poland

Setup Instructions

Prerequisites

1. Node.js and NPM
   • We recommend installing using NVM
2. Install the Firebase CLI
   • We recommend using version 6.5.0, npm install -g [email protected]
   • Run firebase login with your Google account

Configuration

Actions Console

1. From the Actions on Google Console, New project (this will become your Project ID) > Create Project > under More options > Conversational
2. From the top menu under Deploy > Directory Information (left nav), where all of the information is required to run transactions (sandbox or otherwise) unless specifically noted as optional.
   • Privacy Policy link: for testing purposes can be https://www.example.com
   • Terms of Service link: for testing purposes can be https://www.example.com
   • Additional information >
     • Select a Category
     • Do your Actions use the Transactions API to perform transactions of physical goods? > Yes > Save.
3. From the top menu under Develop > Actions (left nav) > Add your first action > BUILD (this will bring you to the Dialogflow console) > Select language and time zone > CREATE.
4. In the Dialogflow console, go to Settings ⚙ > Export and Import > Restore from zip using the agent.zip in this sample's directory.

Firebase Deployment

1. On your local machine, in the functions directory, run npm install
2. Run firebase deploy --project {PROJECT_ID} to deploy the function
   • To find your Project ID: In Dialogflow console under Settings ⚙ > General tab > Project ID.

Dialogflow Console

1. Return to the Dialogflow Console > select Fulfillment > Enable Webhook > Set URL to the Function URL that was returned after the deploy command > SAVE.

   Function URL (dialogflowFirebaseFulfillment): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/dialogflowFirebaseFulfillment
   

2. From the left navigation menu, click Integrations > Integration Settings under Google Assistant > Enable Auto-preview changes > Test to open the Actions on Google simulator then say or type Talk to my test app.

Running this Sample

• (Recommended) You can test your Action on any Google Assistant-enabled device on which the Assistant is signed into the same account used to create this project. Just say or type, “OK Google, talk to my test app”.
• You can also use the Actions on Google Console simulator to test most features and preview on-device behavior.

Order Updates (order-update.js)

Order Updates Configuration

1. In the Google Cloud Platform console, select your Project ID from the dropdown > Menu ☰ > APIs & Services > Library
2. Select Actions API > Enable
3. Under Menu ☰ > APIs & Services > Credentials > Create Credentials > Service Account Key.
4. From the dropdown, select New Service Account
   • name: service-account
   • role: Project/Owner
   • key type: JSON > Create
   • Your private JSON file will be downloaded to your local machine
5. In order-update.js:
   • Replace ./path/to/key.json placeholder with the service-account.json path
   • Replace <UNIQUE_ORDER_ID> placeholder with the ID of the order you wish to update (merchantOrderId) -- your order value will be shown in the confirmation response
6. In terminal, in the functions/, run the script to send an order update: node order-update.js.
   • Status: 200 OK will be logged to the console upon a successful order update

References & Issues

• Questions? Go to StackOverflow, Assistant Developer Community on Reddit or Support.
• For bugs, please report an issue on Github.
• Actions on Google Documentation
• Actions on Google Codelabs
• Webhook Boilerplate Template for Actions on Google

Make Contributions

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Google APIs Terms of Service.