tanaikech/ggsrun tanaikech/ggsrun

  • Stars
    star
    117
  • Rank 301,828 (Top 6 %)
  • Language
    Go
  • License
    MIT License
  • Created over 7 years ago
  • Updated over 1 year ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
tanaikech/ggsrun
github

tanaikech

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This is a CLI tool to execute Google Apps Script (GAS) at own terminal on local PC. Also this CLI tool can be used for managing files in Google Drive for OAuth2 and Service Account.

ggsrun

MIT License

Overview

This is a CLI tool to execute Google Apps Script (GAS) on a terminal. Also this CLI tool can be used for managing files in Google Drive for OAuth2 and Service Account.

Demo

Description

Will you want to develop GAS on your local PC? Generally, when we develop GAS, we have to login to Google using own browser and develop it on the Script Editor. Recently, I have wanted to have more convenient local-environment for developing GAS. So I created this "ggsrun". The main work is to execute GAS on local terminal and retrieve the results from Google. Furthermore, this tool can be also used for managing files in own Google Drive (OAuth2) and Google Drive for Service Account.

Features of "ggsrun" are as follows.

  1. Develops GAS using your local terminal and text editor which got accustomed to using.Updated! (v1.4.0)
  2. Executes GAS by giving values to your script.
  3. Executes GAS made of CoffeeScript.
  4. Downloads spreadsheet, document and presentation, while executes GAS, simultaneously.
  5. Downloads files from Google Drive and Uploads files to Google Drive. Updated! (v1.4.1)
  6. Downloads standalone script and bound script. Updated! (v1.4.0)
  7. Downloads all files and folders in a specific folder. Updated! (v1.5.2)
  8. Upload script files and create project as standalone script and container-bound script. Updated! (v1.5.2)
  9. Update project. Updated! (v1.4.0)
  10. Retrieve revision files of Google Docs and retrieve versions of projects. Updated! (v1.4.0)
  11. Rearranges scripts in project. Updated! (v1.4.0)
  12. Modifies Manifests in project.
  13. Seach files in Google Drive using search query and regex Updated! (v1.6.0)
  14. Manage Permissions of files Updated! (v1.7.0)
  15. Get Drive Information. Updated! (v1.7.0)
  16. ggsrun got to be able to be used by not only OAuth2, but also Service Account. Updated! (v1.7.0)

How to Install

December 28, 2021: If you want to simply test ggsrun, you can also use this method.

1. Get ggsrun

Download an executable file of ggsrun from the release page and import to a directory with path.

or

Use go get.

$ go install github.com/tanaikech/ggsrun@latest
  • GO111MODULE=on

Before Basic setting flow

IMPORTANT: Please check this.

At April 8, 2019, the specification of Google Apps Script Project was changed. By this, when new GAS project is created after April 8, 2019, in order to use Goole API (Google Apps Script API and Drive API which can be used by ggsrun.), the GAS project is required to link to Cloud Platform Project. When you use the GAS project creted after April 8, 2019, at first, please do this flow.

After the GAS project was linked to Cloud Platform Project by above flow, please do "Basic setting flow" at the next section.

2. Basic setting flow

When you click each link of title, you can see the detail information.

  1. Setup ggsrun Server (at Google side)
    • Create new project and install the server as a library.
    • Deploy API executable. Choose "Only myself" as "Who has access to the script"
    • Install the server as a library. Script ID of the library is
      • 115-19njNHlbT-NI0hMPDnVO1sdrw2tJKCAJgOTIAPbi_jq3tOo4lVRov
    • After installed the library, please push the save button at the script editor. This is very important! By this, the library is completely reflected.
  2. Get Client ID, Client Secret
    • On the Script Editor
      • Resources -> Cloud Platform Project
      • Click the lower part of "This script is currently associated with project:"
      • In "Getting Started", Click "Enable APIs and get credentials like keys".
      • On "API APIs&services"
      • Click "Credentials" at left side.
      • At "Create Credentials", Click OAuth client ID.
      • Choose Other
      • Input Name (This is a name you want.)
      • done
      • Download a JSON file with Client ID and Client Secret as client_secret.json using download button.
  3. Enable APIs
    • ggsrun uses Google Apps Script API and Drive API. Please enable them at API console. You can directly access them as follows. Project ID can be seen at downloaded client_secret.json.
      • https://console.cloud.google.com/apis/library/script.googleapis.com/?project=### project ID ###
      • https://console.cloud.google.com/apis/api/drive.googleapis.com/?project=### project ID ###
  4. Create configure file for ggsrun
    • Run $ ggsrun auth at the directory with client_secret.json.
  5. Test Run
    • Create a sample script function main(){return Beacon()} as sample.gs.
    • Run $ ggsrun e2 -s sample.gs -i [Script ID] -j. Script ID is ID of the project installed the server.

Congratulation! You got ggsrun!

To users which are using ggsrun with v1.3.4 and/or less Updated! (v1.4.0)

Please reauthorize to include a new scope to the access token as follows.

  1. Confirm whether Google Apps Script API is enabled. You can directly access it as follows. Project ID can be seen at the downloaded client_secret.json.
  2. Add a scope of https://www.googleapis.com/auth/script.projects to ggsrun.cfg.
  3. Run the following command under the directory with client_secret.json and ggsrun.cfg.
    • $ ggsrun auth

Completed!

From version 1.7.0, ggsrun can access to Google Drive using Service Account. Updated! (v1.7.0)

ggsrun can access to Google Drive using Service Account. When OAuth2 is used, you can see the files and folders in own Google Drive. When Service Account is used, you can see them in Google Drive for Service Account. Namely, the Drive for OAuth2 is different from that for Service Account. Please be careful this. And when Service Account is used, there are what it can do and what it can't do. About them, please read here.

How to use ggsrun

  1. Executes GAS and Retrieves Result Values
  2. Executes GAS with Values and Retrieves Feedbacked Values
  3. For Debug
  4. Executes GAS with Values and Downloads File
  5. Executes Existing Functions on Project
  6. Download Files
  7. Downloads all files and folders in a specific folder.
  8. Upload Files
  9. Show File List
  10. Search Files
  11. Update Project
  12. Retrieve Revision Files and Versions of Projects
  13. Rearrange Script in Project
  14. Modify Manifests
  15. Seach Files using Query and Regex
  16. Manage Permissions of files
  17. Get Drive Information.
  18. ggsrun got to be able to be used by not only OAuth2, but also Service Account.

Applications

  1. For Sublime Text
  2. For CoffeeScript
  3. Create Triggers
  4. Link to Python script

Q&A

  1. Authorization for Google Services for your script
  2. In the case that result is "Script Error on GAS side: Insufficient Permission"
  3. In the case that result is "message": "Requested entity was not found."
  4. In the case that result is "Script Error on GAS side: Script has attempted to perform an action that is not allowed when invoked through the Google Apps Script Execution API."
  5. In the case that result is "Missing ';' before statement."
  6. About library
  7. Order of directories for searching

Licence

MIT

Author

Tanaike

If you have any questions and commissions for me, feel free to tell me using e-mail [email protected]

Update History

You can see the Update History at here.

If you want to read the detail manual, please check here.

TOP

More Repositories

1

goodls

This is a CLI tool to download shared files and folders from Google Drive.
Go
388
star
2

taking-advantage-of-google-apps-script

Here, CLI tools, libraries, Add-ons, Reports, Benchmarks and Sample Scripts for taking advantage of Google Apps Script which are publishing in my blog, Gists and GitHub are summarized.
272
star
3

taking-advantage-of-Web-Apps-with-google-apps-script

This is a report to take advantage of Web Apps with Google Apps Script (GAS).
201
star
4

ImgApp

This is a library of image tools for Google Apps Script.
CoffeeScript
110
star
5

ResumableUploadForGoogleDrive_js

This is a Javascript library to achieve the resumable upload for Google Drive.
JavaScript
71
star
6

goris

This is a CLI tool to search for images with Google Reverse Image Search (goris).
Go
68
star
7

Google-Apps-Script-Library-Database

This is for the Google Apps Script Library Database and a web application for searching the libraries..
HTML
57
star
8

RunAll

This is a library for running the concurrent processing using only native Google Apps Script (GAS).
CoffeeScript
55
star
9

FilesApp

FilesApp is a GAS library for retrieving file and folder list in Google Drive using Google Apps Script (GAS). Also this can create a tree from all files and folders in Google Drive.
JavaScript
42
star
10

Resumable_Upload_For_WebApps

This is a sample script for uploading files with large size (> 50 MB) at Web Apps using Google Apps Script (GAS). The resumable upload method is used for uploading files. This script can be also applied to the script using gapi of javascript.
HTML
39
star
11

DownloadLargeFilesByUrl

DownloadLargeFilesByUrl is a GAS library for downloading large files from URL to Google Drive using Google Apps Script (GAS).
JavaScript
38
star
12

GPhotoApp

This is a GAS library for retrieving and creating the albums and media items using Google Photo API using Google Apps Script (GAS).
JavaScript
38
star
13

DocsServiceApp

This is a Google Apps Script library for supporting Document service, Docs API, Spreadsheet service, Sheets API, Slides service and Slides API. The aim of this library is to compensate the processes that they services cannot achieve.
JavaScript
36
star
14

FetchApp

This is a GAS library for creating and requesting the type of multipart/form-data using Google Apps Script. This library enhances Class UelFetchApp of Google Apps Script.
JavaScript
36
star
15

CopyFolder

This is Google Apps Script library for copying folder on Google Drive.
JavaScript
31
star
16

BatchRequest

This is a library for running Batch Requests using Google Apps Script (GAS).
JavaScript
29
star
17

RichTextApp

This is a GAS library for copying the rich text with the text styles from Google Document to Google Spreadsheet or from Google Spreadsheet to Google Document using Google Apps Script (GAS). And, also the rich texts in the cells can be converted to HTML format.
JavaScript
29
star
18

OnedriveApp

This is a library of Google Apps Script for using Microsoft OneDrive.
HTML
25
star
19

HtmlFormApp

This is a Google Apps Script library for parsing the form object from HTML form and appending the submitted values to the Spreadsheet.
JavaScript
25
star
20

AsynchronousResumableUploadForGoogleDrive

This is a sample script for uploading multiple files with large size (> 50 MB) at the sidebar, dialog of Google Docs and Web Apps using the resumable upload of the asynchronous process with Javascript and Google Apps Script (GAS).
HTML
24
star
21

RangeListApp

RangeListApp is a GAS library for retrieving, putting and replacing values for Spreadsheet by a range list with a1Notation using Google Apps Script (GAS).
JavaScript
22
star
22

ManifestsApp

This is a Manifests library for Google Apps Scripts.
JavaScript
22
star
23

gdoctableapppy

This is a python library to manage the tables on Google Document using Google Docs API.
Python
21
star
24

ProjectApp2

This is a GAS project library for Google Apps Script (GAS). This library can be used for the projects of both standalone script type and container-bound script type.
JavaScript
18
star
25

getfilelistpy

This is a python library to retrieve the file list with the folder tree from the specific folder of Google Drive.
Python
18
star
26

go-getfilelist

This is a Golang library to retrieve the file list with the folder tree from the specific folder of Google Drive.
Go
16
star
27

FieldsBuilderForGoogleAPIs

FieldsBuilderForGoogleAPIs is a Web Application for building the fields value for using Google APIs. This is mainly used for developing the scripts for using Google APIs.
JavaScript
12
star
28

UnzipGs

This is a GAS library for unzipping a Zip file protected by a password using Google Apps Script.
JavaScript
12
star
29

GetEditType

GetEditType is a GAS library for retrieving the edit types of the OnEdit event trigger of Spreadsheet using Google Apps Script (GAS).
JavaScript
12
star
30

RearrangeScripts

This is a GAS application for rearranging Google Apps Scripts (GAS) in a project which can be seen at the script editor.
HTML
11
star
31

GetFileList_js

This is a Javascript library to retrieve the file list with the folder tree from the specific folder (publicly shared folders and own folders) of Google Drive.
JavaScript
10
star
32

Creating-PNG-Image-with-Alpha-Channel-using-Google-Apps-Script

This is a sample script for creating a PNG image with the alpha channel using Google Apps Script.
10
star
33

Enhanced-Custom-Function-for-Google-Spreadsheet-using-Web-Apps-as-Wrapper

This is a proposal of the enhanced custom function for Google Spreadsheet using Web Apps as the wrapper.
JavaScript
10
star
34

syncGoogleScriptRun

This is a Javascript library to use "google.script.run" with the synchronous process.
JavaScript
10
star
35

ZipFolder

This is a library for zipping a folder using Google Apps Scripts.
JavaScript
10
star
36

tanaikech.github.io

Blog (my memorandums)
HTML
9
star
37

GmailToList

This is a library for exporting all messages of Gmail as a list using Google Apps Script (GAS).
JavaScript
9
star
38

SOUWA_GAS

GAS library for summing string elements in an array at the high speed
JavaScript
9
star
39

OwnershipTransfer

This is a Google Apps Script library for achieving the ownership-transfer of the specific folder including the files and sub-folders using Drive API.
JavaScript
9
star
40

ProcessApp

This is a library for retrieving the process and information of Google Apps Script. For example, one of methods retrieves the total execution time of all functions executed by the time-driven trigger at owner's account.
JavaScript
9
star
41

DateFinder

DateFinder is a GAS library for searching the date objects from the cell range on the sheet in the Spreadsheet and retrieving the searched range as the RangeList object using Google Apps Script (GAS).
JavaScript
8
star
42

One_Time_Download_for_Google_Drive

This is a sample script for downloading files from Google Drive by the one time download method.
JavaScript
8
star
43

Linking-Google-Cloud-Platform-Project-to-Google-Apps-Script-Project-for-New-IDE

This is the document for linking Google Cloud Platform Project to Google Apps Script Project for New IDE. And also, several sample scripts using Google Apps Script API and Google Photos API are introduced.
8
star
44

node-getfilelist

This is a Node.js module to retrieve the file list with the folder tree from the specific folder of Google Drive.
JavaScript
7
star
45

ShapeApp

This is an add-on application for manipulating shapes on Google Slide. It can create and update shapes by inputting parameters, and can arrange shapes. This is made of Google Apps Scripts (GAS).
HTML
7
star
46

DocNamedRangeApp

This is a Google Apps Script library for managing the named range on Google Documents.
JavaScript
7
star
47

FileTransfer

How to transfer files for Google Drive without authorization.
JavaScript
7
star
48

Managing-A-Lot-Of-Google-Calendar-Events-using-Batch-Requests-with-Google-Apps-Script

These are the sample scripts for managing a lot of Google Calendar Events using the batch requests with Google Apps Script.
JavaScript
7
star
49

Safe-Uploading-for-Google-Drive-by-HTML-in-External-Server-using-Google-Apps-Script

This is a report for safe-uploading files to Google Drive by HTML put in the external server using Google Apps Script.
JavaScript
7
star
50

HtmlFormObjectParserForGoogleAppsScript_js

This is a Javascript library for sending the HTML form object to Google Apps Script using google.script.run.
JavaScript
7
star
51

Batch-Requests-for-Drive-API-using-Google-Apps-Script

These are the sample scripts of the batch requests for Drive API using Google Apps Script.
JavaScript
7
star
52

go-gdoctableapp

This is a Golang library for managing tables on Google Document using Google Docs API.
Go
6
star
53

File_Picker_using_Google_Apps_Script_and_Javascript_without_3rd_party

This is a sample script for the file picker using Google Apps Script and Javascript without 3rd party.
JavaScript
6
star
54

ProjectApp

This is a project library for Google Apps Script (GAS).
JavaScript
6
star
55

GASProjectApp

This is a Google Apps Script library for creating, updating and exporting Google Apps Script project of the standalone type using Drive API. In this case, Apps Script API is not used.
JavaScript
6
star
56

PDFApp

This is a Google Apps Script library for managing PDFs.
JavaScript
5
star
57

SimplePhotoGalleryUsingGoogleAppsScript

This is a sample script for achieving a simple photo gallery created by Google Slides and Web Apps using Google Apps Script.
HTML
5
star
58

FileUploadBydoPost_GAS

GAS and HTML for file Upload From HTML Form on local PC Using doPost()
HTML
5
star
59

getSpreadsheetByRange

This is a simple way for retrieving Spreadsheet ID from a range. As an application, we introduce the enhanced copyTo() which can copy from a range to other Spreadsheet.
5
star
60

GetAccessTokenFromServiceAccount_js

This is a Javascript library to retrieve the access token from the Google Service Account.
JavaScript
4
star
61

UtlApp

This is a Google Apps Script library including useful scripts for supporting to development of applications by Google Apps Script.
JavaScript
4
star
62

getcode

This is a Golang library to automatically get an authorization code for retrieving access token using OAuth2.
Go
4
star
63

RichTextAssistant

This is a GAS library for supporting editing RichText in Google Spreadsheet using Google Apps Script.
JavaScript
3
star
64

CropImageByBorder_js

This is a Javascript library for cropping images by the border.
JavaScript
3
star
65

tarUnarchiver-for-Google-Apps-Script

This is a script for extracting files from a tar file using Google Apps Script. This script was created by native Google Apps Script.
JavaScript
3
star
66

ArrangeStackingOrder

ArrangeStackingOrder is a GAS library for arranging the stacking order of page elements on Google Slides using Google Apps Script (GAS).
JavaScript
3
star
67

Notifying-Comments-at-Stackoverflow-by-Email

This is a script for sending an email when users got comments at Stackoverflow.
JavaScript
2
star
68

gislacks

This is a plugin of Sublime Text 3 for submitting files to both Gist and Slack.
Python
2
star
69

BatchRequest_js

This is a library for running Batch Requests for Google APIs using Javascript.
JavaScript
2
star
70

node-gdoctableapp

This is a Node.js module to manage the tables on Google Document using Google Docs API.
JavaScript
2
star
71

go-gettokenbyserviceaccount

This is a Golang library to retrieve access token from Service Account of Google without using Google's OAuth2 package.
Go
2
star
72

node-gbatchrequests

This is a Node.js module to run the batch requests of Google APIs.
JavaScript
2
star
73

GistChecker

This is a GAS library for notifying the change of number of comments, stars and forks of own Gists as an email using Google Apps Script.
JavaScript
2
star
74

image-storage

HTML
2
star
75

CreateImg

This Google Apps Script (GAS) library creates an image file from coordinate data.
JavaScript
2
star
76

gogauth

This is a CLI tool to easily retrieve access token for using APIs on Google.
Go
2
star
77

ConvertNFDtoNFC

This is a script for converting strings from NFD (Normalization Form Decomposition) to NFC (Normalization Form Composition) using Google Apps Script.
JavaScript
2
star
78

souwapy

Python library for summing string elements in an array at the high speed
Python
1
star
79

cui4netatmo

DOS batch file and UNIX shell script and one liner curl code for retrieving data from Netatmo
Batchfile
1
star
80

go-rearrange

This is a Golang library to interactively rearrange a text data on a terminal.
Go
1
star
81

Flexible-Labeling-for-Gmail-using-Gemini-API-with-Google-Apps-Script-Part-3

This report improves Gmail email labeling with Gemini API using JSON schema and leverages advancements in Gemini 1.5 Flash for faster processing.
JavaScript
1
star
82

gislack

This is a CLI tool to submit files to both Gist and Slack.
Go
1
star
83

gorearrange

This is a CLI tool to interactively rearrange a text data on a terminal.
Go
1
star
84

gonetatmo

This is a CLI tool to retrieve data from a personal weather station of Netatmo.
Go
1
star
85

Processing-Various-Types-of-Invoices-using-Gemini-1.5-API-with-Google-Apps-Script

This repository is for Parsing Invoices using Gemini 1.5 API with Google Apps Script.
JavaScript
1
star
86

TemplateApp

This is a Google Apps Script library for easily managing the template of Google Documents and Google Slides using Google Spreadsheet as a database using Google Apps Script.
JavaScript
1
star