Führt eine Funktion in einem Apps Script-Projekt aus. Das Skriptprojekt muss für die Verwendung mit der Apps Script API bereitgestellt werden und die aufrufende Anwendung muss dasselbe Cloud Platform-Projekt verwenden.
Diese Methode erfordert eine Autorisierung mit einem OAuth 2.0-Token, das mindestens einen der im Abschnitt Autorisierung aufgeführten Bereiche enthält. Skriptprojekte, die keine Autorisierung erfordern, können nicht über diese API ausgeführt werden. Um die richtigen Bereiche für das Authentifizierungstoken zu finden, öffnen Sie die Übersichtsseite des Skriptprojekts und scrollen Sie nach unten zu „OAuth-Bereiche des Projekts“.
Der Fehler 403, PERMISSION_DENIED: The caller does not have permission
gibt an, dass das zum Autorisieren der Anfrage verwendete Cloud Platform-Projekt nicht mit dem vom Skript verwendeten Projekt identisch ist.
HTTP-Anfrage
POST https://script.googleapis.com/v1/scripts/{scriptId}:run
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
scriptId |
Die Skript-ID des auszuführenden Skripts. Suchen Sie auf der Seite Projekteinstellungen unter „IDs“ nach der Script-ID. |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "function": string, "parameters": [ value ], "sessionState": string, "devMode": boolean } |
Felder | |
---|---|
function |
Der Name der Funktion, die im gegebenen Skript ausgeführt werden soll. Der Name enthält keine Klammern oder Parameter. Sie kann auf eine Funktion in einer enthaltenen Bibliothek wie |
parameters[] |
Parameter, die an die ausgeführte Funktion übergeben werden sollen. Der Objekttyp für jeden Parameter sollte dem erwarteten Typ in Apps Script entsprechen. Parameter können keine Apps Script-spezifischen Objekttypen wie |
sessionState |
Verworfen. Nur für Android-Add-ons. Eine ID, die die aktuelle Sitzung des Nutzers in der Android-App für Google Docs oder Google Tabellen darstellt. Diese ID ist als zusätzliche Daten im Intent enthalten, mit dem das Add-on gestartet wird. Wenn ein Android-Add-on mit einem Sitzungsstatus ausgeführt wird, erhält es die Berechtigungen eines gebundenen Skripts, d. h., es kann auf Informationen wie die aktuelle Cursorposition des Nutzers (in Docs) oder die ausgewählte Zelle (in Google Tabellen) zugreifen. Rufen Sie |
devMode |
Wenn |
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Darstellung einer Ausführung einer Apps Script-Funktion, die mit run
gestartet wurde. Die Ausführungsantwort kommt erst an, wenn die Ausführung der Funktion abgeschlossen ist. Die maximale Ausführungslaufzeit finden Sie im englischsprachigen Leitfaden zu Apps Script-Kontingenten.
Nachdem die Ausführung gestartet wurde, kann es zu einem der folgenden vier Ergebnisse kommen:
- Wenn die Skriptfunktion erfolgreich zurückgegeben wird, enthält das Feld
response
einExecutionResponse
-Objekt mit dem Rückgabewert der Funktion im Feldresult
des Objekts. - Wenn die Skriptfunktion (oder Apps Script selbst) eine Ausnahme auslöst, enthält das Feld
error
einStatus
-Objekt. Das Felddetails
desStatus
-Objekts enthält ein Array mit einem einzelnenExecutionError
-Objekt, das Informationen zur Art des Fehlers liefert. - Wenn die Ausführung noch nicht abgeschlossen ist, hat das Feld
done
den Wertfalse
und die Felderresponse
odererror
sind nicht vorhanden. - Wenn der
run
-Aufruf fehlschlägt (z. B. aufgrund einer falsch formatierten Anfrage oder eines Autorisierungsfehlers), gibt die Methode einen HTTP-Antwortcode im 4XX-Bereich mit einem anderen Format für den Antworttext zurück. Clientbibliotheken wandeln eine 4XX-Antwort automatisch in eine Ausnahmeklasse um.
JSON-Darstellung |
---|
{ "done": boolean, // Union field |
Felder | |
---|---|
done |
In diesem Feld wird angegeben, ob die Skriptausführung abgeschlossen ist. Bei einer abgeschlossenen Ausführung ist das Feld |
Union-Feld result . Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, kann genau entweder error oder response festgelegt werden. Bei einigen Diensten ist das Ergebnis möglicherweise nicht verfügbar. Für result ist nur einer der folgenden Werte zulässig: |
|
error |
Wenn ein |
response |
Wenn die Skriptfunktion erfolgreich zurückgegeben wird, enthält dieses Feld ein Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://apps-apis.google.com/a/feeds
https://apps-apis.google.com/a/feeds/alias/
https://apps-apis.google.com/a/feeds/groups/
https://mail.google.com/
https://sites.google.com/feeds
https://www.google.com/calendar/feeds
https://www.google.com/m8/feeds
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/dynamiccreatives
https://www.googleapis.com/auth/forms
https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/groups
https://www.googleapis.com/auth/script.cpanel
https://www.googleapis.com/auth/script.external_request
https://www.googleapis.com/auth/script.scriptapp
https://www.googleapis.com/auth/script.send_mail
https://www.googleapis.com/auth/script.storage
https://www.googleapis.com/auth/script.webapp.deploy
https://www.googleapis.com/auth/spreadsheets
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/sqlservice
https://www.googleapis.com/auth/userinfo.email
Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
Status
Wenn ein run
-Aufruf erfolgreich ist, aber die Skriptfunktion (oder Apps Script selbst) eine Ausnahme auslöst, enthält das Feld error
des Antworttexts dieses Status
-Objekt.
JSON-Darstellung |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Felder | |
---|---|
code |
Der Statuscode. Für diese API ist dieser Wert entweder:
|
message |
Eine an den Entwickler gerichtete Fehlermeldung, die auf Englisch ist. Jede an den Nutzer gerichtete Fehlermeldung wird lokalisiert und im Feld |
details[] |
Ein Array, das ein einzelnes Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |