REST Resource: contactGroups

Recurso: ContactGroup

Un grupo de contactos.

Representación JSON
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Campos
resourceName

string

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

etag

string

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

metadata

object (ContactGroupMetadata)

Solo salida. Metadatos sobre el grupo de contactos.

groupType

enum (GroupType)

Solo salida. El tipo de grupo de contactos.

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.

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.

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.

memberCount

integer

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

clientData[]

object (GroupClientData)

Los datos del cliente del grupo.

Metadatos de contactos

Los metadatos sobre un grupo de contactos.

Representación JSON
{
  "updateTime": string,
  "deleted": boolean
}
Campos
updateTime

string (Timestamp format)

Solo salida. La hora en la que se actualizó el grupo por última vez.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

deleted

boolean

Solo salida. Verdadero si se borró el recurso del grupo de contactos. Se propaga solo para las solicitudes contactGroups.list que incluyen un token de sincronización.

Tipo de grupo

Un tipo de grupo de contactos.

Enumeradores
GROUP_TYPE_UNSPECIFIED No se especifica.
USER_CONTACT_GROUP Grupo de contactos definido por el usuario.
SYSTEM_CONTACT_GROUP Grupo de contactos definido por el sistema.

Datos del cliente de grupo

Datos de clientes arbitrarios que propagan los clientes. Se permiten valores y claves duplicados.

Representación JSON
{
  "key": string,
  "value": string
}
Campos
key

string

La clave especificada por el cliente de los datos del cliente.

value

string

El valor especificado por el cliente de los datos del cliente.

Métodos

batchGet

Para obtener una lista de los grupos de contactos que pertenecen al usuario autenticado, especifica una lista de nombres de recursos de grupos de contactos.

create

Crea un nuevo grupo de contactos que pertenezca al usuario autenticado.

delete

Especifica un nombre de recurso de grupo de contactos para borrar un grupo de contactos existente que pertenezca al usuario autenticado.

get

Especifica un nombre de recurso de grupo de contactos para obtener un grupo de contactos específico que pertenezca al usuario autenticado.

list

Enumera todos los grupos de contactos que pertenecen al usuario autenticado.

update

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