Mengeksekusi Fungsi Apps Script

Apps Script API (dan sebelumnya Apps Script Execution API) memungkinkan Anda menjalankan fungsi dari jarak jauh dalam project skrip yang dapat Anda akses. Aplikasi Anda dapat memanggil fungsi Apps Script tertentu, dengan memberikan parameter input jika diperlukan, dan menerima respons yang ditampilkan.

Contoh di halaman ini menggambarkan bagaimana beberapa operasi eksekusi umum dapat dilakukan dengan API. Untuk mengetahui informasi selengkapnya termasuk persyaratan otorisasi khusus, lihat panduan Menjalankan fungsi.

Dalam contoh ini, placeholder scriptId digunakan untuk menunjukkan tempat Anda memberikan project ID skrip. Ikuti langkah-langkah berikut untuk menemukan ID skrip:

  1. Pada project Apps Script, di kiri atas, klik Setelan Project .
  2. Di samping "ID Skrip", klik Salin.

Jalankan fungsi

Permintaan scripts.run berikut memanggil fungsi Apps Script bernama listFolderContent, yang meneruskan folderId Drive dan bilangan bulat MAX_SIZE sebagai argumen. Fungsi ini dijalankan dalam mode pengembangan, yang berarti versi penyimpanan fungsi yang terakhir akan dijalankan, apa pun versi yang di-deploy sebagai file yang dapat dieksekusi.

Protokol permintaan ditampilkan di bawah ini. Panduan Mengeksekusi fungsi menunjukkan cara mengimplementasikan permintaan pengoperasian dalam berbagai bahasa menggunakan library klien Google API.

POST https://script.googleapis.com/v1/scripts/scriptId:run
{
  "function": "listFolderContent",
  "parameters": [
    folderId,
    MAX_SIZE
  ],
  "devMode": true
}

Respons terhadap permintaan ini, setelah fungsi Apps Script yang dipanggil selesai, berisi hasil eksekusi atau respons error. Dalam contoh ini, fungsi berhasil menampilkan array nama file:

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

Jika fungsi mengalami error selama eksekusi Apps Script, responsnya dapat terlihat seperti ini:

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