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)

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

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

  • text
  • state
  • scheduledTime

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。