Google Apps Script API, scripts.run वाला ऐसा तरीका उपलब्ध कराता है जो बताए गए Apps Script फ़ंक्शन को रिमोट तरीके से पूरा करता है. कॉल करने के लिए इस्तेमाल किए जाने वाले ऐप्लिकेशन में इस तरीके का इस्तेमाल करके, किसी स्क्रिप्ट प्रोजेक्ट में कहीं से भी फ़ंक्शन चलाया जा सकता है. साथ ही, रिस्पॉन्स पाने के लिए भी ऐसा किया जा सकता है.
ज़रूरी शर्तें
किसी ऐप्लिकेशन को, कॉल करने के लिए scripts.run तरीके का इस्तेमाल करने से पहले, इन ज़रूरी शर्तों को पूरा करना होगा. आपको ये काम ज़रूर करने होंगे:
स्क्रिप्ट प्रोजेक्ट को एपीआई एक्ज़ीक्यूटेबल के तौर पर डिप्लॉय करें. ज़रूरत के हिसाब से प्रोजेक्ट को डिप्लॉय, डिप्लॉय, और फिर से डिप्लॉय किया जा सकता है.
लागू करने के लिए, सही तरीके से स्कोप किया गया OAuth टोकन दें. इस OAuth टोकन में, स्क्रिप्ट के इस्तेमाल किए जाने वाले सभी स्कोप शामिल होने चाहिए. इनमें वे सभी दायरे शामिल नहीं होने चाहिए जिनका इस्तेमाल स्क्रिप्ट फ़ंक्शन में करती है. तरीके के रेफ़रंस में, अनुमति के दायरे की पूरी सूची देखें.
पक्का करें कि स्क्रिप्ट और कॉल करने वाले ऐप्लिकेशन के OAuth2 क्लाइंट का Google Cloud प्रोजेक्ट एक ही हो. क्लाउड प्रोजेक्ट, स्टैंडर्ड Cloud प्रोजेक्ट होना चाहिए; Apps Script प्रोजेक्ट के लिए बनाए गए डिफ़ॉल्ट प्रोजेक्ट ज़रूरत के मुताबिक नहीं होते. Cloud के नए या मौजूदा प्रोजेक्ट को इस्तेमाल किया जा सकता है.
Cloud प्रोजेक्ट में, Google Apps Script API चालू करें.
scripts.run तरीका
scripts.run तरीके को चलाने के लिए, पहचान से जुड़ी अहम जानकारी की ज़रूरत होती है:
- स्क्रिप्ट प्रोजेक्ट का आईडी.
- एक्ज़ीक्यूट करने के लिए, फ़ंक्शन का नाम.
- फ़ंक्शन के लिए ज़रूरी पैरामीटर की सूची (अगर कोई है).
विकल्प के तौर पर, अपनी स्क्रिप्ट को डेवलपमेंट मोड में एक्ज़ीक्यूट करने के लिए, उसे कॉन्फ़िगर किया जा सकता है.
यह मोड, स्क्रिप्ट प्रोजेक्ट के हाल ही में डिप्लॉय किए गए वर्शन के बजाय, हाल ही में सेव किए गए वर्शन के साथ काम करता है. ऐसा करने के लिए,
अनुरोध के मुख्य हिस्से में
devMode बूलियन को
true पर सेट करें. सिर्फ़ स्क्रिप्ट का मालिक ही इसे डेवलपमेंट मोड में चला सकता है.
पैरामीटर डेटा टाइप मैनेज करना
Apps Script API scripts.run का इस्तेमाल करने पर, आम तौर पर Apps Script को फ़ंक्शन पैरामीटर के तौर पर डेटा भेजा जाता है और फ़ंक्शन की रिटर्न वैल्यू के तौर पर डेटा वापस पाया जाता है. एपीआई सिर्फ़ बुनियादी टाइप वाली वैल्यू ले सकता है और दिखा सकता है: स्ट्रिंग, ऐरे, ऑब्जेक्ट, नंबर, और बूलियन. ये
JavaScript के बुनियादी टाइप से मिलते-जुलते हैं. ज़्यादा मुश्किल
Apps Script ऑब्जेक्ट, जैसे कि दस्तावेज़ या Sheets को एपीआई प्रोजेक्ट में या उससे पास नहीं किया जा सकता.
जब आपका कॉलिंग ऐप्लिकेशन किसी खास टाइप की भाषा, जैसे कि Java में लिखा जाता है, तो वह इन बुनियादी टाइप से मेल खाने वाले सामान्य ऑब्जेक्ट की सूची या कलेक्शन के रूप में पैरामीटर पास करता है. कई मामलों में, आसान टाइप के कन्वर्ज़न अपने-आप लागू होने की सुविधा चालू की जा सकती है. उदाहरण के लिए, नंबर पैरामीटर लेने वाले फ़ंक्शन को पैरामीटर के तौर पर, Java Double या Integer या Long ऑब्जेक्ट दिया जा सकता है. इसके लिए, वैल्यू को ज़्यादा हैंडल करने की ज़रूरत नहीं होती.
जब एपीआई, फ़ंक्शन का रिस्पॉन्स देता है, तो आपको अक्सर वापस दी गई वैल्यू को सही टाइप पर कास्ट करना होता है. इसके बाद ही उसे इस्तेमाल किया जा सकता है. यहां JavaScript पर आधारित कुछ उदाहरण दिए गए हैं:
- एपीआई से Java ऐप्लिकेशन में रिस्पॉन्स के तौर पर मिले नंबर,
java.math.BigDecimalऑब्जेक्ट के तौर पर आते हैं. ज़रूरत के हिसाब से, इन्हेंDoublesयाintटाइप में बदलना पड़ सकता है. अगर Apps Script फ़ंक्शन, स्ट्रिंग का कलेक्शन दिखाता है, तो Java ऐप्लिकेशन, रिस्पॉन्स को
List<String>ऑब्जेक्ट में कास्ट करता है:List<String> mylist = (List<String>)(op.getResponse().get("result"));अगर आपको
Bytesका अरे वापस करना है, तो आपके लिए अरे को Apps Script फ़ंक्शन में base64 स्ट्रिंग के तौर पर कोड में बदलना आसान हो सकता है और इसके बजाय उस स्ट्रिंग को लौटाया जा सकता है:return Utilities.base64Encode(myByteArray); // returns a String.
नीचे दिए गए उदाहरण कोड सैंपल में, एपीआई रिस्पॉन्स को समझने के तरीके बताए गए हैं.
सामान्य प्रक्रिया
Apps Script फ़ंक्शन को एक्ज़ीक्यूट करने के लिए, Apps Script API का इस्तेमाल करने की सामान्य प्रोसेस यहां बताई गई है:
पहला चरण: Cloud प्रोजेक्ट को सेट अप करना
आपकी स्क्रिप्ट और कॉल करने के लिए इस्तेमाल किए जाने वाले ऐप्लिकेशन, दोनों को एक ही Cloud प्रोजेक्ट शेयर करना होगा. यह Cloud प्रोजेक्ट, मौजूदा प्रोजेक्ट हो सकता है. इसके अलावा, इस मकसद के लिए बनाया गया नया प्रोजेक्ट भी हो सकता है. Cloud प्रोजेक्ट मिल जाने के बाद, आपको अपने स्क्रिप्ट प्रोजेक्ट का इस्तेमाल करने के लिए उसे बदलना होगा.
दूसरा चरण: स्क्रिप्ट को एपीआई एक्ज़ीक्यूटेबल के तौर पर डिप्लॉय करें
- उन फ़ंक्शन के साथ Apps Script प्रोजेक्ट खोलें जिनका आपको इस्तेमाल करना है.
- सबसे ऊपर दाईं ओर, डिप्लॉय करें > नया डिप्लॉयमेंट पर क्लिक करें.
- इसके बाद खुलने वाले डायलॉग बॉक्स में, डिप्लॉयमेंट टाइप चालू करें
> एपीआई एक्ज़ीक्यूटेबल पर क्लिक करें. - "जिनके पास ऐक्सेस है" ड्रॉप-डाउन मेन्यू में, उन उपयोगकर्ताओं को चुनें जिनके पास Apps Script API का इस्तेमाल करके, स्क्रिप्ट के फ़ंक्शन को कॉल करने की अनुमति है.
- डिप्लॉय करें पर क्लिक करें.
तीसरा चरण: कॉल करने के लिए इस्तेमाल किया जाने वाला ऐप्लिकेशन कॉन्फ़िगर करना
कॉल करने वाले ऐप्लिकेशन को, Apps Script API चालू करना होगा और OAuth क्रेडेंशियल सेट करना होगा. इसके बाद ही इसका इस्तेमाल किया जा सकेगा. ऐसा करने के लिए आपके पास क्लाउड प्रोजेक्ट का ऐक्सेस होना चाहिए.
- वह क्लाउड प्रोजेक्ट कॉन्फ़िगर करें जिसका इस्तेमाल आपके कॉल करने के लिए ऐप्लिकेशन और स्क्रिप्ट कर रहे हैं. इसके लिए, यह तरीका अपनाएं:
- स्क्रिप्ट प्रोजेक्ट खोलें और बाईं ओर मौजूद, खास जानकारी
पर क्लिक करें. - Project Oauth स्कोप में जाकर, उन सभी स्कोप को रिकॉर्ड करें जो स्क्रिप्ट के लिए ज़रूरी हैं.
कॉल करने के लिए इस्तेमाल किए जाने वाले ऐप्लिकेशन कोड में, एपीआई कॉल के लिए स्क्रिप्ट OAuth ऐक्सेस टोकन जनरेट करें. यह कोई ऐसा टोकन नहीं है जिसका इस्तेमाल एपीआई खुद करता है. इसके बजाय, यह ऐसा टोकन है जिसकी स्क्रिप्ट को एक्ज़ीक्यूट करने के लिए ज़रूरत होती है. इसे Cloud प्रोजेक्ट के क्लाइंट आईडी और आपके रिकॉर्ड किए गए स्क्रिप्ट स्कोप का इस्तेमाल करके बनाया जाना चाहिए.
Google क्लाइंट लाइब्रेरी, इस टोकन को बनाने और ऐप्लिकेशन के लिए OAuth को मैनेज करने में काफ़ी मदद कर सकती हैं. आम तौर पर, इसकी मदद से स्क्रिप्ट स्कोप का इस्तेमाल करके हाई-लेवल "क्रेडेंशियल" ऑब्जेक्ट बनाने में मदद मिलती है. स्कोप की सूची से क्रेडेंशियल ऑब्जेक्ट बनाने के उदाहरण के लिए, Apps Script API क्विकस्टार्ट देखें.
चौथा चरण: script.run का अनुरोध करना
कॉल करने के लिए इस्तेमाल किए जाने वाले ऐप्लिकेशन को कॉन्फ़िगर करने के बाद, आपके पास
scripts.run कॉल करने का विकल्प होगा. हर एपीआई कॉल में ये चरण होते हैं:
- स्क्रिप्ट आईडी, फ़ंक्शन का नाम, और किसी भी ज़रूरी पैरामीटर का इस्तेमाल करके, एक एपीआई अनुरोध बनाएं.
scripts.runकॉल करें और हेडर में बनाए गए स्क्रिप्ट OAuth टोकन को शामिल करें (अगरPOSTके बुनियादी अनुरोध का इस्तेमाल किया जा रहा है) या फिर स्क्रिप्ट स्कोप का इस्तेमाल करके बनाए गए क्रेडेंशियल ऑब्जेक्ट का इस्तेमाल करें.- स्क्रिप्ट को स्क्रिप्ट पूरी करने की अनुमति दें. स्क्रिप्ट को पूरा करने में छह मिनट तक लग सकते हैं, इसलिए आपके ऐप्लिकेशन को इसके लिए अनुमति देनी चाहिए.
- पूरा करने के बाद, स्क्रिप्ट फ़ंक्शन कोई वैल्यू दिखा सकता है. एपीआई इसे ऐप्लिकेशन में वापस तब डिलीवर करता है, जब वैल्यू काम करने वाली किसी तरह की हो.
script.run एपीआई कॉल के उदाहरण नीचे दिए गए हैं.
एपीआई अनुरोध के उदाहरण
आगे दिए गए उदाहरणों में बताया गया है कि अलग-अलग भाषाओं में Apps Script API को लागू करने का अनुरोध कैसे किया जाता है. इसमें उपयोगकर्ता की रूट डायरेक्ट्री में मौजूद फ़ोल्डर की सूची प्रिंट करने के लिए Apps Script फ़ंक्शन को कॉल किया जाता है. लागू किए गए फ़ंक्शन वाले Apps Script प्रोजेक्ट का स्क्रिप्ट आईडी, ENTER_YOUR_SCRIPT_ID_HERE के साथ वहां दिखाया जाना चाहिए. उदाहरण, संबंधित भाषाओं के लिए
Google API क्लाइंट लाइब्रेरी पर निर्भर
करते हैं.
टारगेट स्क्रिप्ट
इस स्क्रिप्ट का फ़ंक्शन, Drive API का इस्तेमाल करता है.
स्क्रिप्ट होस्ट करने वाले प्रोजेक्ट में, आपको Drive API चालू करना होगा.
इसके अलावा, कॉल करने वाले ऐप्लिकेशन को OAuth क्रेडेंशियल भेजने होंगे जिनमें नीचे दिए गए Drive के स्कोप को शामिल किया गया हो:
https://www.googleapis.com/auth/drive
उदाहरण के तौर पर दिए गए ऐप्लिकेशन, इस स्कोप का इस्तेमाल करके OAuth के लिए क्रेडेंशियल ऑब्जेक्ट बनाने के लिए, Google क्लाइंट लाइब्रेरी का इस्तेमाल करते हैं.
/**
* Return the set of folder names contained in the user's root folder as an
* object (with folder IDs as keys).
* @return {Object} A set of folder names keyed by folder ID.
*/
function getFoldersUnderRoot() {
const root = DriveApp.getRootFolder();
const folders = root.getFolders();
const folderSet = {};
while (folders.hasNext()) {
const folder = folders.next();
folderSet[folder.getId()] = folder.getName();
}
return folderSet;
}
Java
/**
* Create a HttpRequestInitializer from the given one, except set
* the HTTP read timeout to be longer than the default (to allow
* called scripts time to execute).
*
* @param {HttpRequestInitializer} requestInitializer the initializer
* to copy and adjust; typically a Credential object.
* @return an initializer with an extended read timeout.
*/
private static HttpRequestInitializer setHttpTimeout(
final HttpRequestInitializer requestInitializer) {
return new HttpRequestInitializer() {
@Override
public void initialize(HttpRequest httpRequest) throws IOException {
requestInitializer.initialize(httpRequest);
// This allows the API to call (and avoid timing out on)
// functions that take up to 6 minutes to complete (the maximum
// allowed script run time), plus a little overhead.
httpRequest.setReadTimeout(380000);
}
};
}
/**
* Build and return an authorized Script client service.
*
* @param {Credential} credential an authorized Credential object
* @return an authorized Script client service
*/
public static Script getScriptService() throws IOException {
Credential credential = authorize();
return new Script.Builder(
HTTP_TRANSPORT, JSON_FACTORY, setHttpTimeout(credential))
.setApplicationName(APPLICATION_NAME)
.build();
}
/**
* Interpret an error response returned by the API and return a String
* summary.
*
* @param {Operation} op the Operation returning an error response
* @return summary of error response, or null if Operation returned no
* error
*/
public static String getScriptError(Operation op) {
if (op.getError() == null) {
return null;
}
// Extract the first (and only) set of error details and cast as a Map.
// The values of this map are the script's 'errorMessage' and
// 'errorType', and an array of stack trace elements (which also need to
// be cast as Maps).
Map<String, Object> detail = op.getError().getDetails().get(0);
List<Map<String, Object>> stacktrace =
(List<Map<String, Object>>) detail.get("scriptStackTraceElements");
java.lang.StringBuilder sb =
new StringBuilder("\nScript error message: ");
sb.append(detail.get("errorMessage"));
sb.append("\nScript error type: ");
sb.append(detail.get("errorType"));
if (stacktrace != null) {
// There may not be a stacktrace if the script didn't start
// executing.
sb.append("\nScript error stacktrace:");
for (Map<String, Object> elem : stacktrace) {
sb.append("\n ");
sb.append(elem.get("function"));
sb.append(":");
sb.append(elem.get("lineNumber"));
}
}
sb.append("\n");
return sb.toString();
}
public static void main(String[] args) throws IOException {
// ID of the script to call. Acquire this from the Apps Script editor,
// under Publish > Deploy as API executable.
String scriptId = "ENTER_YOUR_SCRIPT_ID_HERE";
Script service = getScriptService();
// Create an execution request object.
ExecutionRequest request = new ExecutionRequest()
.setFunction("getFoldersUnderRoot");
try {
// Make the API request.
Operation op =
service.scripts().run(scriptId, request).execute();
// Print results of request.
if (op.getError() != null) {
// The API executed, but the script returned an error.
System.out.println(getScriptError(op));
} else {
// The result provided by the API needs to be cast into
// the correct type, based upon what types the Apps
// Script function returns. Here, the function returns
// an Apps Script Object with String keys and values,
// so must be cast into a Java Map (folderSet).
Map<String, String> folderSet =
(Map<String, String>) (op.getResponse().get("result"));
if (folderSet.size() == 0) {
System.out.println("No folders returned!");
} else {
System.out.println("Folders under your root folder:");
for (String id : folderSet.keySet()) {
System.out.printf(
"\t%s (%s)\n", folderSet.get(id), id);
}
}
}
} catch (GoogleJsonResponseException e) {
// The API encountered a problem before the script was called.
e.printStackTrace(System.out);
}
}
JavaScript
/**
* Load the API and make an API call. Display the results on the screen.
*/
function callScriptFunction() {
const scriptId = '<ENTER_YOUR_SCRIPT_ID_HERE>';
// Call the Apps Script API run method
// 'scriptId' is the URL parameter that states what script to run
// 'resource' describes the run request body (with the function name
// to execute)
try {
gapi.client.script.scripts.run({
'scriptId': scriptId,
'resource': {
'function': 'getFoldersUnderRoot',
},
}).then(function(resp) {
const result = resp.result;
if (result.error && result.error.status) {
// The API encountered a problem before the script
// started executing.
appendPre('Error calling API:');
appendPre(JSON.stringify(result, null, 2));
} else if (result.error) {
// The API executed, but the script returned an error.
// Extract the first (and only) set of error details.
// The values of this object are the script's 'errorMessage' and
// 'errorType', and an array of stack trace elements.
const error = result.error.details[0];
appendPre('Script error message: ' + error.errorMessage);
if (error.scriptStackTraceElements) {
// There may not be a stacktrace if the script didn't start
// executing.
appendPre('Script error stacktrace:');
for (let i = 0; i < error.scriptStackTraceElements.length; i++) {
const trace = error.scriptStackTraceElements[i];
appendPre('\t' + trace.function + ':' + trace.lineNumber);
}
}
} else {
// The structure of the result will depend upon what the Apps
// Script function returns. Here, the function returns an Apps
// Script Object with String keys and values, and so the result
// is treated as a JavaScript object (folderSet).
const folderSet = result.response.result;
if (Object.keys(folderSet).length == 0) {
appendPre('No folders returned!');
} else {
appendPre('Folders under your root folder:');
Object.keys(folderSet).forEach(function(id) {
appendPre('\t' + folderSet[id] + ' (' + id + ')');
});
}
}
});
} catch (err) {
document.getElementById('content').innerText = err.message;
return;
}
}
Node.js
/**
* Call an Apps Script function to list the folders in the user's root Drive
* folder.
*
*/
async function callAppsScript() {
const scriptId = '1xGOh6wCm7hlIVSVPKm0y_dL-YqetspS5DEVmMzaxd_6AAvI-_u8DSgBT';
const {GoogleAuth} = require('google-auth-library');
const {google} = require('googleapis');
// Get credentials and build service
// TODO (developer) - Use appropriate auth mechanism for your app
const auth = new GoogleAuth({
scopes: 'https://www.googleapis.com/auth/drive',
});
const script = google.script({version: 'v1', auth});
try {
// Make the API request. The request object is included here as 'resource'.
const resp = await script.scripts.run({
auth: auth,
resource: {
function: 'getFoldersUnderRoot',
},
scriptId: scriptId,
});
if (resp.error) {
// The API executed, but the script returned an error.
// Extract the first (and only) set of error details. The values of this
// object are the script's 'errorMessage' and 'errorType', and an array
// of stack trace elements.
const error = resp.error.details[0];
console.log('Script error message: ' + error.errorMessage);
console.log('Script error stacktrace:');
if (error.scriptStackTraceElements) {
// There may not be a stacktrace if the script didn't start executing.
for (let i = 0; i < error.scriptStackTraceElements.length; i++) {
const trace = error.scriptStackTraceElements[i];
console.log('\t%s: %s', trace.function, trace.lineNumber);
}
}
} else {
// The structure of the result will depend upon what the Apps Script
// function returns. Here, the function returns an Apps Script Object
// with String keys and values, and so the result is treated as a
// Node.js object (folderSet).
const folderSet = resp.response.result;
if (Object.keys(folderSet).length == 0) {
console.log('No folders returned!');
} else {
console.log('Folders under your root folder:');
Object.keys(folderSet).forEach(function(id) {
console.log('\t%s (%s)', folderSet[id], id);
});
}
}
} catch (err) {
// TODO(developer) - Handle error
throw err;
}
}
Python
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
def main():
"""Runs the sample."""
# pylint: disable=maybe-no-member
script_id = "1VFBDoJFy6yb9z7-luOwRv3fCmeNOzILPnR4QVmR0bGJ7gQ3QMPpCW-yt"
creds, _ = google.auth.default()
service = build("script", "v1", credentials=creds)
# Create an execution request object.
request = {"function": "getFoldersUnderRoot"}
try:
# Make the API request.
response = service.scripts().run(scriptId=script_id, body=request).execute()
if "error" in response:
# The API executed, but the script returned an error.
# Extract the first (and only) set of error details. The values of
# this object are the script's 'errorMessage' and 'errorType', and
# a list of stack trace elements.
error = response["error"]["details"][0]
print(f"Script error message: {0}.{format(error['errorMessage'])}")
if "scriptStackTraceElements" in error:
# There may not be a stacktrace if the script didn't start
# executing.
print("Script error stacktrace:")
for trace in error["scriptStackTraceElements"]:
print(f"\t{0}: {1}.{format(trace['function'], trace['lineNumber'])}")
else:
# The structure of the result depends upon what the Apps Script
# function returns. Here, the function returns an Apps Script
# Object with String keys and values, and so the result is
# treated as a Python dictionary (folder_set).
folder_set = response["response"].get("result", {})
if not folder_set:
print("No folders returned!")
else:
print("Folders under your root folder:")
for folder_id, folder in folder_set.items():
print(f"\t{0} ({1}).{format(folder, folder_id)}")
except HttpError as error:
# The API encountered a problem before the script started executing.
print(f"An error occurred: {error}")
print(error.content)
if __name__ == "__main__":
main()
सीमाएं
Apps Script API की कई सीमाएं हैं:
एक सामान्य Cloud प्रोजेक्ट. जिस स्क्रिप्ट को कॉल किया जा रहा है और कॉलिंग ऐप्लिकेशन को एक क्लाउड प्रोजेक्ट शेयर करना होगा. Cloud प्रोजेक्ट, स्टैंडर्ड Cloud प्रोजेक्ट होना चाहिए. Apps Script प्रोजेक्ट के लिए बनाए गए डिफ़ॉल्ट प्रोजेक्ट, काम के नहीं हैं. स्टैंडर्ड Cloud प्रोजेक्ट, कोई नया या मौजूदा प्रोजेक्ट हो सकता है.
बेसिक पैरामीटर और रिटर्न टाइप. एपीआई, ऐप्लिकेशन में Apps Script से जुड़े ऑब्जेक्ट (जैसे कि दस्तावेज़, ब्लॉब, कैलेंडर, Drive की फ़ाइलें वगैरह) पास नहीं कर सकता या वापस नहीं भेज सकता. सिर्फ़ स्ट्रिंग, ऐरे, ऑब्जेक्ट, नंबर, और बूलियन जैसे बेसिक टाइप ही पास किए और लौटाए जा सकते हैं.
OAuth के स्कोप. एपीआई सिर्फ़ उन स्क्रिप्ट को एक्ज़ीक्यूट कर सकता है जिनमें कम से कम एक ज़रूरी स्कोप हो. इसका मतलब है कि ऐसी स्क्रिप्ट को कॉल करने के लिए एपीआई का इस्तेमाल नहीं किया जा सकता जिसे एक या ज़्यादा सेवाओं के अनुमति की ज़रूरत न हो.
कोई ट्रिगर नहीं.API, Apps स्क्रिप्ट ट्रिगर नहीं बना सकता.