Mit der Apps Script API (früher Apps Script Execution API) können Sie eine Funktion in einem Scriptprojekt, auf das Sie Zugriff haben, aus der Ferne ausführen. Ihre App kann eine bestimmte Apps Script-Funktion aufrufen und bei Bedarf Eingabeparameter angeben, um eine Antwort zu erhalten.
Die Beispiele auf dieser Seite veranschaulichen, wie einige gängige Ausführungsvorgänge mit der API ausgeführt werden können. Weitere Informationen einschließlich spezieller Autorisierungsanforderungen finden Sie im Leitfaden Funktion ausführen.
In diesen Beispielen gibt der Platzhalter scriptId an, wo Sie die Script-Projekt-ID angeben würden. So finden Sie die Script-ID:
- Klicken Sie im Apps Script-Projekt links oben auf Projekteinstellungen .
- Klicken Sie neben „Script-ID“ auf Kopieren.
Funktion ausführen
Die folgende scripts.run-Anfrage ruft eine Apps Script-Funktion namens listFolderContent auf und übergibt ihr die Drive-Ressource folderId und eine Ganzzahl MAX_SIZE als Argumente. Die Funktion wird im Entwicklungsmodus ausgeführt. Das bedeutet, dass die zuletzt gespeicherte Version der Funktion ausgeführt wird, unabhängig davon, welche Version als ausführbares Programm bereitgestellt wird.
Das Anfrageprotokoll ist unten dargestellt. Im Leitfaden Ausführen von Funktionen wird beschrieben, wie Sie mithilfe der Google API-Clientbibliotheken eine Ausführungsanfrage in verschiedenen Sprachen implementieren.
POST https://script.googleapis.com/v1/scripts/scriptId :run
{
"function": "listFolderContent",
"parameters": [
folderId ,
MAX_SIZE
],
"devMode": true
}Die Antwort auf diese Anfrage enthält nach Abschluss der aufgerufenen Apps Script-Funktion die Ergebnisse der Ausführung oder eine Fehlerantwort. In diesem Beispiel gibt die Funktion ein Array mit Dateinamen zurück:
{
"response": {
"result": [
"fileTitle1",
"fileTitle2",
"fileTitle3"
]
},
}Wenn bei der Ausführung des Apps Script-Scripts ein Fehler auftritt, könnte die Antwort so aussehen:
{ "response": { "error": { "code": 3, "message": "ScriptError", "details": [{ "@type": "type.googleapis.com/google.apps.script.v1.ExecutionError", "errorMessage": "The script enountered an exeception it could not resolve.", "errorType": "ScriptError", "scriptStackTraceElements": [{ "function": "listFolderContent", "lineNumber": 14 }] }] } } }