actions-on-google/actionssdk-quickstart-java

Documentation samples for Actions on Google (Actions SDK/Java)

Actions on Google: Actions SDK Docs Samples (Java)

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

⚠️ These code samples were 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 repo contains samples demonstrating the core features of Actions on Google when building with Actions SDK and using our Java/Kotlin Client Library. Code snippets from these samples are included throughout the Actions on Google documentation.

Setup Instructions

The commands shown below can be run from any of the directories to deploy and run the sample.

Prerequisites

1. Download & install the Google Cloud SDK
2. Gradle with App Engine Plugin
   • Install and update the App Engine component,gcloud components install app-engine-java
   • Update other components, gcloud components update
3. Install the gactions CLI
   • You may need to grant execute permission, ‘chmod +x ./gactions’

Configuration

Action Console Configuration

1. From the Actions on Google Console, New project (this will become your Project ID) > Create project.
2. Scroll down > under More options select Actions SDK > keep Use Actions SDK to add Actions modal open
3. Install the gactions CLI if you haven't already.

App Engine Deployment & Webhook Configuration

When a new project is created using the Actions Console, it also creates a Google Cloud project in the background.

1. Configure the gcloud CLI and set your Google Cloud project to the name of your Actions on Google Project ID, which you can find from the Actions on Google console under Settings ⚙

   • gcloud init

2. Deploy to App Engine using Gradle:

   • gradle appengineDeploy OR
   • From within IntelliJ, open the Gradle tray and run the appEngineDeploy task

3. Open the action.json file:

   • In the conversations object > replace the placeholder URL values with https://<YOUR_PROJECT_ID>.appspot.com

4. In terminal, run gactions update --action_package action.json --project ${YOUR_PROJECT_ID}

5. Back in the Actions console, from the Use Actions SDK to add Actions window > select OK.

6. From the left 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.
• Getting started with Actions SDK Guide.
• More info about Gradle & the App Engine Plugin.
• More info about deploying Java apps with App Engine.

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.