Google Classroom eklentileri artık geliştiricilerin genel kullanımına sunuldu! Daha fazla bilgi edinmek için lütfen
eklenti belgelerini inceleyin.
Method: userProfiles.guardianInvitations.list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
İstekte bulunan kullanıcının görüntülemesine izin verilen veli davetlerinin listesini, sağlanan parametrelere göre filtrelenmiş olarak döndürür.
Bu yöntem aşağıdaki hata kodlarını döndürür:
studentId belirtilmişse ve istek gönderen kullanıcının ilgili öğrenciye ait veli davetlerini görüntülemesine izin verilmiyorsa, studentId olarak "-" belirtilmişse ve kullanıcı alan yöneticisi değilse, veliler söz konusu alan için etkinleştirilmemişse veya diğer erişim hataları için.PERMISSION_DENIEDstudentId belirtilmişse ancak biçimi tanınamıyorsa (e-posta adresi, API'den bir studentId veya me değişmez dizesi değilse) INVALID_ARGUMENT. Geçersiz bir pageToken veya state sağlanırsa da döndürülebilir.NOT_FOUND, bir studentId belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa.
HTTP isteği
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler |
studentId |
string
Veli davetiyelerinin döndürüleceği öğrencinin kimliği. Tanımlayıcı aşağıdakilerden biri olabilir:
- Kullanıcının sayısal tanımlayıcısı
- kullanıcının e-posta adresi
- İstekte bulunan kullanıcıyı belirten
"me" değişmez dizesi
- İstekte bulunan kullanıcının veli davetlerini görüntülemesine izin verilen tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten
"-" dize değişmezi.
|
Sorgu parametreleri
| Parametreler |
invitedEmailAddress |
string
Belirtilirse yalnızca belirtilen invitedEmailAddress değerine sahip sonuçlar döndürülür.
|
states[] |
enum (GuardianInvitationState)
Belirtilirse yalnızca belirtilen state değerlerine sahip sonuçlar döndürülür. Aksi takdirde, state/PENDING sonuç içeren sonuçlar döndürülür.
|
pageToken |
string
Önceki bir list çağrısından döndürülen nextPageToken değeri. Sonuçların sonraki sayfasının döndürülmesi gerektiğini belirtir. list isteği, bu jetonla sonuçlanan istekte belirtilenlerle aynı olmalıdır.
|
pageSize |
integer
Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmemiş, sunucunun maksimum bir değer atayabileceğini gösterir. Sunucu, belirtilen sayıdan daha az sonuç döndürebilir.
|
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Veli davetlerini listelemede verilen yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
{
"guardianInvitations": [
{
object (GuardianInvitation)
}
],
"nextPageToken": string
} |
| Alanlar |
guardianInvitations[] |
object (GuardianInvitation)
Liste isteğiyle eşleşen veli davetleri.
|
nextPageToken |
string
Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boşsa başka sonuç yoktur.
|
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardianInvitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGuardianInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if a `studentId` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `studentId` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if a `studentId` is specified, but its format cannot be recognized (it is not an email address, nor a `studentId` from the API, nor the literal string `me`). May also be returned if an invalid `pageToken` or `state` is provided.\n- `NOT_FOUND` if a `studentId` is specified, and its format can be recognized, but Classroom has no record of that student.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user - the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` If specified, only results with the specified `invitedEmailAddress` are returned. |\n| `states[]` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#body.ListGuardianInvitationsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) request must be otherwise identical to the one that resulted in this token. |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing guardian invitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardianInvitations\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardianInvitations[]` | `object (`[GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation)`)` Guardian invitations that matched the list request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
