Actions On Google: Actions SDK Sample

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

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

This sample demonstrates how to create an Action for the Google Assistant -- using Actions SDK in Node.js and deployed on Cloud Functions for Firebase.

Setup Instructions

Prerequisites

1. Node.js and NPM
   • We recommend installing using NVM
2. Install the Firebase Functions CLI
   • We recommend using version 6.5.0, npm install -g [email protected]
   • Run firebase login with your Google account
3. Install the gactions CLI
   • You may need to grant execute permission, ‘chmod +x ./gactions’

Configuration

Actions Console

1. From the Actions on Google Console, new project (this will become your Project ID) > Create project > under More options select Actions SDK > keep the Use Actions SDK to add Actions window open, will revisit in a later step.

Firebase Deployment

1. On your local machine, in the functions directory, run npm install
2. Run firebase deploy --project {PROJECT_ID}, replace {PROJECT_ID} to deploy the function

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

3. Update the action package, action.json, replacing the placeholder value YOUR_ENDPOINT_URL with the value for Function URL obtained from the previous step.
4. From the top level directory in this sample, run gactions update --action_package action.json --project {PROJECT_ID} with your Project ID.
5. Back in the Actions console, from the pop up window > select OK.
6. From the top menu click 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.

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.

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.