הפעלה של פונקציות Google Apps Script

‫Google Apps Script API מאפשר לכם להריץ מרחוק פונקציה בפרויקט סקריפט שיש לכם גישה אליו. האפליקציה יכולה לקרוא לפונקציה מסוימת של Apps Script, לספק לה פרמטרים של קלט אם צריך ולקבל תגובה.

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

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

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

הפעל פונקציה

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

פרוטוקול הבקשה מוצג בהמשך. במדריך Execute functions מוסבר איך להטמיע בקשת הפעלה בשפות שונות באמצעות ספריות הלקוח של 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
        }]
      }]
    }
  }
}