Actions on Google: Interactive Canvas Sample

This sample demonstrates how to create an Interactive Canvas experience using Actions on Google for the Google Assistant. It uses the Node.js client library and is deployed on Cloud Functions for Firebase and Firebase Hosting.

Setup Instructions

Prerequisites

1. Node.js and NPM
   • We recommend installing using nvm for Linux/Mac and nvm-windows for Windows
2. Install the Firebase CLI
   • We recommend using MAJOR version 7 with 7.1.1 or above, npm install -g firebase-tools@^7.1.1
   • Run firebase login with your Google account

Configuration

Actions Console

1. From the Actions on Google Console, add a new project > Create Project > under More options > Conversational
2. Click Deploy in the top menu. Then, click Additional information.
   1. Under Category, select Games & fun
   2. Under Interactive Canvas Do your Actions use Interactive Canvas?, check Yes
3. Click Develop in the top menu. Then, click Actions > Add Your First Action > Play game > GET STARTED IN DIALOGFLOW (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
   1. Note that when creating a new project for Interactive Canvas, you must install the actions-on-google library Developer Preview version using the @preview tag with npm install actions-on-google@preview.
2. Run firebase deploy --project {PROJECT_ID} to deploy the function and hosting
   • 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.

   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

• 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.
• To hide the debug overlay, uncomment the code below /* Uncomment below to disable the debug overlay */ in public/css/main.css.

References & Issues

• Questions? Go to StackOverflow, Assistant Developer Community on Reddit or Support.
• For bugs, please report an issue on Github.
• Actions on Google Interactive Canvas Documentation
• 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.