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

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

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

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

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

הפעל פונקציה

הבקשה הבאה ב-scripts.run מפעילה פונקציית Apps Script בשם listFolderContent, ומעבירה אותה ב-Drive folderId ומספר שלם 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
        }]
      }]
    }
  }
}