Creare uno spazio denominato in Google Chat

Questa guida spiega come creare uno spazio denominato utilizzando il metodo create() nella risorsa Space dell'API Google Chat.

Uno spazio denominato (in cui spaceType è SPACE) è un luogo in cui le persone inviano messaggi, condividono file e collaborano. Gli spazi con nome possono includere app di Chat. Gli spazi con nome hanno gestori che possono applicare impostazioni amministrative, descrizioni e aggiungere o rimuovere persone e app.

Per creare diversi tipi di spazi di Chat (inclusi messaggi diretti o di gruppo), utilizza il metodo setUp() sulla risorsa Space per creare lo spazio e aggiungere contemporaneamente i membri. Per maggiori dettagli, consulta la sezione Configurare uno spazio.

Dopo aver creato uno spazio denominato, l'unico membro dello spazio è l'utente autenticato. Per aggiungere membri allo spazio, chiama il metodo create() nella risorsa Membership per ogni persona o app che vuoi aggiungere. In alternativa, puoi utilizzare il metodo setUp() per creare uno spazio denominato e aggiungervi contemporaneamente i membri.

Prerequisiti

Node.js

Python

Java

Apps Script

Creare uno spazio denominato come utente

Per creare uno spazio denominato con autenticazione utente, passa quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.spaces.create o chat.spaces.
  • Chiama il metodo CreateSpace() passando space come istanza di Space con i seguenti campi:
    • SPACE impostato per spaceType.
    • displayName impostato sul nome visibile all'utente dello spazio.
    • Se vuoi, imposta altri attributi, ad esempio:
      • spaceDetails: una descrizione visibile all'utente e un insieme di linee guida per lo spazio.
      • predefinedPermissionSettings: autorizzazioni predefinite per lo spazio. Ad esempio, puoi configurarlo in modo che tutti i membri o solo i gestori dello spazio possano pubblicare messaggi.

Ecco come creare uno spazio denominato:

Node.js

chat/client-libraries/cloud/create-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

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

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_space_user_cred.py
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.spaces.create"]

def create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

Creare uno spazio denominato come app Chat

L'autenticazione delle app richiede un'approvazione dell'amministratore una tantum.

Per invitare o aggiungere un utente a uno spazio con autenticazione app, passa quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.app.spaces.create o chat.app.spaces.
  • Chiama il metodo create nella risorsa Space.
  • Imposta spaceType suSPACE.
  • Imposta displayName sul nome visibile all'utente dello spazio. Nell'esempio seguente, displayName è impostato su API-made.
  • Specifica l'ID cliente del dominio Google Workspace utilizzando il campo customer.
  • Se vuoi, imposta altri attributi dello spazio, ad esempio spaceDetails (una descrizione visibile all'utente e un insieme di linee guida per lo spazio).

Crea una chiave API

Per chiamare un metodo dell'API Anteprima per gli sviluppatori, devi utilizzare una versione di anteprima per gli sviluppatori non pubblica del documento di rilevamento API. Per autenticare la richiesta, devi passare una chiave API.

Per creare la chiave API, apri il progetto Google Cloud della tua app ed esegui i seguenti passaggi:

  1. Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.

    Vai a credenziali

  2. Fai clic su Crea credenziali > Chiave API.
  3. Viene visualizzata la nuova chiave API.
    • Fai clic su Copia per copiare la chiave API da utilizzare nel codice dell'app. La chiave API è disponibile anche nella sezione "Chiavi API" delle credenziali del progetto.
    • Fai clic su Limita chiave per aggiornare le impostazioni avanzate e limitare l'utilizzo della chiave API. Per maggiori dettagli, vedi Applicare limitazioni alle chiavi API.

Scrivi uno script che chiami l'API Chat

Ecco come creare uno spazio denominato:

Python

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

  2. Includi il seguente codice in chat_space_create_named_app.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.spaces.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

    # 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

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

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci quanto segue:

    • API_KEY: la chiave API che hai creato per creare l'endpoint di servizio per l'API Chat.

    • CUSTOMER: l'ID cliente del dominio dello spazio nel formato customer/{customer}, dove {customer} è il valore ID della risorsa cliente dell'SDK Admin. Per creare uno spazio nella stessa organizzazione Google Workspace dell'app Chat, utilizza customers/my_customer.

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

    python3 chat_space_create_named_app.py

Apri lo spazio in Google Chat

Per accedere allo spazio, utilizza l'ID risorsa dello spazio per creare l'URL dello spazio. Puoi trovare l'ID risorsa dello spazio name nel corpo della risposta di Google Chat. Ad esempio, se il name dello spazio è spaces/1234567, puoi accedere allo spazio utilizzando il seguente URL: https://mail.google.com/chat/u/0/#chat/space/1234567.