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 de recurso del grupo de contactos, asignado por el servidor. Una cadena ASCII, con el formato de contactGroups/{contactGroupId}.

etag

string

La etiqueta de entidad HTTP del recurso. Se usa para la validación de la 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 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 del usuario. Si intentas crear un grupo con un nombre duplicado, se mostrará un error HTTP 409.

formattedName

string

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 Accept-Language para los nombres de los grupos del sistema. Los nombres de grupo que estableció el propietario son los mismos que el nombre.

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 en la solicitud GET.

memberCount

integer

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.

clientData[]

object (GroupClientData)

Los datos del cliente del grupo.

ContactGroupMetadata

Los metadatos sobre un grupo de contactos.

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

string (Timestamp format)

Solo salida. Hora en 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 fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

deleted

boolean

Solo salida. Es 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.

GroupType

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.

GroupClientData

Datos del cliente arbitrarios que los clientes completan. Se permiten claves y valores duplicados.

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

string

La clave de los datos del cliente que especificó el cliente.

value

string

El valor que especifica el cliente de los datos del cliente.

Métodos

batchGet

Especifica una lista de nombres de recursos del grupo de contactos para obtener una lista de los grupos de contactos que pertenecen al usuario autenticado.

create

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

delete

Borra un grupo de contactos existente que sea propiedad del usuario autenticado. Para ello, especifica un nombre de recurso del grupo de contactos.

get

Obtén un grupo de contactos específico que pertenezca al usuario autenticado especificando un nombre de recurso de grupo de contactos.

list

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

update

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