Method: userProfiles.guardians.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de responsáveis que o usuário solicitante tem permissão para visualizar, restrita àqueles que correspondem à solicitação.
Para listar os responsáveis de qualquer estudante que o usuário solicitante possa consultar, use o caractere literal - para o ID do estudante.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED se um studentId for especificado e o usuário solicitante não tiver permissão para acessar as informações do responsável do estudante, se "-" for especificado como studentId e o usuário não for um administrador do domínio, se os responsáveis não estiverem ativados para o domínio em questão, se o filtro invitedEmailAddress for definido por um usuário que não é administrador do domínio ou para outros erros de acesso.INVALID_ARGUMENT se um studentId for especificado, mas o formato dele não puder ser reconhecido (ele não é um endereço de e-mail, um studentId da API nem a string literal me). Também pode ser retornado se um pageToken inválido for fornecido.NOT_FOUND se um studentId for especificado e o formato dele puder ser reconhecido, mas o Google Sala de Aula não tiver registro desse estudante.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
studentId |
string
Filtre os resultados pelo estudante vinculado ao responsável. O identificador pode ser um dos seguintes:
- o identificador numérico do usuário
- o endereço de e-mail do usuário
- o literal de string
"me", indicando o usuário solicitante
- o literal de string
"-", indicando que os resultados devem ser retornados para todos os estudantes que o usuário solicitante tem acesso para visualizar.
|
Parâmetros de consulta
| Parâmetros |
invitedEmailAddress |
string
Filtre os resultados pelo endereço de e-mail para o qual o convite original foi enviado, resultando neste link do responsável. Esse filtro só pode ser usado por administradores de domínio.
|
pageToken |
string
O valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada. A solicitação list precisa ser idêntica à que resultou nesse token.
|
pageSize |
integer
Número máximo de itens a serem retornados. Zero ou indefinido indica que o servidor pode atribuir um valor máximo. O servidor pode retornar menos resultados do que o especificado.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta ao listar os responsáveis.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"guardians": [
{
object (Guardian)
}
],
"nextPageToken": string
} |
| Campos |
guardians[] |
object (Guardian)
Os responsáveis na página de resultados que atenderam aos critérios especificados na solicitação.
|
nextPageToken |
string
Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardians.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.ListGuardiansResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID.\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 information 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, if the `invitedEmailAddress` filter is set by a user who is not a domain administrator, 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` 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}/guardians`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Filter results by the student who the guardian is linked to. 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 has access to view. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#body.ListGuardiansResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) 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 guardians.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardians\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardians[]` | `object (`[Guardian](/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian)`)` Guardians on this page of results that met the criteria specified in the 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.me.readonly`\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)."]]
