Autentica come app Google Chat

Questa guida spiega come configurare e utilizzare un service account per accedere all'API Google Chat per conto di un'app Chat. Innanzitutto, ti illustra come creare un service account. Poi, mostra come scrivere uno script che utilizza l'account di servizio per l'autenticazione con l'API Chat e pubblicare un messaggio in uno spazio Chat.

Quando l'autenticazione viene eseguita con un service account, per ottenere dati o eseguire azioni in uno spazio di Chat, le app di Chat devono essere membri dello spazio. Ad esempio, per elencare i membri di uno spazio o per creare un messaggio in uno spazio, l'app Chat deve essere un membro dello spazio. L'unica eccezione si verifica quando un'app di chat crea uno spazio con l'autenticazione dell'app, nel qual caso l'app crea lo spazio e poi diventa automaticamente un membro.

I metodi dell'API Google Chat che supportano l'autorizzazione delle app con ambiti di autorizzazione i cui nomi iniziano con https://www.googleapis.com/auth/chat.app.* richiedono l'approvazione dell'amministratore una sola volta. I metodi dell'API Google Chat che supportano l'autorizzazione dell'app con l'ambito di autorizzazione https://www.googleapis.com/auth/chat.bot non richiedono un'approvazione aggiuntiva. Gli ambiti di autorizzazione https://www.googleapis.com/auth/chat.app.* sono disponibili in anteprima per sviluppatori.

Se la tua app di chat deve accedere ai dati utente o eseguire azioni per conto di un utente, esegui l'autenticazione come utente. Se sei un amministratore di dominio, puoi concedere la delega dell'autorità a livello di dominio per autorizzare l'account di servizio di un'app di chat ad accedere ai dati dei tuoi utenti senza richiedere il consenso di ciascun utente. Per maggiori informazioni, vedi Autenticazione e autorizzazione tramite la delega a livello di dominio.

Per scoprire di più su quando le app di Chat richiedono l'autenticazione e quale tipo di autenticazione utilizzare, vedi Tipi di autenticazione richiesti nella panoramica dell'autenticazione e dell'autorizzazione dell'API Chat.

Prerequisiti

Java

  • JDK 1.7 o versioni successive
  • Lo strumento di gestione dei pacchetti Maven
  • Un progetto Maven inizializzato. Per inizializzare un nuovo progetto, esegui questo comando nell'interfaccia a riga di comando: 
    mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
  • Un'app Google Chat che riceve e risponde agli eventi di interazione. Per creare un'app Chat interattiva utilizzando un servizio HTTP, completa questa guida rapida.
  • Aggiungi l'app Chat a uno spazio. Per aggiungere l'app Chat, vedi Testare le funzionalità interattive per le app Google Chat.

Python

Node.js

Apps Script

Passaggio 1: crea un service account nella console Google Cloud

Crea un service account che la tua app Chat possa utilizzare per accedere alle API di Google.

Crea un account di servizio

Per creare un service account:

Console Google Cloud

  1. Nella console Google Cloud, vai a Menu > IAM e amministrazione > Service account.

    Vai a Service account

  2. Fai clic su Crea account di servizio.
  3. Compila i dettagli del service account, quindi fai clic su Crea e continua.
  4. (Facoltativo) Assegna ruoli al tuo service account per concedere l'accesso alle risorse del tuo progetto Google Cloud. Per ulteriori dettagli, consulta Concessione, modifica e revoca dell'accesso alle risorse.
  5. Fai clic su Continua.
  6. (Facoltativo) Inserisci gli utenti o i gruppi che possono gestire ed eseguire azioni con questo service account. Per maggiori dettagli, consulta Gestione dell'impersonificazione degli account di servizio.
  7. Fai clic su Fine. Prendi nota dell'indirizzo email del service account.

Interfaccia a riga di comando gcloud

  1. Crea l'account di servizio: 
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"
  2. (Facoltativo) Assegna ruoli al tuo service account per concedere l'accesso alle risorse del tuo progetto Google Cloud. Per ulteriori dettagli, consulta Concessione, modifica e revoca dell'accesso alle risorse.

L'account di servizio viene visualizzato nella pagina degli account di servizio. Poi, crea una chiave privata per il service account.

Crea una chiave privata

Per creare e scaricare una chiave privata per il service account, segui questi passaggi:

  1. Nella console Google Cloud, vai a Menu > IAM e amministrazione > Service account.

    Vai a Service account

  2. Seleziona il tuo service account.
  3. Fai clic su Chiavi > Aggiungi chiave > Crea nuova chiave.
  4. Seleziona JSON, quindi fai clic su Crea.

    Una nuova coppia di chiavi pubblica/privata viene generata e scaricata sul tuo computer come nuovo file. Salva il file JSON scaricato come credentials.json nella directory di lavoro. Questo file è l'unica copia di questa chiave. Per informazioni su come archiviare la chiave in modo sicuro, consulta la sezione Gestire le chiavi degli account di servizio.

  5. Fai clic su Chiudi.

Per saperne di più sui service account, consulta la sezione Service account nella documentazione di Google Cloud IAM.

Successivamente, crea un client OAuth compatibile con Google Workspace Marketplace per questo service account.

Ricevere l'approvazione dell'amministratore

Per utilizzare l'ambito di autorizzazione https://www.googleapis.com/auth/chat.bot, non è necessaria l'approvazione dell'amministratore. Vai a Passaggio 2: installa la libreria client Google e altre dipendenze. L'esempio in questa guida utilizza l'ambito di autorizzazione https://www.googleapis.com/auth/chat.bot, quindi se segui l'esempio, vai al passaggio 2.

Per utilizzare un ambito di autorizzazione che inizia con https://www.googleapis.com/auth/chat.app.*, disponibili nell'ambito di un'anteprima per gli sviluppatori, la tua app di chat deve ottenere un'approvazione dell'amministratore una tantum.

Per ricevere l'approvazione dell'amministratore, devi preparare il service account dell'app Chat con le seguenti informazioni:

  • Un client OAuth compatibile con Google Workspace Marketplace.
  • Configurazione dell'app nell'SDK di Google Workspace Marketplace.

Crea un client OAuth compatibile con Google Workspace Marketplace

Per creare un client OAuth compatibile con Google Workspace Marketplace:

  1. Nella console Google Cloud, vai a Menu > IAM e amministrazione > Service account.

    Vai a Service account

  2. Fai clic sull'account di servizio che hai creato per la tua app di chat.

  3. Fai clic su Impostazioni avanzate.

  4. Fai clic su Crea client OAuth compatibile con Google Workspace Marketplace.

  5. Fai clic su Continua.

Viene visualizzato un messaggio di conferma che indica che è stato creato un client OAuth compatibile con Google Workspace Marketplace.

Configurare l'app di chat nell'SDK di Google Workspace Marketplace

Per configurare l'app Chat nell'SDK di Google Workspace Marketplace:

  1. Nella console Google Cloud, abilita l'SDK di Google Workspace Marketplace.

    Attivare l'SDK di Google Workspace Marketplace

  2. Nella console Google Cloud, vai a Menu > API e servizi > API e servizi abilitati > SDK Google Workspace Marketplace > Configurazione app.

    Vai a Configurazione app

  3. Completa la pagina Configurazione app. La configurazione dell'app Chat dipende dal pubblico di destinazione e da altri fattori. Per assistenza nella compilazione della pagina di configurazione dell'app, vedi Configurare l'app nell'SDK di Google Workspace Marketplace. Ai fini di questa guida, inserisci le seguenti informazioni:

    1. In Visibilità app, seleziona Privato.
    2. Nella sezione Impostazioni di installazione, seleziona Installazione individuale + amministratore.
    3. In Integrazioni app, seleziona App di chat.

    4. In Ambiti OAuth, inserisci tutti gli ambiti di autenticazione utilizzati dalla tua app Chat.

    5. In Informazioni sviluppatore, inserisci il Nome sviluppatore, l'URL del sito web sviluppatore e l'Email sviluppatore.

    6. Fai clic su Salva bozza.

Ottenere l'approvazione dell'amministratore

Ora che l'account di servizio è configurato per ricevere l'approvazione dell'amministratore, ottienila da un amministratore di Google Workspace che può concederla seguendo i passaggi descritti in Configurare l'autorizzazione per le app di chat.

Passaggio 2: installa la libreria client Google e altre dipendenze

Installa la libreria client Google e altre dipendenze richieste per il progetto.

Java

Per aggiungere le librerie client Google e altre dipendenze richieste al tuo progetto Maven, modifica il file pom.xml nella directory del progetto e aggiungi le seguenti dipendenze:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

Se non hai ancora installato le librerie client Google per Python, esegui il seguente comando nell'interfaccia a riga di comando:

pip3 install --upgrade google-api-python-client google-auth

Node.js

Per aggiungere le librerie client Google al tuo progetto Node.js, passa alla directory del progetto ed esegui questo comando nell'interfaccia a riga di comando:

npm install "@googleapis/chat"

Apps Script

Questo esempio utilizza la libreria OAuth2 per Apps Script per generare un token JWT per l'autenticazione del service account. Per aggiungere la libreria al tuo progetto Apps Script:

  1. A sinistra, fai clic su Editor .
  2. A sinistra, accanto a Librerie, fai clic su Aggiungi una libreria .
  3. Inserisci l'ID script 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
  4. Fai clic su Cerca e poi su Aggiungi.

Questo esempio utilizza il servizio Advanced Chat per chiamare l'API Google Chat. Per attivare il servizio per il tuo progetto Apps Script:

  1. A sinistra, fai clic su Editor .
  2. A sinistra, accanto a Servizi, fai clic su Aggiungi un servizio .
  3. Seleziona API Google Chat.
  4. In Versione, seleziona v1.
  5. Fai clic su Aggiungi.

Puoi utilizzare qualsiasi lingua supportata dalle nostre librerie client.

Passaggio 3: scrivi uno script che utilizzi il service account per l'autenticazione con l'API Chat

Il seguente codice esegue l'autenticazione con l'API Chat utilizzando un service account, quindi pubblica un messaggio in uno spazio Chat:

Java

  1. Nella directory del progetto, apri il file src/main/java/com/google/chat/app/authsample/App.java.

  2. Sostituisci i contenuti di App.java con il seguente codice:

    package com.google.chat.app.authsample;

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.chat.v1.HangoutsChat;
import com.google.api.services.chat.v1.model.Message;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;

/**
 * Authenticates with Chat API using service account credentials,
 * then creates a Chat message.
 */
public class App {
    // Specify required scopes.
    private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";

    // Specify service account details.
    private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";

    public static void main( String[] args ) {
        try {
            // Run app.
            Message response = App.createChatMessage();
            // Print details about the created message.
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static Message createChatMessage() throws Exception {
        // Build the Chat API client and authenticate with the service account.
        GoogleCredentials credentials = GoogleCredentials.fromStream(
            App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
            .createScoped(CHAT_SCOPE);
        HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
        HangoutsChat chatService = new HangoutsChat.Builder(
            GoogleNetHttpTransport.newTrustedTransport(),
            GsonFactory.getDefaultInstance(),
            requestInitializer)
            .setApplicationName("auth-sample-app")
            .build();

        // The space to create the message in.
        //
        // Replace SPACE_NAME with a space name.
        // Obtain the space name from the spaces resource of Chat API,
        // or from a space's URL.
        String spaceName = "spaces/SPACE_NAME";

        // Create a Chat message.
        Message message = new Message().setText("Hello, world!");
        return chatService.spaces().messages().create(spaceName, message).execute();
    }
}

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

  4. Crea una nuova sottodirectory denominata resources all'interno della directory del progetto.

  5. Assicurati che il file della chiave privata per il tuo service account si chiami credentials.json e copialo nella sottodirectory resources.

  6. Per configurare Maven in modo da includere il file della chiave privata nel pacchetto del progetto, modifica il file pom.xml nella directory del progetto e aggiungi la seguente configurazione alla sezione <build>:

    <build>
  <!-- ... existing configurations ... -->
  <resources>
    <resource>
      <directory>resources</directory>
    </resource>
  </resources>
</build>

  7. Per configurare Maven in modo da includere le dipendenze nel pacchetto del progetto ed eseguire la classe principale dell'applicazione, modifica il file pom.xml nella directory del progetto e aggiungi la seguente configurazione alla sezione <plugins>:

    <plugins>
  <!-- ... existing configurations ... -->
  <plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
      <archive>
        <manifest>
          <mainClass>com.google.chat.app.authsample.App</mainClass>
        </manifest>
      </archive>
      <descriptorRefs>
        <descriptorRef>jar-with-dependencies</descriptorRef>
      </descriptorRefs>
    </configuration>
  </plugin>
</plugins>

Python

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

  2. Includi il seguente codice in chat_app_auth.py:

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

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

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

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=creds)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE_NAME with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE_NAME',

    # The message to create.
    body={'text': 'Hello, world!'}

).execute()

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

  3. Nel codice, sostituisci SPACE_NAME con il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio. Assicurati che il file della chiave privata per il service account si chiami credentials.json.

Node.js

  1. Nella directory del progetto, crea un file denominato chat_app_auth.js.

  2. Includi il seguente codice in chat_app_auth.js:

    const chat = require('@googleapis/chat');

async function createMessage() {
  const auth = new chat.auth.GoogleAuth({

    // Specify service account details.
    keyFilename: 'credentials.json',

    // Specify required scopes.
    scopes: ['https://www.googleapis.com/auth/chat.bot']

  });
  const authClient = await auth.getClient();

  // Create the Chat API client and authenticate with the service account.
  const chatClient = await chat.chat({
    version: 'v1',
    auth: authClient
  });

  // Create a Chat message.
  const result = await chatClient.spaces.messages.create({

    // The space to create the message in.
    //
    // Replace SPACE_NAME with a space name.
    // Obtain the space name from the spaces resource of Chat API,
    // or from a space's URL.
    parent: 'spaces/SPACE_NAME',

    // The message to create.
    requestBody: { 'text': 'Hello, world!' }

  });
  return result;
}

// Execute function then print details about the created message.
createMessage().then(console.log);

  3. Nel codice, sostituisci SPACE_NAME con il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio. Assicurati che il file della chiave privata per il service account si chiami credentials.json.

Apps Script

  1. Nell'editor Apps Script, modifica il file appsscript.json e aggiungi l'ambito OAuth necessario per effettuare richieste esterne per ottenere il token OAuth dell'account di servizio:

      "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request"
  ]

  2. Salva il seguente codice in un file denominato ChatAppAuth.gs nel progetto Apps Script:

    // Specify the contents of the file credentials.json.
const CREDENTIALS = CREDENTIALS;

const SCOPE = 'https://www.googleapis.com/auth/chat.bot';

// The space to create the message in.
//
// Replace SPACE_NAME with a space name.
// Obtain the space name from the spaces resource of Chat API,
// or from a space's URL.
const PARENT = 'spaces/SPACE_NAME'

/**
 * Authenticates with Chat API using app credentials, then posts a message.
 */
function createMessageWithAppCredentials() {
  try {
    const service = getService_();
    if (!service.hasAccess()) {
      console.error(service.getLastError());
      return;
    }

    // Specify the message to create.
    const message = {'text': 'Hello world!'};

    // Call Chat API with a service account to create a message.
    const result = Chat.Spaces.Messages.create(
        message,
        PARENT,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + service.getAccessToken()});

    // Log details about the created message.
    console.log(result);

  } catch (err) {
    // TODO (developer) - Handle exception.
    console.log('Failed to create message with error %s', err.message);
  }
}

/**
 * Configures the OAuth library to authenticate with the service account.
 */
function getService_() {
  return OAuth2.createService(CREDENTIALS.client_email)
      .setTokenUrl('https://oauth2.googleapis.com/token')
      .setPrivateKey(CREDENTIALS.private_key)
      .setIssuer(CREDENTIALS.client_email)
      .setSubject(CREDENTIALS.client_email)
      .setScope(SCOPE)
      .setPropertyStore(PropertiesService.getScriptProperties());
}

  3. Nel codice, sostituisci CREDENTIALS con i contenuti del file credentials.json.

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

Passaggio 4: esegui l'esempio completo

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

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Script

Apri il file ChatAppAuth.gs nell'editor di Apps Script e fai clic su Esegui.

Lo script effettua una richiesta autenticata all'API Chat, che risponde pubblicando un messaggio in uno spazio di Chat come app di Chat.

Risolvi i problemi relativi all'esempio

Questa sezione descrive i problemi comuni che potresti riscontrare quando tenti di eseguire questo esempio.

Non ti è consentito utilizzare questa app

Quando esegui lo script, potresti ricevere un errore che indica:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

Questo messaggio di errore indica che l'app Chat non dispone dell'autorizzazione per creare messaggi di Chat nello spazio Chat specificato.

Per risolvere l'errore, aggiungi l'app Chat allo spazio di Chat specificato nello script.

Per questa azione, l'amministratore deve concedere all'app l'ambito di autorizzazione OAuth richiesto

Quando esegui lo script, potresti ricevere un errore che indica:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}?alt=json returned "The administrator must grant the app the required OAuth authorization scope for this action.". Details: "The administrator must grant the app the required OAuth authorization scope for this action.">

Questo messaggio di errore indica che un amministratore di Google Workspace non ha ancora concesso l'approvazione una tantum all'app Chat per utilizzare gli ambiti di autorizzazione che iniziano con il nome https://www.googleapis.com/auth/chat.app.*.

Per risolvere l'errore:

  • Chiedi all'amministratore di Google Workspace di concedere l'approvazione alla tua app Chat. Quando gestisci questo errore nella logica dell'app Chat, valuta la possibilità di inviare un messaggio che annuncia che l'app Chat ha bisogno dell'approvazione dell'amministratore per eseguire l'azione richiesta, ad esempio: To perform this action, I need approval. <https://support.google.com/a?p=chat-app-auth|Learn more>.
  • Se il metodo dell'API Google Chat supporta l'ambito di autorizzazione https://www.googleapis.com/auth/chat.bot, che non richiede l'approvazione dell'amministratore, valuta la possibilità di utilizzarlo. Per verificare quali ambiti di autorizzazione supporta un metodo, consulta la documentazione di riferimento dell'API Google Chat.