actions-on-google

Actions on Google Client Library

This client library makes it easy to create your apps for the Google Assistant, and supports both Dialogflow fulfillment and the Actions SDK webhook.

Setup Instructions

Install the library with either npm i actions-on-google or yarn add actions-on-google if you use yarn.

Dialogflow

1. Import the appropriate service:

const { dialogflow } = require('actions-on-google')

1. Create an instance:

const app = dialogflow()

Actions SDK

1. Import the appropriate service:

const { actionssdk } = require('actions-on-google')

1. Create an app instance:

const app = actionssdk()

Library Development Instructions

This library uses yarn to run commands. Install yarn using instructions from https://yarnpkg.com/en/docs/install or with npm: npm i -g yarn.

Install the library dependencies with yarn. If you want to run any of the sample apps, follow the instructions in the sample README.

Functionality

Public interfaces, classes, functions, objects, and properties are labeled with the JSDoc @public tag and exported at the top level. Everything else that is not labeled @public and exported at the top level is considered internal and may be changed.

This library supports the following Services:

• Dialogflow v1 and v2
• Actions SDK v2 only

Actions SDK

This library supports only Actions SDK fulfillment version 2.

To ensure that your fulfillment uses version 2, set the "fulfillmentApiVersion": 2 property in your action package.

References and How to report bugs

• Actions on Google documentation: https://developers.google.com/actions/.
• If you find any issues, please open a bug on GitHub.
• Questions are answered on StackOverflow.

How to make contributions?

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

License

See LICENSE.md.

Terms

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

Google+

Actions on Google Developers Community on Google+ https://g.co/actionsdev.

Changelog

[2.0.0] - 2018-05-08

Changed

From Major Version 1

• Rewrote to use TypeScript with main API intended for JavaScript
• Separate app instance to a cross conversational app instance and a per conversation conv instance
• Redesign objects to use an API backbone from protobufs that define the Conversation API
• Redesign API to be overloaded and sent through conv.ask so that it can build the response for the developer incrementally
• Redesign API to use more idiomatic JavaScript
• Create frameworks system to support different platforms seamlessly
• Create clear separations of services so APIs are distinctly separate
• Add new modular architecture that allows plugins to extend functionality
• Drop support for Actions SDK v1 and various legacy features

From Alpha

• Remove plugins and utils from library repo
• Various bug fixes
• Add support for all features from v1 besides legacy features
• Clean up arguments and create separate status parsing out
• Add ability to send raw JSON
• Add fallback handler
• Add status and error customization for Dialogflow verification
• Add support for Dialogflow followup events