Method: contactGroups.update

Actualiza el nombre de un grupo de contactos existente que pertenezca al usuario autenticado.

Los nombres de los grupos de contactos actualizados deben ser únicos 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 mutación del mismo usuario se deben enviar de forma secuencial para evitar una mayor 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

string

El nombre del recurso para el grupo de contactos, asignado por el servidor. Una string ASCII con el formato contactGroups/{contactGroupId}.

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 (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Campos
contactGroup.etag

string

La etiqueta de entidad HTTP del recurso. Se utiliza para la validación de caché web.
contactGroup.metadata

object (ContactGroupMetadata)

Solo salida. Metadatos sobre el grupo de contactos.
contactGroup.groupType

enum (GroupType)

Solo salida. El tipo de grupo de contactos.
contactGroup.name

string

El nombre del grupo de contactos que estableció el propietario o un nombre proporcionado por el sistema para los grupos del sistema.

Para contactGroups.create o contactGroups.update, el nombre debe ser único para los grupos de contactos de los usuarios. Si intentas crear un grupo con un nombre duplicado, se mostrará un error HTTP 409.
contactGroup.formattedName

string

Solo salida. El nombre traducido y el formato que tiene la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language para los nombres de los grupos del sistema. Los nombres de grupo establecidos por el propietario son los mismos que los nombres.
contactGroup.memberResourceNames[]

string

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 maxMembers de la solicitud get.
contactGroup.memberCount

integer

Solo salida. La cantidad total de contactos en el grupo, independientemente de la cantidad máxima de miembros especificada en la solicitud.
contactGroup.clientData[]

object (GroupClientData)

Los datos del cliente del grupo.
updateGroupFields

string (FieldMask format)

Opcional. Una máscara de campo que restringe los campos que se actualizan en el grupo. Se pueden especificar varios campos separándolos con comas. El valor predeterminado es name si no se configura o se configura como vacío. Se reemplazan los campos actualizados. A continuación, se indican los valores válidos:

  • datosdelcliente
  • name
readGroupFields

string (FieldMask format)

Opcional. Una máscara de campo que restringe los campos que se muestran en el grupo. La configuración predeterminada es metadata, groupType y name si no se configura o se deja vacía. Los campos válidos son los siguientes:

  • datosdelcliente
  • TipoDeGrupo
  • miembro miembro
  • metadata
  • name

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.