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 para el grupo de contactos que asigna el servidor. Una cadena ASCII, con el formato 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. Indica el tipo de grupo de contactos.

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.

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.

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.

memberCount

integer

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

clientData[]

object (GroupClientData)

Son los datos de 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. Fecha y hora en la que se actualizó el grupo por última vez.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una 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 solicitudes contactGroups.list que incluyen un token de sincronización.

GroupType

Un tipo de grupo de contactos.

Enumeraciones
GROUP_TYPE_UNSPECIFIED Sin especificar.
USER_CONTACT_GROUP Grupo de contactos definido por el usuario
SYSTEM_CONTACT_GROUP Grupo de contactos definido por el sistema

GroupClientData

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

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

string

El cliente especificó la clave de los datos del cliente.

value

string

El cliente especificó el valor de los datos del cliente.

Métodos

batchGet

Especifica una lista de nombres de recursos de grupos 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 pertenece al usuario autenticado especificando un nombre de recurso para el grupo de contactos.

get

Especifica un nombre de recurso de grupo de contactos para obtener un grupo de contactos específico que sea propiedad del 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 pertenece al usuario autenticado.