Method: userProfiles.guardianInvitations.create
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Cria um convite para o responsável e envia um e-mail pedindo que ele confirme que é o responsável pelo estudante.
Quando o responsável aceitar o convite, o state vai mudar para COMPLETED, e ele vai começar a receber notificações de responsável. Um recurso Guardian também será criado para representar o responsável ativo.
O objeto de solicitação precisa ter os campos studentId e invitedEmailAddress definidos. A falha na configuração desses campos ou a configuração de outros campos na solicitação resultará em um erro.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED se o usuário atual não tiver permissão para gerenciar responsáveis, se o responsável em questão já tiver rejeitado muitas solicitações para esse estudante, se os responsáveis não estiverem ativados para o domínio em questão ou por outros erros de acesso.RESOURCE_EXHAUSTED se o estudante ou responsável tiver excedido o limite de vinculação.INVALID_ARGUMENT se o endereço de e-mail do responsável não for válido (por exemplo, se for muito longo) ou se o formato do ID do estudante fornecido não puder ser reconhecido (não é um endereço de e-mail nem um userId desta API). Esse erro também será retornado se campos somente leitura forem definidos ou se o campo state for definido como um valor diferente de PENDING.NOT_FOUND se o ID do estudante fornecido for válido, mas o Google Sala de Aula não tiver registro desse estudante.ALREADY_EXISTS se já houver um convite pendente para o responsável do estudante e o invitedEmailAddress fornecido ou se o invitedEmailAddress fornecido corresponder à conta do Google de um Guardian existente para esse usuário.
Solicitação HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
guardianInvitation.studentId |
string
Documento de identificação do estudante (no formato padrão)
|
Corpo da solicitação
O corpo da solicitação contém uma instância de GuardianInvitation.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de GuardianInvitation.
Escopos de autorização
Requer o seguinte escopo OAuth:
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.guardianInvitations.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
