gws-classroom

classroom (v1)

前置需求： 請先閱讀 ../gws-shared/SKILL.md 以了解驗證、全域旗標與安全規則。若缺少該檔案，請執行 gws generate-skills 來建立。

gws classroom <resource> <method> [flags]

API 資源

courses

• create — 建立課程。在 ownerId 中指定的使用者即為所建立課程的擁有者，並會以教師身分加入。非管理員的請求使用者只能建立以自己為擁有者的課程。網域管理員可以建立由其所屬網域內任何使用者擁有的課程。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權建立課程，或發生存取錯誤。* NOT_FOUND：如果主要教師不是有效的使用者。
• delete — 刪除課程。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權刪除要求的課程，或發生存取錯誤。* NOT_FOUND：如果沒有課程存在於要求的 ID。
• get — 傳回課程。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權存取要求的課程，或發生存取錯誤。* NOT_FOUND：如果沒有課程存在於要求的 ID。
• getGradingPeriodSettings — 傳回課程中的評分期間設定。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權存取要求課程中的評分期間設定，或發生存取錯誤。* NOT_FOUND：如果要求的課程不存在。
• list — 傳回請求使用者有權檢視的課程清單，且僅限於符合請求條件的課程。傳回的課程會依建立時間排序，最近建立的優先顯示。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：發生存取錯誤。* INVALID_ARGUMENT：如果查詢引數格式錯誤。* NOT_FOUND：如果查詢引數中指定的任何使用者不存在。
• patch — 更新課程中的一個或多個欄位。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權修改要求的課程，或發生存取錯誤。* NOT_FOUND：如果沒有課程存在於要求的 ID。* INVALID_ARGUMENT：如果更新遮罩中指定了無效的欄位，或未提供更新遮罩。
• update — 更新課程。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權修改要求的課程，或發生存取錯誤。* NOT_FOUND：如果沒有課程存在於要求的 ID。* FAILED_PRECONDITION：針對下列請求錯誤：* CourseNotModifiable * CourseTitleCannotContainUrl
• updateGradingPeriodSettings — 更新課程的評分期間設定。可以使用此方法新增、移除或修改個別評分期間。請求使用者和課程擁有者必須符合修改評分期間的資格。詳情請參閱授權需求。
• aliases — 對 'aliases' 資源的操作
• announcements — 對 'announcements' 資源的操作
• courseWork — 對 'courseWork' 資源的操作
• courseWorkMaterials — 對 'courseWorkMaterials' 資源的操作
• posts — 對 'posts' 資源的操作
• studentGroups — 對 'studentGroups' 資源的操作
• students — 對 'students' 資源的操作
• teachers — 對 'teachers' 資源的操作
• topics — 對 'topics' 資源的操作

invitations

• accept — 接受邀請，移除該邀請並將受邀使用者加入指定課程的教師或學生（視情況而定）。只有受邀使用者可以接受邀請。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權接受要求的邀請，或發生存取錯誤。
• create — 建立邀請。同一位使用者和課程之間只能存在一個邀請。若要進行變更，請刪除並重新建立邀請。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權為此課程建立邀請，或發生存取錯誤。* NOT_FOUND：如果課程或使用者不存在。* FAILED_PRECONDITION：* 如果要求的使用者帳戶已停用。
• delete — 刪除邀請。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權刪除要求的邀請，或發生存取錯誤。* NOT_FOUND：如果沒有邀請存在於要求的 ID。
• get — 傳回邀請。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權檢視要求的邀請，或發生存取錯誤。* NOT_FOUND：如果沒有邀請存在於要求的 ID。
• list — 傳回請求使用者有權檢視的邀請清單，且僅限於符合清單請求條件的邀請。注意： 必須至少提供 user_id 或 course_id 其中一個。兩個欄位都可以提供。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：發生存取錯誤。

registrations

• create — 建立 Registration，讓 Classroom 開始從提供的 feed 傳送通知到 cloudPubSubTopic 中指定的目的地。傳回建立的 Registration。目前，這會與引數相同，但會填入伺服器指定的欄位，例如 expiry_time 和 id。請注意，任何為 expiry_time 或 id 欄位指定的值都會被忽略。
• delete — 刪除 Registration，讓 Classroom 停止傳送該 Registration 的通知。

userProfiles

• get — 傳回使用者個人資料。此方法會傳回下列錯誤碼：* PERMISSION_DENIED：如果請求使用者無權存取此使用者個人資料，或沒有個人資料存在於要求的 ID，或發生存取錯誤。
• guardianInvitations — 對 'guardianInvitations' 資源的操作
• guardians — 對 'guardians' 資源的操作

探索指令

在呼叫任何 API 方法之前，請先檢查它：

# 瀏覽資源與方法
gws classroom --help

# 檢查方法的必要參數、型別與預設值
gws schema classroom.<resource>.<method>

使用 gws schema 的輸出結果來建構你的 --params 和 --json 旗標。