Method: courses.topics.patch

トピックの 1 つ以上のフィールドを更新します。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

string

トピックの識別子。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

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

  • name

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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