REST Resource: groups

Recurso: Group

Los Grupos de Google brindan a los usuarios la posibilidad de enviar mensajes a grupos de personas mediante la dirección de correo electrónico del grupo. Para obtener más información sobre tareas comunes, consulta la Guía para desarrolladores.

Para obtener información sobre otros tipos de grupos, consulta la documentación de la API de Cloud Identity Groups.

Nota: El usuario que llama a la API (o al que está suplantando una cuenta de servicio) debe tener una función asignada que incluya permisos de grupos de la API de Admin, como administrador avanzado o administrador de grupos.

Representación JSON 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Campos
id

string

Solo lectura. Es el ID único de un grupo. Se puede usar un grupo id como el groupKey de un URI de solicitud de grupo.
email

string

La dirección de correo electrónico del grupo. Si tu cuenta tiene varios dominios, selecciona el dominio adecuado para la dirección de correo electrónico. El email debe ser único. Esta propiedad es obligatoria cuando se crea un grupo. Las direcciones de correo electrónico de grupos están sujetas a las mismas reglas de uso de caracteres que los nombres de usuario. Consulta el Centro de ayuda para obtener más información.
name

string

El nombre visible del grupo.
description

string

Una descripción detallada para ayudar a los usuarios a determinar el propósito de un grupo. Por ejemplo, puedes incluir información sobre quién debe unirse al grupo, los tipos de mensajes que se enviarán, vínculos a preguntas frecuentes sobre el grupo o grupos relacionados. La longitud máxima es de 4,096 caracteres.
adminCreated

boolean

Solo lectura. El valor es true si un administrador creó este grupo en lugar de un usuario.
directMembersCount

string (int64 format)

Indica la cantidad de usuarios que son miembros directos del grupo. Si un grupo es miembro (secundario) de este grupo (el superior), los miembros del grupo secundario no se cuentan en la propiedad directMembersCount del grupo superior.
kind

string

Tipo de recurso de la API. En el caso de los recursos de Grupos, el valor es admin#directory#group.
etag

string

ETag del recurso.
aliases[]

string

Solo lectura. Es la lista de alias de direcciones de correo electrónico de un grupo. Para agregar, actualizar o quitar los alias de un grupo, usa los métodos groups.aliases. Si se edita en la solicitud POST o PUT de un grupo, se ignora la edición.
nonEditableAliases[]

string

Solo lectura. Es la lista de los alias de correo electrónico no editables del grupo que están fuera del dominio o los subdominios principales de la cuenta. Estas son direcciones de correo electrónico funcionales utilizadas por el grupo. Esta es una propiedad de solo lectura que se muestra en la respuesta de la API para un grupo. Si se edita en la solicitud POST o PUT de un grupo, se ignora la edición.

Métodos

delete

 Borra un grupo.

get

 Recupera las propiedades de un grupo.

insert

 Crea un grupo.

list

 Recupera todos los grupos de un dominio o de un usuario a partir de una userKey (paginada).

patch

 Actualiza las propiedades de un grupo.

update

 Actualiza las propiedades de un grupo.