- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Pruébala
Actualizar el nombre de un grupo de contactos existente que pertenezca al usuario autenticado
Los nombres de los grupos de contactos actualizados deben ser exclusivos para los grupos de contactos de los usuarios. Si intentas crear un grupo con un nombre duplicado, se mostrará un error HTTP 409.
Las solicitudes de modificación para el mismo usuario deben enviarse de forma secuencial para evitar aumentos de latencia y fallas.
Solicitud HTTP
PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
contactGroup.resourceName |
El nombre de recurso del grupo de contactos, asignado por el servidor. Una cadena ASCII, con el formato de |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"contactGroup": {
"resourceName": string,
"etag": string,
"metadata": {
"updateTime": string,
"deleted": boolean
},
"groupType": enum ( |
Campos | |
---|---|
contactGroup.etag |
La etiqueta de entidad HTTP del recurso. Se usa para la validación de la caché web. |
contactGroup.metadata |
Solo salida. Metadatos sobre el grupo de contactos. |
contactGroup.groupType |
Solo salida. El tipo de grupo de contactos. |
contactGroup.name |
El nombre del grupo de contactos que estableció el propietario del grupo o un nombre proporcionado por el sistema para los grupos del sistema. En el caso de |
contactGroup.formattedName |
Solo salida. Es el nombre traducido y con formato según la configuración regional de la cuenta del usuario, o bien la configuración regional del encabezado HTTP |
contactGroup.memberResourceNames[] |
Solo salida. La lista de nombres de recursos de personas de contacto que son miembros del grupo de contactos. El campo solo se propaga para las solicitudes GET y solo mostrará la cantidad de miembros que |
contactGroup.memberCount |
Solo salida. Es la cantidad total de contactos en el grupo, independientemente de la cantidad máxima de miembros que se especifica en la solicitud. |
contactGroup.clientData[] |
Los datos del cliente del grupo. |
updateGroupFields |
Opcional. Una máscara de campo que restringe los campos del grupo que se actualizan. Se pueden especificar varios campos separándolos con comas. El valor predeterminado es
|
readGroupFields |
Opcional. Una máscara de campo que restringe los campos del grupo que se muestran. La configuración predeterminada es
|
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ContactGroup
.
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/contacts
Para obtener más información, consulta la guía de autorización.