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.patch
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Modifica una invitación para el tutor.
Actualmente, la única modificación válida es cambiar state de PENDING a COMPLETE. Esto tiene el efecto de retirar la invitación.
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 los tutores no están habilitados para el dominio en cuestión o por otros errores de acceso.FAILED_PRECONDITION si el vínculo del tutor no está en el estado PENDING.INVALID_ARGUMENT 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), o si el GuardianInvitation pasado tiene un state que no es COMPLETE, o si modifica campos que no son state.NOT_FOUND si el ID de estudiante proporcionado es válido, pero Classroom no tiene registro de ese estudiante, o si el campo id no hace referencia a una invitación para el tutor que Classroom conozca.
Solicitud HTTP
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
studentId |
string
El ID del estudiante cuya invitación para el tutor se modificará.
|
invitationId |
string
El campo id de GuardianInvitation que se modificará.
|
Parámetros de consulta
| Parámetros |
updateMask |
string (FieldMask format)
Es una máscara que identifica qué campos del curso se deben actualizar. Este campo es obligatorio para realizar una actualización. La actualización fallará si se especifican campos no válidos. Los siguientes campos son válidos:
Cuando se establece en un parámetro de consulta, este campo se debe especificar como updateMask=<field1>,<field2>,...
Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de GuardianInvitation.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia 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.patch\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n- `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\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 invitation is to be modified. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` to be modified. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: - `state` When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\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 an 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)."]]
