REST Resource: members

Recurso: Member

Los miembros de Grupos de Google pueden ser usuarios o cualquier otro grupo. Este miembro puede estar dentro o fuera de los dominios de tu cuenta. Si deseas obtener más información sobre tareas comunes para miembros de grupos, consulta la Guía para desarrolladores.

Representación JSON
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
Campos
kind

string

Tipo de recurso de la API. En el caso de los recursos de miembros, el valor es admin#directory#member.

email

string

La dirección de correo electrónico del miembro. Un miembro puede ser un usuario o un grupo diferente. Esta propiedad es obligatoria cuando se agrega un miembro a un grupo. email debe ser único y no puede ser un alias de otro grupo. Si se cambia la dirección de correo electrónico, la API refleja automáticamente los cambios en la dirección de correo electrónico.

role

string

El rol del miembro en un grupo. La API muestra un error para los ciclos de la pertenencia a grupos. Por ejemplo, si group1 es miembro de group2, group2 no puede ser miembro de group1. Para obtener más información sobre la función de un miembro, consulta Cómo asignar funciones de grupo a miembros.

Los valores aceptables son:

  • MANAGER: Este rol solo está disponible si se habilita Grupos de Google para empresas a través de la Consola del administrador. Consulta cómo ACTIVAR o DESACTIVAR Grupos para empresas. Un rol MANAGER puede hacer todo lo que hace un rol OWNER, excepto convertir a un miembro en OWNER o borrar el grupo. Un grupo puede tener varios miembros MANAGER.
  • MEMBER: Este rol permite suscribirse a un grupo, ver archivos de debate y ver la lista de miembros del grupo. Para obtener más información sobre las funciones de los miembros, consulta Asigna funciones de grupo a miembros.
  • OWNER: Este rol puede enviar mensajes al grupo, agregar o quitar miembros, cambiar sus roles, cambiar su configuración y borrarlo. Un OWNER debe ser miembro del grupo. Un grupo puede tener más de un OWNER.
etag

string

ETag del recurso.

type

string

Es el tipo de miembro del grupo.

Los valores aceptables son:

  • CUSTOMER: El miembro representa a todos los usuarios de un dominio. No se devuelve una dirección de correo electrónico y el ID que se muestra es el ID de cliente.
  • EXTERNAL: El miembro es un usuario o grupo que no pertenece al dominio. (No se utiliza actualmente)
  • GROUP: El miembro es otro grupo.
  • USER: El miembro es un usuario.
status

string

Estado del miembro (inmutable)

delivery_settings

string

Define las preferencias de entrega de correo electrónico del miembro. Este campo solo es compatible con los métodos insert, update y get.

Los valores aceptables son:

  • ALL_MAIL: Todos los mensajes, entregados en cuanto llegan.
  • DAILY: No puede haber más de un mensaje por día.
  • DIGEST: Hasta 25 mensajes agrupados en un solo mensaje
  • DISABLED: Quitar suscripción.
  • NONE: No hay mensajes.
id

string

El ID único del miembro del grupo. Se puede usar un id de miembro como el memberKey de un URI de solicitud de miembro.

Métodos

delete

Quita a un miembro de un grupo.

get

Recupera las propiedades de un miembro de un grupo.

hasMember

Verifica si un usuario determinado es miembro del grupo.

insert

Agrega un usuario al grupo especificado.

list

Recupera una lista paginada de todos los miembros de un grupo.

patch

Actualiza las propiedades de membresía de un usuario en el grupo especificado.

update

Actualiza la membresía de un usuario en el grupo especificado.