Aggiornare uno spazio

Questa guida spiega come utilizzare il metodo patch() nella risorsa Space dell'API Google Chat per aggiornare uno spazio. Aggiorna uno spazio per modificare gli attributi di uno spazio, come il nome visualizzato visibile agli utenti, la descrizione e le linee guida.

Se sei un amministratore di Google Workspace, puoi chiamare il metodo patch() per aggiornare qualsiasi spazio esistente nella tua organizzazione Google Workspace.

La risorsa Space rappresenta un luogo in cui persone e app di chat possono inviare messaggi, condividere file e collaborare. Esistono diversi tipi di spazi:

  • I messaggi diretti sono conversazioni tra due utenti o tra un utente e un'app di chat.
  • Le chat di gruppo sono conversazioni tra tre o più utenti e app di chat.
  • Gli spazi denominati sono luoghi permanenti in cui le persone inviano messaggi, condividono file e collaborano.

Prerequisiti

Node.js

Python

Java

Apps Script

Aggiornare uno spazio come utente

Per aggiornare uno spazio esistente in Google Chat con l'autenticazione utente, passa quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.spaces.
  • Chiama il metodo UpdateSpace(). Nella richiesta, specifica il campo spazio name, il campo updateMask con uno o più campi da aggiornare e un body con le informazioni aggiornate sullo spazio.

Puoi aggiornare elementi come il nome visualizzato, il tipo di spazio, lo stato della cronologia e altro ancora. Per visualizzare tutti i campi che puoi aggiornare, consulta la documentazione di riferimento.

Ecco come aggiornare il campo displayName di uno spazio esistente:

Node.js

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

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

// This sample shows how to update a 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: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_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"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

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

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

Per eseguire questo esempio, sostituisci SPACE_NAME con l'ID del campo name dello spazio. Puoi ottenere l'ID chiamando il metodo ListSpaces() o dall'URL dello spazio.

L'API Google Chat restituisce un'istanza di Space che riflette gli aggiornamenti.

Aggiornare uno spazio come amministratore di Google Workspace

Se sei un amministratore di Google Workspace, puoi chiamare il metodo UpdateSpace() per aggiornare qualsiasi spazio nella tua organizzazione Google Workspace.

Per chiamare questo metodo in qualità di amministratore di Google Workspace, procedi nel seguente modo:

  • Chiama il metodo utilizzando l'autenticazione utente e specifica un ambito di autorizzazione che supporti la chiamata del metodo utilizzando privilegi amministrativi.
  • Nella richiesta, specifica il parametro di query useAdminAccess su true.

Per ulteriori informazioni ed esempi, vedi Gestire gli spazi di Google Chat come amministratore di Google Workspace.

Aggiornare uno spazio come app di Chat

L'autenticazione dell'app richiede l'approvazione dell'amministratore una sola volta.

Per aggiornare uno spazio esistente in Google Chat con l'autenticazione dell'app, passa quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.app.spaces. Con l'autenticazione delle app, puoi aggiornare solo gli spazi creati dalle app di Chat.
  • Chiama il metodo patch sulla risorsa Space. Nella richiesta, specifica il campo name dello spazio, il campo updateMask con uno o più campi da aggiornare e un body con le informazioni aggiornate sullo spazio.

Puoi aggiornare elementi come il nome visualizzato, il tipo di spazio, lo stato della cronologia, le impostazioni delle autorizzazioni e altro ancora. Per visualizzare tutti i campi che puoi aggiornare, consulta la documentazione di riferimento.

Crea una chiave API

Per chiamare un metodo API di 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 e svolgi 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 può essere trovata 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, consulta Applicare le limitazioni relative alle chiavi API.

Scrivere uno script che chiama l'API Chat

Ecco come aggiornare il campo spaceDetails di uno spazio esistente:

Python

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

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

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

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

      # The space to update, and the updated space details.
      #
      # Replace {space} with a space name.
      # Obtain the space name from the spaces resource of Chat API,
      # or from a space's URL.
      name='spaces/SPACE',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci quanto segue:

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

    python3 chat_space_update_app.py

L'API Google Chat restituisce un'istanza della risorsa Space che riflette gli aggiornamenti.

Limitazioni e considerazioni