Method: contactGroups.update

Actualiza el nombre de un grupo de contactos existente que pertenece 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 modificación para el mismo usuario deben enviarse de forma secuencial para evitar el aumento de la latencia y las 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 de recurso para el grupo de contactos que asigna el servidor. Una cadena 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 usa para la validación de la caché web.
contactGroup.metadata

object (ContactGroupMetadata)

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

enum (GroupType)

Solo salida. Indica el tipo de grupo de contactos.
contactGroup.name

string

Indica 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 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. Es el nombre traducido y con formato en la configuración regional de la cuenta del usuario o en la configuración regional del encabezado HTTP Accept-Language para los nombres de los grupos del sistema. Los nombres de los grupos que estableció el propietario son los mismos que el nombre.
contactGroup.memberResourceNames[]

string

Solo salida. Es 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 tenga maxMembers en la solicitud GET.
contactGroup.memberCount

integer

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

object (GroupClientData)

Son los datos de cliente del grupo.
updateGroupFields

string (FieldMask format)

Opcional. Una máscara de campo para restringir qué campos del grupo se deben actualizar. Se pueden especificar varios campos separándolos con comas. El valor predeterminado es name si no se configura o si está vacío. Se reemplazan los campos actualizados. Estos son los valores válidos:

  • clientData
  • nombre
readGroupFields

string (FieldMask format)

Opcional. Una máscara de campo para restringir los campos del grupo que se muestran. El valor predeterminado es metadata, groupType y name si no se configura o si está vacío. Los campos válidos son los siguientes:

  • clientData
  • groupType
  • memberCount
  • metadatos
  • nombre

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.