リクエスト元のユーザーが閲覧を許可されている保護者の招待のリストを返します。指定されたパラメータでフィルタされます。
このメソッドは、次のエラーコードを返します。
studentId
が指定されており、studentId
に"-"
が指定されていてユーザーがドメイン管理者ではない場合、対象のドメインで保護者が有効でない場合、またはその他のアクセスエラーの場合、リクエストしているユーザーがその生徒の保護者の招待状を表示することが許可されていない場合、PERMISSION_DENIED
。studentId
が指定されているが、その形式を認識できない場合(studentId
でも API のstudentId
でも、リテラル文字列me
でもない場合)。無効なpageToken
またはstate
が指定された場合にも返されます。INVALID_ARGUMENT
studentId
が指定されていて、その形式を認識できるにもかかわらず、Classroom にその生徒の記録がない場合、NOT_FOUND
。
HTTP リクエスト
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
studentId |
保護者の招待状が返送される生徒の ID。ID は次のいずれかです。
|
クエリ パラメータ
パラメータ | |
---|---|
invitedEmailAddress |
指定すると、指定した |
states[] |
指定すると、指定された |
pageToken |
前の 他の点では、 |
pageSize |
返されるアイテムの最大数。ゼロまたは未指定の場合、サーバーが最大値を割り当て可能であることを示します。 サーバーから返される結果の数よりも少ない結果が返されることがあります。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
保護者への招待を一覧表示する際のレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"guardianInvitations": [
{
object ( |
フィールド | |
---|---|
guardianInvitations[] |
リストのリクエストに一致する保護者への招待。 |
nextPageToken |
返される結果の次のページを識別するトークン。空の場合、それ以上の結果はありません。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
詳細については、承認ガイドをご覧ください。