返回发出请求的用户可以查看的邀请列表(仅限与列表请求匹配的邀请)。
注意:必须至少提供 userId
或 courseId
中的一个。这两个字段均可提供。
此方法会返回以下错误代码:
PERMISSION_DENIED
:访问错误。
HTTP 请求
GET https://classroom.googleapis.com/v1/invitations
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
userId |
限制只有特定用户才能返回的邀请。该标识符可以是以下其中一项:
|
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
有关详情,请参阅授权指南。