Los complementos de Google Classroom ya están en fase de disponibilidad general para desarrolladores. Consulta la
documentación sobre complementos para obtener más información.
Method: userProfiles.guardianInvitations.create
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Crea una invitación para el tutor y le envía un correo electrónico para que confirme que es el tutor del estudiante.
Una vez que el tutor acepte la invitación, su state cambiará a COMPLETED y comenzará a recibir notificaciones de tutor. También se creará un recurso Guardian para representar al tutor activo.
El objeto de la solicitud debe tener configurados los campos studentId y invitedEmailAddress. Si no configuras estos campos o configuras cualquier otro campo en la solicitud, se mostrará un error.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIED si el usuario actual no tiene permiso para administrar a los tutores, si el tutor en cuestión ya rechazó demasiadas solicitudes para ese estudiante, si los tutores no están habilitados para el dominio en cuestión o por otros errores de acceso.RESOURCE_EXHAUSTED si el estudiante o el tutor superaron el límite de vínculos del tutor.INVALID_ARGUMENT si la dirección de correo electrónico del tutor no es válida (por ejemplo, si es demasiado larga) o si no se puede reconocer el formato del ID de estudiante proporcionado (no es una dirección de correo electrónico ni un userId de esta API). Este error también se mostrará si se configuran campos de solo lectura o si el campo state se establece en un valor distinto de PENDING.NOT_FOUND si el ID de estudiante proporcionado es válido, pero Classroom no tiene registro de ese estudiante.ALREADY_EXISTS si ya hay una invitación pendiente para el tutor del estudiante y se proporcionó invitedEmailAddress, o si el invitedEmailAddress proporcionado coincide con la cuenta de Google de un Guardian existente para este usuario.
Solicitud HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
guardianInvitation.studentId |
string
ID del estudiante (en formato estándar)
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de GuardianInvitation.
Cuerpo de la respuesta
Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de GuardianInvitation.
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
