A Node.js server for Google Assistant (and Google Home).
{
"versionLabel": "1.0.0",
"agentInfo": {
"languageCode": "en-US",
"projectId": "my-first-action",
"voiceName": "female_2"
},
"actions": [{
"initialTrigger": {
"intent": "assistant.intent.action.MAIN"
},
"httpExecution": {
"url": "<PUBLIC URL>"
}
}]
}
NOTE: if you're deploying your action on Google Cloud, use your Google Cloud Project ID instead of "my-first-action".
In the package.json
, we provide you with the following (handy) scripts:
{
"scripts": {
"start": "npm run server",
"server": "nodemon dist/action.js",
"ngrok": "ngrok http 8080",
"build": "babel lib -d dist",
"build:watch": "npm run build -- -w",
"action:simulate": "gactions --verbose simulate",
"action:preview": "node ./scripts/preview_action.js",
"action:config": "node ./scripts/update_action_config.js",
"action:autopreview": "npm run action:config && npm run action:preview",
"action:deploy": "gactions deploy --action_package action.json --project my-first-action",
"release": "npm run build && npm version patch && git push --tags && git push && npm publish"
}
}
NOTE: The default port used by GAS is 8080
. See API section.
Tools bunlded by GAS for devs needs:
npm install
to install all depsnpm start
npm run ngrok
and keep it running in the background,npm run action:autopreview
, and follow the instructions on the terminal,npm run action:simulate
to start the simulator in CLI mode (or use Google Home)talk to my first action
or start my first action
HINT #1: you can run npm run build:watch
in order to watch and rebuild your files on the fly while you're working on your action.
HINT #2: I you have a Google Home device, you can use it instead of using the simulator.
NOTE: If you already have a dev server where you can host your this project, you can use your own URL in httpExecution.url
and skip steps 1 and 2. And run npm run action:preview
instead. See package.json
for more details.
See the GAS documentation from more details.
In order to make a deep link invocation, you have to provide two things:
action.json
(see this example)Then you just have to start your action like so:
talk to my first action to <ONE OF THE DEEP LINK QUERIES HERE>
For instance:
talk to my first action to know what is the date
After you have created a Conversation Action you must first deploy your fulfillment endpoint to any provider, such as Google Cloud:
gcloud config set project my-first-action
.my-first-project
with your project ID in vm.yaml
and run gcloud deployment-manager deployments create production --config vm.yaml
. You can check your deployment with gcloud deployment-manager deployments describe production
.npm run build && gcloud app deploy
.Deploying the action makes it usable by others by submitting it for approval with Google.
NOTE: Once submitted you have to wait for your action to be rejected or approved, there's no way to un-submit an action without contacting support.
httpExecution
URL(s) in action.json to the deployed fulfillment URL, eg. https://my-first-action.appspot-preview.com
.my-first-action
by your action's ID in package.json
.npm run action:deploy
, which will register and deploy your action.See the GAS documentation for more details.
The MIT License (MIT) Copyright (c) 2017 - Wassim CHEGHAM
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.