管理專案

本節將概略說明可用來建立、讀取、修改及監控 Apps Script 專案的 Apps Script API 方法。「Project Management」範例頁面會顯示 API 管理要求的範例。每個方法的參考說明文件會提供實作詳細資訊。

API 方法總覽
建立專案

projects.create

結果:建立基本空白專案,其中沒有專案檔案和預設的專案資訊清單

選項:您可以提供專案名稱。您也可以提供 Google 文件、試算表、表單或簡報檔案的 Google 雲端硬碟 ID,讓系統以此做為指令碼的父項,藉此建立繫結指令碼

讀取專案中繼資料

projects.get

結果:擷取 Project 物件,代表專案中繼資料。這類資料包括專案名稱、指令碼 ID、建立使用者、建立時間和其他詳細資料。

閱讀專案內容

projects.getContent

結果:傳回 File 物件的陣列,每個專案中的程式碼和 HTML 檔案各一個。清單中也會包含專案資訊清單,做為 JSON 檔案。檔案物件包含檔案的來源內容 (File.source) 和其他中繼資料,例如檔案中的函式清單 (File.functionSet)。

選項:您可以使用查詢參數指定要擷取的內容版本

更新專案內容

projects.updateContent

結果:變更劇本專案中的檔案內容。 您可以以 File 物件的陣列形式提供新內容。其中一個 File 物件必須具有 JSON 類型,並代表指令碼專案的新專案資訊清單。新內容會儲存為專案的 HEAD 版本。當指令碼以觸發事件執行時,在指令碼編輯器、外掛程式預覽模式,或以網頁應用程式或 Apps Script API 開發模式執行時,就會使用此屬性。

注意:更新指令碼專案內容時,一般做法是先發出 projects.getContent 要求,擷取現有 File 的陣列,然後對這些物件提出需求,再將 File 用做 projects.updateContent 要求的輸入內容。

警告:新內容會取代指令碼專案中的所有現有檔案。系統會移除未經要求更新的檔案。

讀取專案指標

projects.getMetrics

結果:讀取專案的特定指標。 這些指標包括使用者人數、執行次數總數、執行錯誤總數和其他詳細資料。使用 MetricType 指定您要要求的資訊。

選項:使用 MetricsFilter 將結果限制為特定部署或指令碼函式。您也可以使用 MetricsIntervalConfig 定義特定指標間隔。