Google Classroom アドオンの一般提供が開始されました。詳しくは、
アドオンのドキュメントをご覧ください。
Method: userProfiles.guardianInvitations.create
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
保護者への招待状を作成し、保護者に生徒の保護者であることを確認するよう依頼するメールを送信します。
保護者が招待を承諾すると、保護者の state
は COMPLETED
に変わり、保護者向けの通知が届くようになります。アクティブな保護者を表す Guardian
リソースも作成されます。
リクエスト オブジェクトの studentId
フィールドと invitedEmailAddress
フィールドを設定する必要があります。これらのフィールドを設定しないか、リクエストで他のフィールドを設定すると、エラーが発生します。
このメソッドは、次のエラーコードを返します。
PERMISSION_DENIED
: 現在のユーザーに保護者の管理権限がない、該当する保護者がその生徒のリクエストをすでに拒否しすぎている、該当するドメインで保護者が有効になっていない場合、またはその他のアクセス エラーの場合。
RESOURCE_EXHAUSTED
: 生徒または保護者が保護者リンクの上限を超えている場合。
INVALID_ARGUMENT
: 保護者のメールアドレスが有効でない場合(長すぎる場合など)、または指定された生徒 ID の形式が認識できない場合(メールアドレスでも、この API の userId
でもない場合)。このエラーは、読み取り専用フィールドが設定されている場合や、state
フィールドが PENDING
以外の値に設定されている場合にも返されます。
NOT_FOUND
: 指定された生徒 ID が有効な生徒 ID であるにもかかわらず、Classroom にその生徒の記録がない。
ALREADY_EXISTS
: 生徒の保護者への招待が保留中であり、invitedEmailAddress
が指定されている場合、または指定された invitedEmailAddress
が、このユーザーの既存の Guardian
の Google アカウントと一致する場合。
HTTP リクエスト
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
guardianInvitation.studentId |
string
生徒の ID(標準形式)
|
リクエストの本文
リクエストの本文には GuardianInvitation
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には、新しく作成された GuardianInvitation
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/classroom.guardianlinks.students
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: userProfiles.guardianInvitations.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]