Die Google Apps Script API bietet die Methode scripts.run, mit der eine bestimmte Apps Script-Funktion remote ausgeführt wird. Sie können diese Methode in einer aufrufenden Anwendung verwenden, um eine Funktion in einem Ihrer Skriptprojekte remote auszuführen und eine Antwort zu erhalten.
Voraussetzungen
Damit eine Anrufanwendung die Methode scripts.run verwenden kann, müssen die folgenden Anforderungen erfüllt sein. Sie müssen:
Stellen Sie das Skriptprojekt als ausführbare API bereit. Sie können Projekte nach Bedarf bereitstellen, die Bereitstellung aufheben und sie noch einmal bereitstellen.
Stellen Sie ein OAuth-Token mit dem richtigen Bereich für die Ausführung bereit. Dieses OAuth-Token muss alle vom Script verwendeten Bereiche abdecken, nicht nur die von der aufgerufenen Funktion verwendeten. Eine vollständige Liste der Autorisierungsbereiche finden Sie in der Methodenreferenz.
Achten Sie darauf, dass das Skript und der OAuth2-Client der aufrufenden Anwendung dasselbe Google Cloud-Projekt verwenden. Das Cloud-Projekt muss ein Standard-Cloud-Projekt sein. Standardprojekte, die für Apps Script-Projekte erstellt wurden, reichen nicht aus. Sie können ein neues Standard-Cloud-Projekt oder ein vorhandenes verwenden.
Aktivieren Sie die Google Apps Script API im Cloud-Projekt.
Die Methode scripts.run
Für die Ausführung der Methode scripts.run sind wichtige Identifikationsinformationen erforderlich:
- Die ID des Skriptprojekts.
- Der Name der auszuführenden Funktion.
- Die Liste der Parameter, die für die Funktion erforderlich sind (falls vorhanden).
Optional können Sie Ihr Skript so konfigurieren, dass es im Entwicklermodus ausgeführt wird.
In diesem Modus wird die zuletzt gespeicherte Version des Skriptprojekts und nicht die zuletzt bereitgestellte Version ausgeführt. Dazu setzen Sie den booleschen Wert devMode im Anfragetext auf true. Nur der Inhaber des Skripts kann es im Entwicklermodus ausführen.
Parameterdatentypen verarbeiten
Bei der Verwendung der Apps Script API-Methode scripts.run werden in der Regel Daten als Funktionsparameter an Apps Script gesendet und Daten als Funktionsrückgabewerte zurückgegeben. Die API kann nur Werte mit einfachen Typen annehmen und zurückgeben: Strings, Arrays, Objekte, Zahlen und boolesche Werte. Sie ähneln den grundlegenden Typen in JavaScript. Komplexere Apps Script-Objekte wie Document oder Sheet können nicht über die API an das Scriptprojekt übergeben oder daraus abgerufen werden.
Wenn Ihre Anrufanwendung in einer stark typisierten Sprache wie Java geschrieben ist, werden Parameter als Liste oder Array generischer Objekte übergeben, die diesen grundlegenden Typen entsprechen. In vielen Fällen können Sie einfache Typkonvertierungen automatisch anwenden. Einer Funktion, die einen Zahlenparameter akzeptiert, kann beispielsweise ohne zusätzliche Verarbeitung ein Java-Objekt vom Typ Double, Integer oder Long als Parameter übergeben werden.
Wenn die API die Funktionsantwort zurückgibt, müssen Sie den zurückgegebenen Wert häufig in den richtigen Typ umwandeln, bevor er verwendet werden kann. Hier sind einige Java-basierte Beispiele:
- Von der API an eine Java-Anwendung zurückgegebene Zahlen werden als
java.math.BigDecimal-Objekte empfangen und müssen bei Bedarf in die TypenDoublesoderintkonvertiert werden. Wenn die Apps Script-Funktion ein Array von Strings zurückgibt, wandelt eine Java-Anwendung die Antwort in ein
List<String>-Objekt um:List<String> mylist = (List<String>)(op.getResponse().get("result"));Wenn Sie ein Array von
Byteszurückgeben möchten, können Sie das Array als Base64-String in der Apps Script-Funktion codieren und diesen String zurückgeben:return Utilities.base64Encode(myByteArray); // returns a String.
Die Beispielcode-Snippets unten veranschaulichen, wie die API-Antwort interpretiert werden kann.
Allgemeines Verfahren
Im Folgenden wird die allgemeine Vorgehensweise für die Ausführung von Apps Script-Funktionen mit der Apps Script API beschrieben:
Schritt 1: Gemeinsames Cloud-Projekt einrichten
Ihr Skript und die aufrufende Anwendung müssen dasselbe Cloud-Projekt verwenden. Dieses Cloud-Projekt kann ein vorhandenes Projekt oder ein neues Projekt sein, das für diesen Zweck erstellt wurde. Sobald Sie ein Cloud-Projekt haben, müssen Sie Ihr Skriptprojekt so umstellen, dass es dieses Projekt verwendet.
Schritt 2: Skript als ausführbare API bereitstellen
- Öffnen Sie das Apps Script-Projekt mit den Funktionen, die Sie verwenden möchten.
- Klicken Sie rechts oben auf Bereitstellen > Neue Bereitstellung.
- Klicken Sie im Dialogfeld, das geöffnet wird, auf „Bereitstellungstypen aktivieren“
> API-Ausführbare Datei. - Wählen Sie im Drop-down-Menü „Wer hat Zugriff?“ die Nutzer aus, die die Funktionen des Skripts über die Apps Script API aufrufen dürfen.
- Klicken Sie auf Bereitstellen.
Schritt 3: Anrufanwendung konfigurieren
Die aufrufende Anwendung muss die Apps Script API aktivieren und OAuth-Anmeldedaten einrichten, bevor sie verwendet werden kann. Dazu benötigen Sie Zugriff auf das Cloud-Projekt.
- Konfigurieren Sie das Cloud-Projekt, das von Ihrer aufrufenden Anwendung und Ihrem Skript verwendet wird. So gehts:
- Öffnen Sie das Skriptprojekt und klicken Sie links auf Übersicht
. - Notieren Sie unter Project Oauth scopes (OAuth-Bereiche für das Projekt) alle Bereiche, die für das Skript erforderlich sind.
Generieren Sie im Code der aufrufenden Anwendung ein OAuth-Zugriffstoken für das Skript für den API-Aufruf. Dies ist kein Token, das von der API selbst verwendet wird, sondern eines, das das Skript für die Ausführung benötigt. Sie sollte mit der Client-ID des Cloud-Projekts und den von Ihnen aufgezeichneten Scriptbereichen erstellt werden.
Die Google-Clientbibliotheken können Sie beim Erstellen dieses Tokens und bei der Verarbeitung von OAuth für die Anwendung unterstützen. In der Regel können Sie stattdessen ein Objekt auf höherer Ebene mit Anmeldedaten erstellen, indem Sie die Skriptbereiche verwenden. In den Apps Script API-Schnellstarts finden Sie Beispiele für das Erstellen eines Anmeldedatenobjekts aus einer Liste von Bereichen.
Schritt 4: script.run-Anfrage stellen
Sobald die Anrufanwendung konfiguriert ist, können Sie scripts.run-Anrufe starten. Jeder API-Aufruf besteht aus den folgenden Schritten:
- Erstellen Sie eine API-Anfrage mit der Skript-ID, dem Funktionsnamen und allen erforderlichen Parametern.
- Führen Sie den
scripts.run-Aufruf aus und fügen Sie das von Ihnen erstellte OAuth-Token für das Skript in den Header ein (wenn Sie eine einfachePOST-Anfrage verwenden). Andernfalls verwenden Sie ein Anmeldedatenobjekt, das Sie mit den Skriptbereichen erstellt haben. - Warten Sie, bis das Skript ausgeführt wurde. Skripts dürfen bis zu sechs Minuten lang ausgeführt werden. Ihre Anwendung sollte dies berücksichtigen.
- Nach Abschluss kann die Skriptfunktion einen Wert zurückgeben, den die API an die Anwendung zurückgibt, wenn der Wert ein unterstützter Typ ist.
Beispiele für script.run-API-Aufrufe finden Sie unten.
Beispiele für API-Anfragen
In den folgenden Beispielen wird gezeigt, wie Sie in verschiedenen Sprachen eine Ausführungsanfrage für die Apps Script API stellen, um eine Apps Script-Funktion aufzurufen, die eine Liste der Ordner im Stammverzeichnis des Nutzers ausgibt. Die Script-ID des Apps Script-Projekts, das die ausgeführte Funktion enthält, muss an der Stelle angegeben werden, die mit ENTER_YOUR_SCRIPT_ID_HERE gekennzeichnet ist. Die Beispiele basieren auf den Google API-Clientbibliotheken für die jeweilige Sprache.
Zielskript
Die Funktion in diesem Script verwendet die Drive API.
Sie müssen die Drive API in dem Projekt aktivieren, in dem das Skript gehostet wird.
Außerdem müssen Anrufanwendungen OAuth-Anmeldedaten senden, die den folgenden Drive-Bereich enthalten:
https://www.googleapis.com/auth/drive
In den Beispielanwendungen hier werden die Google-Clientbibliotheken verwendet, um Anmeldedatenobjekte für OAuth mit diesem Bereich zu erstellen.
/**
* 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()
Beschränkungen
Die Apps Script API unterliegt einigen Einschränkungen:
Ein gemeinsames Cloud-Projekt Das aufgerufene Skript und die aufrufende Anwendung müssen dasselbe Cloud-Projekt verwenden. Das Cloud-Projekt muss ein Standard-Cloud-Projekt sein. Standardprojekte, die für Apps Script-Projekte erstellt wurden, reichen nicht aus. Das Standard-Cloud-Projekt kann ein neues oder ein vorhandenes Projekt sein.
Einfache Parameter- und Rückgabetypen Die API kann keine Apps Script-spezifischen Objekte (z. B. Dokumente, Blobs, Kalender, Drive-Dateien usw.) an die Anwendung übergeben oder zurückgeben. Es können nur einfache Typen wie Strings, Arrays, Objekte, Zahlen und boolesche Werte übergeben und zurückgegeben werden.
OAuth-Bereiche. Über die API können nur Skripts ausgeführt werden, die mindestens einen erforderlichen Bereich haben. Das bedeutet, dass Sie die API nicht verwenden können, um ein Skript aufzurufen, für das keine Autorisierung für einen oder mehrere Dienste erforderlich ist.
Keine Trigger: Mit der API können keine Apps Script-Trigger erstellt werden.