管理專案

本節提供 Apps Script API 方法總覽,讓您用來建立、讀取、修改及監控 Apps Script 專案。專案管理範例頁面會顯示 API 管理要求的範例。每個方法的參考說明文件都會詳細說明實作方式。

API 方法總覽
建立專案

projects.create

結果:建立不含專案檔案的基本空白專案,以及預設的專案資訊清單

選項:您可以提供專案名稱。您也可以提供 Google 文件、Google 試算表、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 定義特定指標間隔。