GoogleApp

Search…
GoogleApp
Use this lib to connect BJS with Google App Script​
Getting started
Easy setup
1.Copy this table to your Google account
2.​Deploy as web app
3.Try to open web app via app Public App url​
4.Install GoogleAppLib and WebhooksLib to your bot
5.Create setup command
After this step you can use this Lib and debug.
​
Detail setup
This is detail setup description. Please try to use easy setup before it.
1. Create new App Script project
Go to https://script.google.com and create new project by button:
2. Add Code.gs
Paste the script from above into the script code editor and hit Save.
You will need to contact your Google Apps administrator, or else use a Gmail account.)
​
3. Deploy as web app
Now click Deploy. You may be asked to review permissions now. Project version - always "New".
Cloick in Deploy button. You will have Public App url.
4. Public App URL
The URL that you get will be the webhook that you need use in this Lib. You can test this webhook in your browser first by pasting it. Note that depending on your Google Apps instance, you may need to adjust the URL to make it work. 
5. Add permissions
You need to add permissions​
​
6. Install GoogleAppLib and WebhooksLib to bot
Go to App > Libs and install GoogleAppLib and WebhooksLib 
7. Create setup command:
/setup
1
// replace with your URL, obtained in step 4
2
Libs.GoogleApp.setUrl("https://script.google.com/macros/*******");
Copied!
Using
Use any Google App script in BJS now
1
function GACode(){
2
   // Google App Script code here
3
   // Please note: this function is runs on GA not BB
4
   // ...
5
}
6
​
7
// BJS
8
Libs.GoogleApp.run({
9
  code: GACode, // Function with Google App code
10
  onRun: "onRun", // Optional. This command will be executed after run
11
  email: "[email protected]" // Optional. Email for errors,
12
  // debug: true // For debug. Default is false
13
});
Copied!
Example for command /task
1
function GACode(){
2
  // translation from English to France
3
  var trans = LanguageApp.translate(params, 'en', 'fr');
4
​
5
  // make Google Calendar event
6
  var event = CalendarApp.getDefaultCalendar()
7
    .createEventFromDescription('Lunch with ' + user.first_name + ', Friday at 1PM');
8
  
9
  // send Email
10
  MailApp.sendEmail({
11
    to: "[email protected]",
12
    subject: "hello from bot " + bot.name,
13
    htmlBody: "<h1>Hello!</h1>How are you?<br>" +
14
        "We have message to bot: " + message
15
  });
16
​
17
  // ...
18
  // Use all power of Google App Script!
19
  
20
  // return result as JSON
21
  return { event: event, trans: trans }
22
}
23
​
24
Libs.GoogleApp.run({
25
  code: GACode,
26
  onRun: "onRun",
27
  // email: "[email protected]" // email for errors
28
  // debug: true // default false
29
});
Copied!
You can turn on debug flag with true
Then you can debug code
command onRun
1
Bot.sendMessage(inspect(options))
Copied!
GACode - it is isolated function with Google App code. It can not have BJS code like Bot.sendMessage and etc. Only GA code!
But you can use variables and pass data with options for Bot.run method.
1
let myVar = "will not works";
2
​
3
options.myVar = "will be works";
4
​
5
function GACode(){
6
   // Google App Script code here
7
   // Please note: this function is runs on GA not BB
8
   // ...
9
   
10
   myVar = 5; // Error! myVar is not defined in GA only in BB side
11
   
12
   // this will be works:
13
   let myVar;
14
   myVar = 5;
15
   
16
   Bot.sendMessage("ok")  // Error! It is BJS not GA code!
17
   
18
   let botName = bot.name; // Will be worked
19
   let myVar = options.myVar; // Will be worked
20
}
Copied!
​
Permissions
You need set permissions for Google App Script
Run Libs.GoogleApp.run()in first time. You can have like such error:
Error on Google App script: "Exception"
"The script does not have permission to perform that action. Required permissions: (https://www.googleapis.com/auth/calendar || https://www.googleapis.com/auth/calendar.readonly || https://www.google.com/calendar/feeds)"
If you have such error you need set access rights.
Granting access rights via manifest file
Full help available here. From that help:
​
1.Open the script project.
2.At the left, click Project Settings settings.
3.Select the Show "appsscript.json" manifest file in editor checkbox:
​
At the left, click Editor code.
At the left, click the appsscript.json file.
Locate the top-level field labeled oauthScopes. If it's not present, you can add it.
The oauthScopes field specifies an array of strings. To set the scopes your project uses, replace the contents of this array with the scopes you want it to use. For example:
1
{
2
  "timeZone": "Asia/Tokyo",
3
  "dependencies": {
4
  },
5
  "webapp": {
6
    "access": "ANYONE_ANONYMOUS",
7
    "executeAs": "USER_DEPLOYING"
8
  },
9
  "exceptionLogging": "STACKDRIVER",
10
  "oauthScopes": ["https://www.googleapis.com/auth/script.send_mail",
11
                  "https://www.googleapis.com/auth/script.external_request",
12
                  "https://www.googleapis.com/auth/spreadsheets"],
13
  "runtimeVersion": "V8"
14
}
Copied!
1.​https://www.googleapis.com/auth/script.send_mail", "https://www.googleapis.com/auth/script.external_request - is mandatory scope
2.Save the manifest file using Ctrl+S or the Save file icon in the menu bar.
3.Publish your app again (see step 3)
​
Debugging
Run Libs.GoogleAppLib.runin first time. Then:
go to Google App Script Editor (See step 2)
select "debug" function on Tab
press "Debug" button:
Google app is runs. Bot will sent execution result to you. Also you can receive email with error description.
You can use "debug" function anytime for debugging
​
Also you can open web app by url (see step 5) in incognito mode. And look for any errors. For example we have permission error here:
​
​
Links
​Google App script home page
Google App Script examples - good examples for inspiration
Stack Overflow answers - ask your questions on SO
​Videos -  Check out the Apps Script videos on YouTube
​Reference - The reference documentation provided in this section describes the various Apps Script services and the Apps Script manifest file structure.