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

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

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

בדוגמאות האלה, ה-placeholder 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
        }]
      }]
    }
  }
}