リクエスト元のユーザーが閲覧を許可されている招待状のリストを、リスト リクエストに一致するものに限定して返します。
注: userId
または courseId
の少なくとも 1 つを指定する必要があります。どちらのフィールドも指定できます。
このメソッドは、次のエラーコードを返します。
PERMISSION_DENIED
: アクセスエラー。
HTTP リクエスト
GET https://classroom.googleapis.com/v1/invitations
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
userId |
返される招待状を特定のユーザーに限定します。ID は次のいずれかです。
|
courseId |
返される招待を、指定された識別子を持つコースの招待に限定します。 |
pageSize |
返されるアイテムの最大数。指定しない場合のデフォルトは 500、または サーバーから返される結果の数よりも少ない結果が返されることがあります。 |
pageToken |
前の 他の点では、 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
招待の一覧を取得する際のレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"invitations": [
{
object ( |
フィールド | |
---|---|
invitations[] |
リスト リクエストに一致する招待。 |
nextPageToken |
返される結果の次のページを識別するトークン。空の場合、それ以上の結果はありません。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
詳細については、承認ガイドをご覧ください。