Method: userProfiles.guardians.delete

保護者を削除します。

保護者に通知が送信されなくなり、API 経由で保護者にアクセスすることもできなくなります。

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

  • PERMISSION_DENIED: 指定した studentId に一致するユーザーがリクエスト元のユーザーに表示されない場合、リクエストしているユーザーに studentId で特定される生徒の保護者を管理する権限がない場合、該当するドメインで保護者が有効になっていない場合、またはその他のアクセスエラーの場合。
  • INVALID_ARGUMENT は、studentId が指定されているものの、その形式を認識できない場合（メールアドレスでも API の studentId でもない場合）です。
  • NOT_FOUND: リクエストしたユーザーが studentId の保護者を変更する権限を持っているが、指定した guardianId を持つその生徒の Guardian レコードが存在しない場合。

HTTP リクエスト

DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

パスパラメータ

パラメータ
studentId

string

保護者を削除する生徒。次のいずれかになります。

  • ユーザーの数値 ID
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "me"
guardianId

string

Guardian の id フィールド。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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