├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── agent.zip ├── firebase.json ├── firestore.indexes.json ├── firestore.rules └── functions ├── .eslintrc.json ├── index.js ├── package.json └── tipsDB.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | *.DS_store 4 | npm-debug.log 5 | .firebaserc 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to become a contributor and submit your own code 2 | 3 | ## Contributor License Agreements 4 | 5 | We'd love to accept your sample apps and patches! Before we can take them, we 6 | have to jump a couple of legal hurdles. 7 | 8 | Please fill out either the individual or corporate Contributor License Agreement 9 | (CLA). 10 | 11 | * If you are an individual writing original source code and you're sure you 12 | own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual). 13 | * If you work for a company that wants to allow you to contribute your work, 14 | then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate). 15 | 16 | Follow either of the two links above to access the appropriate CLA and 17 | instructions for how to sign and return it. Once we receive it, we'll be able to 18 | accept your pull requests. 19 | 20 | ## Contributing A Patch 21 | 22 | 1. Submit an issue describing your proposed change to the repo in question. 23 | 1. The repo owner will respond to your issue promptly. 24 | 1. If your proposed change is accepted, and you haven't already done so, sign a 25 | Contributor License Agreement (see details above). 26 | 1. Fork the desired repo, develop and test your code changes. 27 | 1. Ensure that your code adheres to the existing style in the sample to which 28 | you are contributing. Refer to the 29 | [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the 30 | recommended coding standards for this organization. 31 | 1. Ensure that your code has an appropriate set of unit tests which all pass. 32 | 1. Submit a pull request. 33 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Actions on Google: Daily Updates and Push Notifications Sample 2 | 3 | *:warning: Warning: Conversational Actions will be deprecated on June 13, 2023. For more information, 4 | see [Conversational Actions Sunset](https://goo.gle/ca-sunset).* 5 | 6 | 7 | This sample demonstrates Actions on Google [user engagement](https://developers.google.com/assistant/engagement) features for use on Google Assistant including [daily updates](https://developers.google.com/assistant/engagement/daily) and [push notifications](https://developers.google.com/assistant/engagement/notifications) -- using the [Node.js client library](https://github.com/actions-on-google/actions-on-google-nodejs) and deployed on [Cloud Functions for Firebase](https://firebase.google.com/docs/functions/). 8 | 9 | 10 | :warning: This code sample was built using Dialogflow. We now recommend using [Actions Builder or the Actions SDK](https://developers.google.com/assistant/conversational/overview) to develop, test, and deploy Conversational Actions. 11 | 12 | ## Setup Instructions 13 | ### Prerequisites 14 | 1. Node.js and NPM 15 | + We recommend installing using [NVM](https://github.com/creationix/nvm) 16 | 1. Install the [Firebase CLI](https://developers.google.com/assistant/actions/dialogflow/deploy-fulfillment) 17 | + We recommend using version 6.5.0, `npm install -g firebase-tools@6.5.0` 18 | + Run `firebase login` with your Google account 19 | 20 | ### Configuration 21 | #### Actions Console 22 | 1. From the [Actions on Google Console](https://console.actions.google.com/), New project > **Create project** > under **More options** > **Conversational** 23 | 1. From the top menu under **Develop** > **Actions** (left nav) > **Add your first action** > **BUILD** (this will bring you to the Dialogflow console) > Select language and time zone > **CREATE**. 24 | 1. In the Dialogflow console, go to **Settings** ⚙ > **Export and Import** > **Restore from zip** using the `agent.zip` in this sample's directory. 25 | 26 | #### Cloud Platform Console 27 | 1. In the [Google Cloud Platform console](https://console.cloud.google.com/), select your *Project ID* from the dropdown 28 | 1. From **Menu ☰** > **APIs & Services** > **Library** > select **Actions API** > **Enable** 29 | 1. Under **Menu ☰** > **APIs & Services** > **Credentials** > **Create Credentials** > **Service Account Key**. 30 | 1. From the dropdown, select **New Service Account** 31 | + name: `service-account` 32 | + role: **Project/Owner** 33 | + key type: **JSON** > **Create** 34 | + Your private JSON file will be downloaded to your local machine 35 | 1. Save private key as `service-account.json` in `functions/` 36 | 37 | #### Daily Updates and Push Notifications 38 | 1. Back in the [Actions on Google console](https://console.actions.google.com) > under the top menu **Develop** > **Actions** (left nav): 39 | 1. Select the `tell_tip` intent > under **User engagement**: 40 | + **Enable** `Would you like to offer daily updates to users?` 41 | + Title: `advice Alert` > **Save** 42 | 1. Select the `tell_latest_tip` intent > under **User engagement**: 43 | + **Enable** `Would you like to send push notifications? If yes, user permission will be needed` 44 | + Title: `latest info Alert` > **Save** 45 | 46 | #### Firestore Database 47 | 1. From the [Firebase console](https://console.firebase.google.com), find and select your Actions on Google Project ID 48 | 1. In the left navigation menu under **Develop** section > **Database** > **Create database** button > Select **Start in test mode** > **Enable** 49 | 50 | #### Firebase Deployment 51 | 1. On your local machine, in the `functions` directory, run `npm install` 52 | 1. Run `firebase deploy --project {PROJECT_ID}` to deploy the function 53 | + To find your **Project ID**: In [Dialogflow console](https://console.dialogflow.com/) under **Settings** ⚙ > **General** tab > **Project ID**. 54 | 55 | #### Dialogflow Console 56 | 1. Return to the [Dialogflow Console](https://console.dialogflow.com) > select **Fulfillment** > **Enable** Webhook > Set **URL** to the **Function URL** that was returned after the deploy command > **SAVE**. 57 | ``` 58 | Function URL (aogTips): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/aogTips 59 | ``` 60 | 1. In a browser, go to `https://${REGION}-${PROJECT}.cloudfunctions.net/restoreTipsDB`, to add data to the Firestore database. 61 | 1. 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`. 62 | + To test daily updates, choose a category and below the tip, there will be a `Send daily` suggestion chip to subscribe for daily updates. 63 | + To test push notifications, choose `most recent` and below the tip, there will be an `Alert me of new tips` suggestion chip to subscribe for push notifications. Then you will need to add a tip to Firestore DB to receive the push notification. 64 | 65 | #### Push Notifications Configuration 66 | 1. Then add a new tip to the Firestore Database to trigger a notification to the subscribed users. In the tips collection > select **Add document**: 67 | + Document ID: select **Auto ID** 68 | + field: `category`, type: string, value: `tools` 69 | + field: `created_at`, type: string, value: `2019-04-29T015:00:00.000Z` and modify value to current date/time 70 | + field: `tip`, type: string, value: `Here's the most recent info about tools` 71 | + field: `url`, type: string, value: `https://developers.google.com/actions/assistant/updates/notifications` 72 | 73 | ### Running this Sample 74 | + 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”. 75 | + You can also use the Actions on Google Console simulator to test most features and preview on-device behavior. 76 | 77 | ### Troubleshooting 78 | + When testing on an iOS device, ensure that notifications are enabled for Assistant under settings. 79 | 80 | ## References & Issues 81 | + Questions? Go to [StackOverflow](https://stackoverflow.com/questions/tagged/actions-on-google), [Assistant Developer Community on Reddit](https://www.reddit.com/r/GoogleAssistantDev/) or [Support](https://developers.google.com/assistant/support). 82 | + For bugs, please report an issue on Github. 83 | + Actions on Google [Documentation](https://developers.google.com/assistant) 84 | + Actions on Google [Codelabs](https://codelabs.developers.google.com/?cat=Assistant) 85 | + [Webhook Boilerplate Template](https://github.com/actions-on-google/dialogflow-webhook-boilerplate-nodejs) for Actions on Google 86 | 87 | ## Make Contributions 88 | Please read and follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md). 89 | 90 | ## License 91 | See [LICENSE](LICENSE). 92 | 93 | ## Terms 94 | 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](https://developers.google.com/terms/). 95 | -------------------------------------------------------------------------------- /agent.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/actions-on-google/dialogflow-updates-nodejs/f665687e3fd208f3e3be650a8d28557a6fd9a305/agent.zip -------------------------------------------------------------------------------- /firebase.json: -------------------------------------------------------------------------------- 1 | { 2 | "firestore": { 3 | "rules": "firestore.rules", 4 | "indexes": "firestore.indexes.json" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /firestore.indexes.json: -------------------------------------------------------------------------------- 1 | { 2 | // Example: 3 | // 4 | // "indexes": [ 5 | // { 6 | // "collectionId": "widgets", 7 | // "fields": [ 8 | // { "fieldPath": "foo", "mode": "ASCENDING" }, 9 | // { "fieldPath": "bar", "mode": "DESCENDING" } 10 | // ] 11 | // } 12 | // ] 13 | "indexes": [] 14 | } -------------------------------------------------------------------------------- /firestore.rules: -------------------------------------------------------------------------------- 1 | service cloud.firestore { 2 | match /databases/{database}/documents { 3 | match /{document=**} { 4 | allow read, write; 5 | } 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /functions/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "parserOptions": { 3 | "ecmaVersion": 7, 4 | "sourceType": "script" 5 | }, 6 | "extends": ["google"], 7 | "env": { 8 | "node": true 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /functions/index.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018, Google, Inc. 2 | // Licensed under the Apache License, Version 2.0 (the 'License'); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software 9 | // distributed under the License is distributed on an 'AS IS' BASIS, 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | // See the License for the specific language governing permissions and 12 | // limitations under the License. 13 | 14 | /** 15 | * Best practices: Ask for daily updates and push notifications in a limited 16 | * capacity for optimal user experience. In a production-ready app, you should 17 | * be more sophisticated about this, i.e. re-ask after a certain period of time 18 | * or number of interactions. 19 | */ 20 | 21 | 'use strict'; 22 | 23 | const { 24 | dialogflow, 25 | BasicCard, 26 | Button, 27 | RegisterUpdate, 28 | Suggestions, 29 | UpdatePermission, 30 | } = require('actions-on-google'); 31 | const admin = require('firebase-admin'); 32 | const functions = require('firebase-functions'); 33 | 34 | /** Dialogflow Parameters {@link https://dialogflow.com/docs/actions-and-parameters#parameters} */ 35 | const Parameters = { 36 | CATEGORY: 'category', 37 | }; 38 | 39 | /** Collections and fields names in Firestore */ 40 | const FirestoreNames = { 41 | CATEGORY: 'category', 42 | CREATED_AT: 'created_at', 43 | INTENT: 'intent', 44 | TIP: 'tip', 45 | TIPS: 'tips', 46 | URL: 'url', 47 | USERS: 'users', 48 | USER_ID: 'userId', 49 | }; 50 | 51 | /** App strings */ 52 | const RANDOM_CATEGORY = 'random'; 53 | const RECENT_TIP = 'most recent'; 54 | const TELL_LATEST_TIP_INTENT = 'tell_latest_tip'; 55 | const DAILY_NOTIFICATION_ASKED = 'daily_notification_asked'; 56 | const PUSH_NOTIFICATION_ASKED = 'push_notification_asked'; 57 | 58 | admin.initializeApp(); 59 | const db = admin.firestore(); 60 | 61 | const app = dialogflow({debug: true}); 62 | 63 | // Retrieve data from database and tell a tip. 64 | app.intent('tell_tip', (conv, params) => { 65 | const category = params[Parameters.CATEGORY]; 66 | let tipsRef = db.collection(FirestoreNames.TIPS); 67 | if (category !== RANDOM_CATEGORY) { 68 | tipsRef = tipsRef.where(FirestoreNames.CATEGORY, '==', category); 69 | } 70 | return tipsRef.get() 71 | .then((querySnapshot) => { 72 | const tips = querySnapshot.docs; 73 | const tipIndex = Math.floor(Math.random() * tips.length); 74 | const tip = tips[tipIndex]; 75 | 76 | conv.ask(tip.get(FirestoreNames.TIP)); 77 | conv.ask(new BasicCard({ 78 | text: tip.get(FirestoreNames.TIP), 79 | buttons: new Button({ 80 | title: 'Learn More!', 81 | url: tip.get(FirestoreNames.URL), 82 | }), 83 | })); 84 | 85 | if (!conv.user.storage[DAILY_NOTIFICATION_ASKED]) { 86 | conv.ask(new Suggestions('Send daily')); 87 | conv.user.storage[DAILY_NOTIFICATION_ASKED] = true; 88 | } 89 | }); 90 | }); 91 | 92 | // Retrieve data from database and tell a tip via push notification. 93 | app.intent('tell_latest_tip', (conv) => { 94 | return db.collection(FirestoreNames.TIPS) 95 | .orderBy(FirestoreNames.CREATED_AT, 'desc') 96 | .limit(1) 97 | .get() 98 | .then((querySnapshot) => { 99 | const tip = querySnapshot.docs[0]; 100 | 101 | conv.ask(tip.get(FirestoreNames.TIP)); 102 | conv.ask(new BasicCard({ 103 | text: tip.get(FirestoreNames.TIP), 104 | buttons: new Button({ 105 | title: 'Learn More!', 106 | url: tip.get(FirestoreNames.URL), 107 | }), 108 | })); 109 | 110 | if (!conv.user.storage[PUSH_NOTIFICATION_ASKED]) { 111 | conv.ask(new Suggestions('Alert me of new tips')); 112 | conv.user.storage[PUSH_NOTIFICATION_ASKED] = true; 113 | } 114 | }); 115 | }); 116 | 117 | app.intent('Default Welcome Intent', (conv) => { 118 | // User engagement features aren't currently supported on speaker-only devices 119 | // See docs: https://developers.google.com/actions/assistant/updates/overview 120 | if (!conv.screen) { 121 | return conv.close(`Hi! Welcome to Actions on Google Tips! To learn ` + 122 | `about user engagement you will need to switch to a screened device.`); 123 | } 124 | if (conv.user.verification !== 'VERIFIED') { 125 | return conv.close('Hi! Welcome to Actions on Google Tips! To learn ' + 126 | `about user engagement you'll need to be a verified user.`); 127 | } 128 | // Get categories to show in the welcome message and in suggestions 129 | return db.collection(FirestoreNames.TIPS) 130 | .get() 131 | .then((querySnapshot) => { 132 | // create an array that contains only the unique values of categories 133 | const uniqueCategories = querySnapshot.docs.map((currentValue) => { 134 | return currentValue.get(FirestoreNames.CATEGORY); 135 | }) 136 | .filter((element, index, array) => { 137 | return array.indexOf(element) === index; 138 | }); 139 | uniqueCategories.unshift(RECENT_TIP); 140 | const welcomeMessage = `Hi! Welcome to Actions on Google Tips! I can ` + 141 | `offer you tips for Actions on Google. You can pick a category ` + 142 | `from ${uniqueCategories.join(', ')}, or I can tell you a tip from ` + 143 | `a randomly selected category.`; 144 | uniqueCategories.push(RANDOM_CATEGORY); 145 | conv.ask(welcomeMessage); 146 | conv.ask(new Suggestions(uniqueCategories)); 147 | }); 148 | }); 149 | 150 | // Start opt-in flow for push notifications 151 | app.intent('setup_push', (conv) => { 152 | conv.ask(new UpdatePermission({intent: TELL_LATEST_TIP_INTENT})); 153 | }); 154 | 155 | // Save intent and user id if user gave consent. 156 | app.intent('finish_push_setup', (conv, params) => { 157 | if (conv.arguments.get('PERMISSION')) { 158 | const userID = conv.arguments.get('UPDATES_USER_ID'); 159 | return db.collection(FirestoreNames.USERS) 160 | .add({ 161 | [FirestoreNames.INTENT]: TELL_LATEST_TIP_INTENT, 162 | [FirestoreNames.USER_ID]: userID, 163 | }) 164 | .then((docRef) => { 165 | conv.close(`Ok, I'll start alerting you.`); 166 | }); 167 | } else { 168 | conv.close(`Ok, I won't alert you.`); 169 | } 170 | }); 171 | 172 | // Start opt-in flow for daily updates 173 | app.intent('setup_update', (conv, params) => { 174 | const category = params[Parameters.CATEGORY]; 175 | conv.ask(new RegisterUpdate({ 176 | intent: 'tell_tip', 177 | arguments: [{name: Parameters.CATEGORY, textValue: category}], 178 | frequency: 'DAILY', 179 | })); 180 | }); 181 | 182 | // Confirm outcome of opt-in for daily updates. 183 | app.intent('finish_update_setup', (conv, params, registered) => { 184 | if (registered && registered.status === 'OK') { 185 | conv.close(`Ok, I'll start giving you daily updates.`); 186 | } else { 187 | conv.close(`Ok, I won't give you daily updates.`); 188 | } 189 | }); 190 | 191 | exports.aogTips = functions.https.onRequest(app); 192 | 193 | /** 194 | * Everytime a tip is added to the Firestore DB, this function runs and sends 195 | * notifications to the subscribed users. 196 | **/ 197 | exports.createTip = functions.firestore 198 | .document(`${FirestoreNames.TIPS}/{tipId}`) 199 | .onCreate((snap, context) => { 200 | const request = require('request'); 201 | const {google} = require('googleapis'); 202 | const serviceAccount = require('./service-account.json'); 203 | const jwtClient = new google.auth.JWT( 204 | serviceAccount.client_email, null, serviceAccount.private_key, 205 | ['https://www.googleapis.com/auth/actions.fulfillment.conversation'], 206 | null 207 | ); 208 | let notification = { 209 | userNotification: { 210 | title: 'AoG tips latest tip', 211 | }, 212 | target: {}, 213 | }; 214 | jwtClient.authorize((err, tokens) => { 215 | if (err) { 216 | throw new Error(`Auth error: ${err}`); 217 | } 218 | db.collection(FirestoreNames.USERS) 219 | .where(FirestoreNames.INTENT, '==', TELL_LATEST_TIP_INTENT) 220 | .get() 221 | .then((querySnapshot) => { 222 | querySnapshot.forEach((user) => { 223 | notification.target = { 224 | userId: user.get(FirestoreNames.USER_ID), 225 | intent: user.get(FirestoreNames.INTENT), 226 | }; 227 | request.post('https://actions.googleapis.com/v2/conversations:send', { 228 | 'auth': { 229 | 'bearer': tokens.access_token, 230 | }, 231 | 'json': true, 232 | 'body': {'customPushMessage': notification, 'isInSandbox': true}, 233 | }, (err, httpResponse, body) => { 234 | if (err) { 235 | throw new Error(`API request error: ${err}`); 236 | } 237 | console.log(`${httpResponse.statusCode}: ` + 238 | `${httpResponse.statusMessage}`); 239 | console.log(JSON.stringify(body)); 240 | }); 241 | }); 242 | }) 243 | .catch((error) => { 244 | throw new Error(`Firestore query error: ${error}`); 245 | }); 246 | }); 247 | return 0; 248 | }); 249 | 250 | // Use this function to restore the content of the tips database. 251 | exports.restoreTipsDB = functions.https.onRequest((request, response) => { 252 | db.collection(FirestoreNames.TIPS) 253 | .get() 254 | .then((querySnapshot) => { 255 | if (querySnapshot.size > 0) { 256 | let batch = db.batch(); 257 | querySnapshot.forEach((doc) => { 258 | batch.delete(doc.ref); 259 | }); 260 | batch.commit() 261 | .then(addTips); 262 | } 263 | }) 264 | .catch((error) => { 265 | throw new Error(`Firestore query error: ${error}`); 266 | }); 267 | addTips(); 268 | 269 | /** 270 | * Add tips 271 | */ 272 | function addTips() { 273 | const tips = require('./tipsDB.json'); 274 | let batch = db.batch(); 275 | let tipsRef = db.collection(FirestoreNames.TIPS); 276 | tips.forEach((tip) => { 277 | let tipRef = tipsRef.doc(); 278 | batch.set(tipRef, tip); 279 | }); 280 | batch.commit() 281 | .then(() => { 282 | response.send(`Tips DB succesfully restored`); 283 | }) 284 | .catch((error) => { 285 | throw new Error(`Error restoring tips DB: ${error}`); 286 | }); 287 | } 288 | }); 289 | -------------------------------------------------------------------------------- /functions/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dialogflow-updates", 3 | "description": "User Engagement Sample Action for the Assistant platform.", 4 | "version": "0.0.1", 5 | "private": true, 6 | "license": "Apache Version 2.0", 7 | "author": "Google Inc.", 8 | "engines": { 9 | "node": "8" 10 | }, 11 | "scripts": { 12 | "lint": "eslint --fix \"**/*.js\"", 13 | "start": "firebase serve --only functions", 14 | "deploy": "firebase deploy --only functions", 15 | "test": "npm run lint" 16 | }, 17 | "dependencies": { 18 | "actions-on-google": "^2.7.0", 19 | "firebase-admin": "^7.2.0", 20 | "firebase-functions": "^2.2.1", 21 | "googleapis": "^39.2.0", 22 | "request": "^2.83.0" 23 | }, 24 | "devDependencies": { 25 | "eslint": "^4.19.1", 26 | "eslint-config-google": "^0.9.1" 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /functions/tipsDB.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "category": "tools", 4 | "url": "https:\/\/www.youtube.com\/watch?v=sjpbu4y6F_M&list=PLOU2XLYxmsILvfJcIASBDbgfxloFz_XsU&index=5", 5 | "tip": "If you don't know how to code, you can use templates to build an App! Learn more about it in our Build an App for the Google Assistant with Templates and No Code video.", 6 | "created_at": "2017-12-25T08:00:00.000Z" 7 | }, 8 | { 9 | "category": "voice user interface", 10 | "url": "https:\/\/developers.google.com\/actions\/assistant\/best-practices", 11 | "created_at": "2017-12-21T08:00:00.000Z", 12 | "tip": "Remember that your users may need your app to repeat itself at any time, so keep track of your last prompt and be prepared to repeat it." 13 | }, 14 | { 15 | "category": "tools", 16 | "url": "https:\/\/github.com\/actions-on-google\/actions-on-google-nodejs", 17 | "tip": "The Actions On Google client library for Dialogflow and Actions SDK is a nodejs module that helps you build your fulfillment whether you're using Dialogflow or the Actions SDK. ", 18 | "created_at": "2017-12-19T08:00:00.000Z" 19 | }, 20 | { 21 | "category": "voice user interface", 22 | "url": "https:\/\/developers.google.com\/actions\/reference\/ssml", 23 | "tip": "Use SSML, or speech synthesis markup language, to improve the quality of your app with features like custom audio and granular speech synthesis controls.", 24 | "created_at": "2017-12-17T08:00:00.000Z" 25 | }, 26 | { 27 | "category": "voice user interface", 28 | "url": "https:\/\/www.youtube.com\/watch?v=cHEahGHseGc&list=PLOU2XLYxmsILvfJcIASBDbgfxloFz_XsU&t=1s&index=4", 29 | "tip": "When designing a voice user interface, you should avoid simply converting a graphical user interface to a voice user interface. Learn more tips about designing VUI watching our \"How to better design VUI for the Google Assistant\" video.", 30 | "created_at": "2017-12-13T08:00:00.000Z" 31 | }, 32 | { 33 | "category": "dialogflow", 34 | "url": "https:\/\/developers.google.com\/actions\/dialogflow\/define-actions#define_additional_actions", 35 | "tip": "If using Dialogflow, you can specify additional actions for your app as additional triggering intents in the Assistant Integrations page. The user says phrases of those triggering intents will also be used for app discovery.", 36 | "created_at": "2017-12-11T08:00:00.000Z" 37 | }, 38 | { 39 | "category": "development", 40 | "url": "https:\/\/developers.google.com\/actions\/reference\/rest\/Shared.Types\/AppRequest#Conversation", 41 | "tip": "Use the data property of our client library interface to persist data within a dialog. It uses the conversation Token field of the conversation API request and response. ", 42 | "created_at": "2017-12-09T08:00:00.000Z" 43 | }, 44 | { 45 | "category": "development", 46 | "url": "https:\/\/www.youtube.com\/watch?v=GKP4AS4L_K8&list=PLOU2XLYxmsILvfJcIASBDbgfxloFz_XsU&t=1s&index=3", 47 | "tip": "The most common cause for app rejection during review is incomplete store listing data. Learn more tips about passing the review in our How to Publish an App for the Google Assistant that Will Pass Review video.", 48 | "created_at": "2017-12-08T08:00:00.000Z" 49 | }, 50 | { 51 | "category": "development", 52 | "url": "https:\/\/developers.google.com\/actions\/assistant\/best-practices", 53 | "tip": "Use the last Seen property of the incoming request to determine return users, and greet them differently than new users.", 54 | "created_at": "2017-12-07T08:00:00.000Z" 55 | }, 56 | { 57 | "category": "dialogflow", 58 | "url": "https:\/\/developers.google.com\/actions\/assistant\/best-practices", 59 | "tip": "If using Dialogflow, provide at least 10-12 examples of User Says phrases for your intents.", 60 | "created_at": "2017-12-06T08:00:00.000Z" 61 | }, 62 | { 63 | "category": "development", 64 | "url": "https:\/\/developers.googleblog.com\/2017\/11\/actions-on-google-best-practices-video.html", 65 | "tip": "You can learn all the best practices for Actions on Google watching videos from the Actions On Google Best Practices Video Series.", 66 | "created_at": "2017-12-05T08:00:00.000Z" 67 | }, 68 | { 69 | "category": "development", 70 | "url": "https:\/\/developers.google.com\/actions\/discovery\/implicit#writing_useful_action_invocation_phrases", 71 | "tip": "When defining action phrases, try to make sure they have a verb and an object to improve the chances for discovery.", 72 | "created_at": "2017-12-04T08:00:00.000Z" 73 | }, 74 | { 75 | "category": "voice user interface", 76 | "url": "https:\/\/developers.google.com\/actions\/assistant\/best-practices", 77 | "tip": "Be prepared to help whenever your user asks for it, and when they do, give them some foothold into the conversation.", 78 | "created_at": "2017-12-03T08:00:00.000Z" 79 | }, 80 | { 81 | "category": "voice user interface", 82 | "url": "https:\/\/developers.google.com\/actions\/assistant\/best-practices", 83 | "tip": "If a user provides some unrecognized input, first try a simple rapid reprompt like \"What was that?\" to keep the conversation moving quickly. As they continue to provide unrecognized input, expand the reprompting to be more clear until finally ending the conversation after 3 failures.", 84 | "created_at": "2017-12-01T08:00:00.000Z" 85 | }, 86 | { 87 | "category": "tools", 88 | "url": "https:\/\/developers.google.com\/actions\/tools\/sound-library\/", 89 | "tip": "Use our sound library to insert custom audio through SSML. This makes your voice experience far more engaging!", 90 | "created_at": "2017-12-02T08:00:00.000Z" 91 | } 92 | ] 93 | --------------------------------------------------------------------------------