Invitare o aggiungere un utente, un gruppo Google o un'app Google Chat a uno spazio

Questa guida spiega come utilizzare il metodo create nella risorsa membership dell'API Google Chat per invitare o aggiungere un utente, un gruppo Google o un'app Chat a uno spazio noto anche come creazione di abbonamento. Durante la creazione di un abbonamento, se il membro specificato ha disattivato le norme di accettazione automatica, riceverà un invito e dovrà accettare l'invito allo spazio prima di partecipare. Altrimenti, se crei un'iscrizione, il membro viene aggiunto direttamente allo spazio specificato.

La risorsa Membership indica se un utente umano o un'app Google Chat è invitato, fa parte o è assente da uno spazio.

Prerequisiti

Python

  • Python 3.6 o versioni successive
  • Lo strumento di gestione dei pacchetti pip

  • Le librerie client di Google più recenti per Python. Per installarli o aggiornarli, esegui questo comando nell'interfaccia a riga di comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Un progetto Google Cloud con l'API Google Chat abilitata e configurata. Per i passaggi da seguire, vedi Creare un'app Google Chat.

  • Autorizzazione configurata per l'app Chat. Per creare un'iscrizione è necessaria l'autenticazione dell'utente con l'ambito di autorizzazione chat.memberships o chat.memberships.app.

Node.js

  • Node.js e npm

  • Le librerie client di Google più recenti per Node.js. Per installarle, esegui questo comando nell'interfaccia a riga di comando:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un progetto Google Cloud con l'API Google Chat abilitata e configurata. Per i passaggi da seguire, vedi Creare un'app Google Chat.

  • Autorizzazione configurata per l'app Chat. Per creare un'iscrizione è necessaria l'autenticazione dell'utente con l'ambito di autorizzazione chat.memberships o chat.memberships.app.

Invitare o aggiungere un utente a uno spazio

Per invitare o aggiungere un utente a uno spazio, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito dell'autorizzazione chat.memberships.
  • Chiama il metodo create sulla risorsa membership.
  • Imposta parent sul nome della risorsa dello spazio in cui creare l'appartenenza.
  • Imposta member su users/{user} dove {user} è la persona per la quale vuoi creare l'abbonamento e può:
    • L'ID della persona nell'API People. Ad esempio, se la persona resourceName dell'API People è people/123456789, imposta membership.member.name su users/123456789.
    • L'ID per l'utente nell'API Directory.
    • L'indirizzo email dell'utente. Ad esempio, users/222larabrown@gmail.com o users/larabrown@cymbalgroup.com. Se l'utente utilizza un Account Google o appartiene a un'altra organizzazione Google Workspace, devi utilizzare il suo indirizzo email.

Nell'esempio seguente, un utente viene aggiunto a uno spazio:

Python

  1. Nella directory di lavoro, crea un file denominato chat_membership_user_create.py.

  2. Includi il seguente codice in chat_membership_user_create.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.memberships"]

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

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # 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()

  3. Nel codice, sostituisci quanto segue:

    • SPACE: il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

    • USER: un ID utente.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_membership_user_create.py

Node.js

  1. Nella directory di lavoro, crea un file denominato add-user-to-space.js.

  2. Includi il seguente codice in add-user-to-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Adds the user to the Chat space.
* @return {!Promise<!Object>}
*/
async function addUserToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/USER', type: 'HUMAN'}}
  });
}

addUserToSpace().then(console.log);

  3. Nel codice, sostituisci quanto segue:

    • SPACE: il nome di uno spazio che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

    • USER: un ID utente.

  4. Nella directory di lavoro, esegui l'esempio:

    node add-user-to-space.js

L'API Chat restituisce un'istanza di membership che mostra in dettaglio l'abbonamento utente creato.

Invitare o aggiungere un gruppo Google a uno spazio

Per invitare o aggiungere un gruppo Google a uno spazio, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito dell'autorizzazione chat.memberships.
  • Chiama il metodo create sulla risorsa membership.
  • Imposta parent sul nome della risorsa dello spazio in cui creare l'appartenenza.
  • Imposta groupMember su groups/{group}, dove {group} è l'ID gruppo per cui vuoi creare l'iscrizione. L'ID per il gruppo può essere recuperato utilizzando l'API Cloud Identity. Ad esempio, se l'API Cloud Identity restituisce un gruppo con il nome groups/123456789, imposta membership.groupMember.name su groups/123456789.

I gruppi Google non possono essere aggiunti a una chat di gruppo o a un messaggio diretto, ma solo a uno spazio con nome. Nell'esempio seguente, un gruppo viene aggiunto a uno spazio denominato:

Python

  1. Nella directory di lavoro, crea un file denominato chat_membership_group_create.py.

  2. Includi il seguente codice in chat_membership_group_create.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds a group to a Chat space by creating a membership.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # 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 named space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which group the membership is for.
        body = {
          'groupMember': {
            'name':'groups/GROUP',
          }
        }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci quanto segue:

    • SPACE: il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

    • GROUP: un ID gruppo.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_membership_group_create.py

Node.js

  1. Nella directory di lavoro, crea un file denominato add-group-to-space.js.

  2. Includi il seguente codice in add-group-to-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Adds the group to the Chat space.
* @return {!Promise<!Object>}
*/
async function addUserToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {groupMember: {name: 'groups/GROUP'}}
  });
}

addUserToSpace().then(console.log);

  3. Nel codice, sostituisci quanto segue:

    • SPACE: il nome di uno spazio che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

    • GROUP: un ID gruppo.

  4. Nella directory di lavoro, esegui l'esempio:

    node add-group-to-space.js

L'API Chat restituisce un'istanza di membership che descrive in dettaglio l'iscrizione al gruppo creata.

Aggiungere un'app di Chat a uno spazio

Un'app di Chat non può aggiungere un'altra app come membro a uno spazio. Per aggiungere un'app di Chat a uno spazio o a un messaggio diretto tra due utenti, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito dell'autorizzazione chat.memberships.app.
  • Chiama il metodo create sulla risorsa membership.
  • Imposta parent sul nome della risorsa dello spazio in cui creare l'appartenenza.
  • Imposta member su users/app; un alias che rappresenta l'app che chiama l'API Chat.

Nell'esempio seguente viene aggiunta un'app di Chat a uno spazio:

Python

  1. Nella directory di lavoro, crea un file denominato chat_membership_app_create.py.

  2. Includi il seguente codice in chat_membership_app_create.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.memberships.app"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds the Chat app to a Chat space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # 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',

        # Set the Chat app as the entity that gets added to the space.
        # 'app' is an alias for the Chat app calling the API.
        body = {
            'member': {
              'name':'users/app',
              'type': 'BOT'
            }
        }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci SPACE con il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_membership_app_create.py

Node.js

  1. Nella directory di lavoro, crea un file denominato add-app-to-space.js.

  2. Includi il seguente codice in add-app-to-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Adds the app to the Chat space.
* @return {!Promise<!Object>}
*/
async function addAppToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships.app',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/app', type: 'BOT'}}
  });
}

addAppToSpace().then(console.log);

  3. Nel codice, sostituisci SPACE con il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

  4. Nella directory di lavoro, esegui l'esempio:

    node add-app-to-space.js

L'API Chat restituisce un'istanza di membership che descrive in dettaglio l'abbonamento all'app creato.