Method: courses.announcements.patch

通知の 1 つ以上のフィールドを更新します。

このメソッドは、次のエラーコードを返します。

  • PERMISSION_DENIED: リクエスト元のデベロッパー プロジェクトが対応するお知らせを作成していない場合、またはアクセス エラーの場合。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。
  • FAILED_PRECONDITION: リクエストされたお知らせがすでに削除されている場合。
  • NOT_FOUND: リクエストされたコースまたはお知らせが存在しない場合

HTTP リクエスト

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{id}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
courseId

string

コースの識別子。この識別子は、Classroom で割り当てられた識別子または alias のいずれかです。
id

string

お知らせの識別子。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

更新するお知らせのフィールドを識別するマスク。このフィールドは更新を行う際に必須です。無効なフィールドが指定されている場合、更新は失敗します。フィールドが空の値をサポートしている場合は、お知らせオブジェクトではなく更新マスクで指定することで、そのフィールドを消去できます。空の値をサポートしていないフィールドが更新マスクに含まれ、お知らせオブジェクトに設定されていない場合、INVALID_ARGUMENT エラーが返されます。

教師は次のフィールドを指定できます。

  • text
  • state
  • scheduledTime

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Announcement のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Announcement のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/classroom.announcements

詳しくは、認可ガイドをご覧ください。