Se usó la API de Cloud Translation para traducir esta página.

Invitar o agregar a un usuario, un Grupo de Google o una app de Google Chat a un espacio

En esta guía, se explica cómo usar el método create() del recurso Membership de la API de Google Chat para invitar o agregar un usuario, un Grupo de Google o una app de Chat a un espacio, lo que también se conoce como crear una membresía. Cuando se crea una membresía, si el miembro especificado tiene desactivada la política de aceptación automática, se le envía una invitación y debe aceptarla antes de unirse al espacio. De lo contrario, crear una membresía agrega al miembro directamente al espacio especificado.

Si eres administrador de Google Workspace, puedes agregar usuarios, Grupos de Google o apps de Chat a cualquier espacio de tu organización de Google Workspace.

El recurso Membership representa si un usuario humano o una app de Google Chat está invitado a un espacio, forma parte de él o no está presente en él.

Requisitos previos

Node.js

Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud de Node.js.
- Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
  - Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
  - Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Python

Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud de Python.
- Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
  - Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
  - Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Java

Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud de Java.
- Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
  - Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
  - Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Apps Script

Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Crea un proyecto independiente de Apps Script y activa el servicio de Chat avanzado.
- En esta guía, debes usar la autenticación de usuario o de app. Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio. Para conocer los pasos, consulta Autentícate y autoriza como una app de Google Chat.
Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Invitar o agregar a un usuario a un espacio como usuario

Para invitar o agregar a un usuario a un espacio con autenticación de usuario, pasa lo siguiente en tu solicitud:

Especifica el alcance de autorización chat.memberships.
Realiza una llamada al método CreateMembership().
Pasa parent como el nombre del recurso del espacio en el que se creará la membresía.
Pasa membership como una instancia de Membership con su campo member establecido con lo siguiente:
- El campo type configurado como HUMAN.
- El campo name establecido en users/{user}, donde {user} es la persona que deseas agregar al espacio. Para especificar el usuario de Chat, reemplaza {user} por cualquiera de los siguientes elementos:
  - Es el ID de la persona en la API de People. Por ejemplo, si el objeto person de la API de People resourceName es people/123456789, usa el valor users/123456789.
  - Es el ID del usuario en la API de Directory.
  - La dirección de correo electrónico del usuario. Por ejemplo, users/222larabrown@gmail.com o users/larabrown@cymbalgroup.com. Si el usuario usa una Cuenta de Google o pertenece a otra organización de Google Workspace, debes usar su dirección de correo electrónico.

En el siguiente ejemplo, se agrega un usuario a un espacio con autenticación de usuario:

Node.js

chat/client-libraries/cloud/create-membership-user-cred.js

Ver en GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to create membership with user credential for a human user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      member: {
        // Replace USER_NAME here
        name: 'users/USER_NAME',
        // User type for the membership
        type: 'HUMAN'
      }
    }
  };

  // Make the request
  const response = await chatClient.createMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred.py

Ver en GitHub

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.memberships"]

# This sample shows how to create membership with user credential for a human
# user
def create_membership_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "member": {
                # Replace USER_NAME here
                "name": "users/USER_NAME",
                # user type for the membership
                "type_": "HUMAN"
            }
        }
    )

    # Make the request
    response = client.create_membership(request)

    # Handle the response
    print(response)

create_membership_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCred.java

Ver en GitHub

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.User;

// This sample shows how to create membership with user credential for a human
// user.
public class CreateMembershipUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.memberships";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setMember(User.newBuilder()
            // replace USER_NAME here
            .setName("users/USER_NAME")
            // user type for the membership
            .setType(User.Type.HUMAN)));
      Membership response = chatServiceClient.createMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Ver en GitHub

/**
 * This sample shows how to create membership with user credential for a human user
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  };

  // Make the request
  const response = Chat.Spaces.Members.create(membership, parent);

  // Handle the response
  console.log(response);
}

Para ejecutar la muestra, reemplaza lo siguiente:

SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
USER_NAME: Es un ID de usuario.

La API de Chat devuelve una instancia de Membership que detalla la membresía del usuario que se creó.

Invita o agrega un Grupo de Google a un espacio

Para invitar o agregar un grupo de Google a un espacio con autenticación de usuarios (la autenticación de apps no admite invitar ni agregar un grupo de Google a un espacio), pasa lo siguiente en tu solicitud:

Especifica el alcance de autorización chat.memberships.
Realiza una llamada al método CreateMembership().
Pasa parent como el nombre del recurso del espacio en el que se creará la membresía.
Pasa membership como una instancia de Membership con el campo name de groupMember establecido en groups/{group}, donde {group} es el ID del grupo para el que deseas crear la membresía. El ID del grupo se puede recuperar con la API de Cloud Identity.

Los Grupos de Google no se pueden agregar a un chat grupal ni a un mensaje directo, sino solo a un espacio con nombre.

En el siguiente ejemplo, se agrega un grupo a un espacio con nombre con autenticación del usuario:

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-group.js

Ver en GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to create membership with user credential for a group
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      groupMember: {
        // Replace GROUP_NAME here
        name: 'groups/GROUP_NAME'
      }
    }
  };

  // Make the request
  const response = await chatClient.createMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred_for_group.py

Ver en GitHub

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.memberships"]

# This sample shows how to create membership with user credential for a group
def create_membership_with_user_cred_for_group():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "groupMember": {
                # Replace GROUP_NAME here
                "name": "groups/GROUP_NAME"
            }
        }
    )

    # Make the request
    response = client.create_membership(request)

    # Handle the response
    print(response)

create_membership_with_user_cred_for_group()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCredForGroup.java

Ver en GitHub

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.Group;

// This sample shows how to create membership with user credential for a group.
public class CreateMembershipUserCredForGroup {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.memberships";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setGroupMember(Group.newBuilder()
            // replace GROUP_NAME here
            .setName("groups/GROUP_NAME")));
      Membership response = chatServiceClient.createMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Ver en GitHub

/**
 * This sample shows how to create membership with user credential for a group
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCredForGroup() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    groupMember: {
      // TODO(developer): Replace GROUP_NAME here
      name: 'groups/GROUP_NAME'
    }
  };

  // Make the request
  const response = Chat.Spaces.Members.create(membership, parent);

  // Handle the response
  console.log(response);
}

Para ejecutar la muestra, reemplaza lo siguiente:

SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
GROUP_NAME: Es un ID de grupo.

La API de Chat devuelve una instancia de Membership que detalla la membresía del usuario que se creó.

Agrega una app de Chat a un espacio

Una app de Chat no puede agregar otra app como miembro a un espacio. Para agregar una app de Chat a un espacio o a un mensaje directo entre dos usuarios humanos, pasa lo siguiente en tu solicitud con autenticación de usuario (la autenticación de app no admite invitar ni agregar una app de Chat a un espacio):

Especifica el alcance de autorización chat.memberships.app.
Realiza una llamada al método CreateMembership().
Pasa parent como el nombre del recurso del espacio en el que se creará la membresía.
Pasa membership como una instancia de Membership con su campo member establecido con lo siguiente:
- El campo type configurado como BOT.
- El campo name establecido en users/app, un alias que representa la app que llama a la API de Chat.

En el siguiente ejemplo, se agrega una app de Chat a un espacio:

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-app.js

Ver en GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships.app'];

// This sample shows how to create membership with app credential for an app
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      member: {
        // Member name for app membership, do not change this
        name: 'users/app',
        // User type for the membership
        type: 'BOT'
      }
    }
  };

  // Make the request
  const response = await chatClient.createMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred_for_app.py

Ver en GitHub

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.memberships.app"]

# This sample shows how to create membership with app credential for an app
def create_membership_with_user_cred_for_app():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "member": {
                # member name for app membership, do not change this.
                "name": "users/app",
                # user type for the membership
                "type_": "BOT"
            }
        }
    )

    # Make the request
    response = client.create_membership(request)

    # Handle the response
    print(response)

create_membership_with_user_cred_for_app()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCredForApp.java

Ver en GitHub

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.User;

// This sample shows how to create membership with user credential for the
// calling app.
public class CreateMembershipUserCredForApp {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.memberships.app";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setMember(User.newBuilder()
            // member name for app membership, do not change this.
            .setName("users/app")
            // user type for the membership
            .setType(User.Type.BOT)));
      Membership response = chatServiceClient.createMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Ver en GitHub

/**
 * This sample shows how to create membership with app credential for an app
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.app'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCredForApp() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    member: {
      // Member name for app membership, do not change this
      name: 'users/app',
      // User type for the membership
      type: 'BOT'
    }
  };

  // Make the request
  const response = Chat.Spaces.Members.create(membership, parent);

  // Handle the response
  console.log(response);
}

Para ejecutar la muestra, reemplaza SPACE_NAME por el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.

La API de Chat devuelve una instancia de Membership que detalla la membresía del usuario que se creó.

Invita o agrega a un usuario a un espacio como app de Chat

La autenticación de la app requiere la aprobación del administrador una sola vez.

Para invitar o agregar un usuario a un espacio con autenticación de la app, pasa lo siguiente en tu solicitud:

Especifica el alcance de autorización chat.app.memberships.
Llama al método create en el recurso membership.
Establece parent en el nombre del recurso del espacio en el que se creará la membresía.
Establece member en users/{user}, donde {user} es la persona para la que deseas crear la membresía y puede ser uno de los siguientes valores:
- Es el ID de la persona en la API de People. Por ejemplo, si el resourceName de la API de People person es people/123456789, establece membership.member.name en users/123456789.
- Es el ID del usuario en la API de Directory.
- La dirección de correo electrónico del usuario. Por ejemplo, users/222larabrown@gmail.com o users/larabrown@cymbalgroup.com. Si el usuario usa una Cuenta de Google o pertenece a otra organización de Google Workspace, debes usar su dirección de correo electrónico.

Escribe un script que llame a la API de Chat

En el siguiente ejemplo, se agrega un usuario a un espacio con autenticación de la app:

Python

En tu directorio de trabajo, crea un archivo llamado chat_membership_app_create.py.

Incluye el siguiente código en chat_membership_app_create.py:

from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then adds a user to a Chat space by creating a membership.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which user the membership is for.
        body = {
          'member': {
            'name':'users/USER',
            'type': 'HUMAN'
          }
        }

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

En el código, reemplaza lo siguiente:
- SPACE: Es el nombre de un espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.
- USER: Es un ID de usuario.
En tu directorio de trabajo, compila y ejecuta la muestra:
```
python3 chat_membership_app_create.py
```

Agrega usuarios o Grupos de Google a un espacio como administrador de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al método create() para agregar usuarios, Grupos de Google o apps de Chat a cualquier espacio de tu organización de Google Workspace.

Para llamar a este método como administrador de Google Workspace, haz lo siguiente:

Llama al método con la autenticación del usuario y especifica un alcance de autorización que admita llamar al método con privilegios de administrador.
En tu solicitud, especifica el parámetro de consulta useAdminAccess como true.

Para obtener más información y ejemplos, consulta Cómo administrar espacios de Google Chat como administrador de Google Workspace.

Limitaciones y consideraciones

Con la autenticación de la app, una app de Chat puede invitar o agregar usuarios, pero no Grupos de Google ni apps de Chat. Para agregarse, una app de Chat debe usar la autenticación de usuarios con el alcance de autorización chat.memberships.

Invitar o agregar a un usuario, un Grupo de Google o una app de Google Chat a un espacio Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Requisitos previos

Node.js

Python

Java

Apps Script

Invitar o agregar a un usuario a un espacio como usuario

Node.js

Python

Java

Apps Script

Invita o agrega un Grupo de Google a un espacio

Node.js

Python

Java

Apps Script

Agrega una app de Chat a un espacio

Node.js

Python

Java

Apps Script

Invita o agrega a un usuario a un espacio como app de Chat

Escribe un script que llame a la API de Chat

Python

Agrega usuarios o Grupos de Google a un espacio como administrador de Google Workspace

Limitaciones y consideraciones

Temas relacionados

Invitar o agregar a un usuario, un Grupo de Google o una app de Google Chat a un espacio