ביצוע פונקציות ב-Apps Script

Apps Script API (לשעבר Apps Script Execution API) מאפשר להריץ מרחוק פונקציה בפרויקט סקריפט שיש לכם גישה אליו. האפליקציה יכולה לקרוא לפונקציה מסוימת של Apps Script, לספק לה פרמטרים של קלט לפי הצורך ולקבל תשובה חזרה.

בדוגמאות שבדף הזה מוסבר איך לבצע פעולות נפוצות של ביצוע באמצעות ה-API. מידע נוסף כולל דרישות אישור מיוחדות זמין במדריך הפעלת פונקציה.

בדוגמאות האלה, התו scriptId משמש לציון המיקום שבו צריך לציין את מזהה הפרויקט של הסקריפט. כדי למצוא את מזהה הסקריפט:

1. בפרויקט ב-Apps Script, לוחצים על הגדרות הפרויקט בפינה הימנית העליונה.
2. לוחצים על העתקה לצד 'מזהה סקריפט'.

הפעל פונקציה

הבקשה הבאה של scripts.run מפעילה פונקציית Apps Script בשם listFolderContent, ומעבירה לה את folderId ב-Drive ואת המספר השלם MAX_SIZE כארגומנטים. הפונקציה מופעלת במצב פיתוח, כלומר הגרסה האחרונה של הפונקציה ששמורה מופעלת, ללא קשר לגרסה שפורסה כקובץ הפעלה.

פרוטוקול הבקשה מוצג בהמשך. במדריך הפעלת פונקציות מוסבר איך להטמיע בקשת הפעלה בשפות שונות באמצעות ספריות הלקוח של Google API.

POST https://script.googleapis.com/v1/scripts/scriptId:run

{
  "function": "listFolderContent",
  "parameters": [
    folderId,
    MAX_SIZE
  ],
  "devMode": true
}

התגובה לבקשה הזו, אחרי שהפעלת הפונקציה ב-Apps Script מסתיימת, מכילה את תוצאות הביצוע או הודעת שגיאה. בדוגמה הזו, הפונקציה מחזירה מערך של שמות קבצים:

{
  "response": {
    "result": [
      "fileTitle1",
      "fileTitle2",
      "fileTitle3"
    ]
  },
}

אם הפונקציה נתקלה בשגיאה במהלך ביצוע ה-Apps Script, התגובה עשויה להיראות כך:

{
  "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
        }]
      }]
    }
  }
}