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

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