REST Resource: spaces.members

Recurso: Membresía

Representa una relación de membresía en Google Chat, por ejemplo, si un usuario o una app de Chat están invitados a un espacio, forman parte de él o no están presentes en él.

Representación JSON
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Campos
name

string

Es el identificador. Es el nombre del recurso de la membresía, asignado por el servidor.

Formato: spaces/{space}/members/{member}

state

enum (MembershipState)

Solo salida. Estado de la membresía.

role

enum (MembershipRole)

Opcional. Es el rol del usuario en un espacio de Chat, que determina las acciones permitidas en el espacio.

Este campo solo se puede usar como entrada en members.patch.

createTime

string (Timestamp format)

Opcional. Inmutable. Es la fecha y hora de creación de la membresía, por ejemplo, cuando un miembro se unió o fue invitado a unirse a un espacio. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.

deleteTime

string (Timestamp format)

Opcional. Inmutable. Es la fecha y hora de eliminación de la membresía, por ejemplo, cuando un miembro abandonó un espacio o se lo quitó de él. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.

affiliation

enum (Affiliation)

Solo salida. Relación de un usuario con la organización de Workspace propietaria del espacio. En los espacios que son propiedad de cuentas personales, la afiliación de todos los miembros es EXTERNAL.

Es el miembro asociado a esta membresía. Es posible que se admitan otros tipos de miembros en el futuro. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
member

object (User)

Opcional. Es el usuario o la app de Google Chat a los que corresponde la membresía. Si tu app de Chat se autentica como usuario, el resultado solo completará los campos user name y type para los usuarios internos y externos, a menos que sean miembros del espacio o tengan una afinidad previa, como una conversación de mensaje directo (MD), con el usuario que llama.

groupMember

object (Group)

Opcional. Es el grupo de Google al que corresponde la membresía.

Para leer o modificar las membresías de Grupos de Google, se requiere la autenticación del usuario.

Fin de los campos mutuamente excluyentes.

MembershipState

Especifica la relación del miembro con un espacio. Es posible que se admitan otros estados de membresía en el futuro.

Enums
MEMBERSHIP_STATE_UNSPECIFIED Valor predeterminado No usar.
JOINED El usuario se agrega al espacio y puede participar en él.
INVITED Se invitó al usuario a unirse al espacio, pero aún no lo hizo.
NOT_A_MEMBER El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse a él.

MembershipRole

Representa las acciones permitidas de un usuario en un espacio de Chat. Es posible que se agreguen más valores de enumeración en el futuro.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Valor predeterminado En el caso de users, no es miembro del espacio, pero se le puede invitar. En el caso de Google Groups, siempre se les asigna este rol (es posible que se usen otros valores de enumeración en el futuro).
ROLE_MEMBER

Es miembro del espacio. En la IU de Chat, este rol se llama Miembro.

El usuario tiene permisos básicos, como enviar mensajes al espacio. Los administradores y propietarios pueden otorgar permisos adicionales a los miembros de un espacio, incluidos los siguientes:

  • Agregar o quitar miembros
  • Modificar los detalles del espacio
  • Activar o desactivar el historial
  • Menciona a todas las personas en el espacio con @all.
  • Administrar las apps y los webhooks de Chat instalados en el espacio

En los mensajes directos y las conversaciones grupales sin nombre, todos tienen este rol.

ROLE_MANAGER

Ser propietario de un espacio En la IU de Chat, este rol se denomina Propietario.

El usuario tiene el conjunto completo de permisos del espacio para administrarlo, incluidos los siguientes:

  • Cambiar el rol de otros miembros del espacio a miembro, administrador o propietario
  • Borrar el espacio

Solo se admite en SpaceType.SPACE (espacios con nombre).

Para obtener más información, consulta Obtén más información sobre tu rol como propietario o administrador de un espacio.

ROLE_ASSISTANT_MANAGER

Un administrador del espacio En la IU de Chat, este rol se llama Administrador.

El usuario tiene todos los permisos básicos de ROLE_MEMBER y un propietario puede otorgarle un subconjunto de permisos administrativos. De forma predeterminada, los administradores tienen todos los permisos de un propietario, excepto la capacidad de realizar las siguientes acciones:

  • Borrar el espacio
  • Convertir a otro miembro del espacio en propietario
  • Cambiar el rol de un propietario

De forma predeterminada, los permisos de administrador incluyen, entre otros, los siguientes:

  • Convertir a otro miembro en administrador
  • Borrar mensajes en el espacio
  • Administrar permisos del espacio
  • Recibir notificaciones sobre las solicitudes para unirse al espacio si el administrador tiene el permiso "Administrar miembros" en la configuración del espacio
  • Haz que un espacio sea detectable.

Solo se admite en SpaceType.SPACE (espacios con nombre).

Para obtener más información, consulta Administra la configuración del espacio.

Grupo

Un grupo de Google en Google Chat

Representación JSON
{
  "name": string
}
Campos
name

string

Es el nombre del recurso de un grupo de Google.

Representa un grupo en la API de Groups de Cloud Identity.

Formato: groups/{group}

Afiliación

Representa la afiliación de un usuario a la organización de Google Workspace propietaria del espacio. Es posible que se agreguen más valores a este enum en el futuro.

Enums
AFFILIATION_UNSPECIFIED Valor predeterminado Este valor no se usa.
INTERNAL Una cuenta administrada por la misma organización de Google Workspace que posee el espacio
EXTERNAL Una cuenta externa a la organización de Google Workspace propietaria del espacio (p.ej., una cuenta personal o una cuenta administrada por otra organización de Workspace).
MANAGED_EXTERNAL Es una cuenta administrada por la organización de Workspace propietaria del espacio, pero aprovisionada para un usuario externo a la organización (p.ej., un usuario invitado). Para obtener más información sobre los invitados, consulta https://support.google.com/chat/answer/16997417.

Métodos

create

Crea una membresía para la app de Chat de llamadas, un usuario o un Grupo de Google.

delete

Borra una membresía.

get

Devuelve detalles sobre una membresía.

list

Enumera las membresías en un espacio.

patch

Actualiza una membresía.