Package google.chat.v1

Indice

ChatService

Consente agli sviluppatori di creare app e integrazioni di Chat sulla piattaforma Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Completa il processo di importazione per lo spazio specificato e lo rende visibile agli utenti.

Richiede l'autenticazione utente e la delega a livello di dominio con l'ambito di autorizzazione:

  • https://www.googleapis.com/auth/chat.import

Per saperne di più, vedi Autorizzare le app Google Chat a importare dati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/chat.import

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Crea un'emoji personalizzata.

Le emoji personalizzate sono disponibili solo per gli account Google Workspace e l'amministratore deve attivarle per l'organizzazione. Per saperne di più, vedi Informazioni sulle emoji personalizzate in Google Chat e Gestire le autorizzazioni per le emoji personalizzate.

Richiede l'autenticazione utente con l'ambito di autorizzazione:

  • https://www.googleapis.com/auth/chat.customemojis
Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Crea un abbonamento per l'app Chat per le chiamate, un utente o un gruppo Google. La creazione di abbonamenti per altre app di chat non è supportata. Quando crei un abbonamento, se l'utente specificato ha disattivato la policy di accettazione automatica, viene invitato e deve accettare l'invito allo spazio prima di potervi accedere. In caso contrario, la creazione di un abbonamento aggiunge il membro direttamente allo spazio specificato.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con approvazione dell'amministratore e ambito di autorizzazione:

    • https://www.googleapis.com/auth/chat.app.memberships
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (per aggiungere l'app di chiamata allo spazio)
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)
    • L'autenticazione utente concede privilegi amministrativi quando un account amministratore esegue l'autenticazione, use_admin_access è true e viene utilizzato il seguente ambito di autorizzazione:
      • https://www.googleapis.com/auth/chat.admin.memberships

L'autenticazione dell'app non è supportata per i seguenti casi d'uso:

  • Invitare utenti esterni all'organizzazione Workspace proprietaria dello spazio.
  • Aggiunta di un gruppo Google a uno spazio.
  • Aggiunta di un'app di Chat a uno spazio.

Per un esempio di utilizzo, vedi:

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Crea un messaggio in uno spazio di Google Chat. Per un esempio, vedi Inviare un messaggio.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:
    • https://www.googleapis.com/auth/chat.bot
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)

Chat attribuisce il mittente del messaggio in modo diverso a seconda del tipo di autenticazione utilizzato nella richiesta.

L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione dell'app. Chat mostra l'app Chat come mittente del messaggio. Il contenuto del messaggio può includere testo (text), schede (cardsV2) e widget per accessori (accessoryWidgets).

Messaggio inviato con l'autenticazione dell'app

L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione utente. Chat mostra l'utente come mittente del messaggio e attribuisce l'app Chat al messaggio visualizzandone il nome. Il contenuto del messaggio può contenere solo testo (text).

Messaggio inviato con l'autenticazione utente

La dimensione massima del messaggio, inclusi i contenuti, è di 32.000 byte.

Per le richieste webhook, la risposta non contiene il messaggio completo. La risposta compila solo i campi name e thread.name, oltre alle informazioni contenute nella richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Crea una reazione e la aggiunge a un messaggio. Per un esempio, vedi Aggiungere una reazione a un messaggio.

Richiede l'autenticazione utente con uno dei seguenti ambiti di autorizzazione:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Crea uno spazio. Può essere utilizzato per creare uno spazio denominato o una chat di gruppo in Import mode. Per un esempio, vedi Creare uno spazio.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con approvazione dell'amministratore e uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)

Quando l'autenticazione viene eseguita come app, il campo space.customer deve essere impostato nella richiesta.

Quando l'autenticazione viene eseguita come app, l'app Chat viene aggiunta come membro dello spazio. Tuttavia, a differenza dell'autenticazione umana, l'app Chat non viene aggiunta come gestore dello spazio. Per impostazione predefinita, l'app Chat può essere rimossa dallo spazio da tutti i membri dello spazio. Per consentire solo ai gestori dello spazio di rimuovere l'app da uno spazio, imposta space.permission_settings.manage_apps su managers_allowed.

L'abbonamento allo spazio al momento della creazione dipende dal fatto che lo spazio venga creato in Import mode:

  • Modalità di importazione:non vengono creati membri.
  • Tutte le altre modalità:l'utente che chiama viene aggiunto come membro. ovvero:
    • L'app stessa quando utilizzi l'autenticazione dell'app.
    • L'utente umano quando utilizza l'autenticazione utente.

Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio, prova un displayName diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Elimina un'emoji personalizzata. Per impostazione predefinita, gli utenti possono eliminare solo le emoji personalizzate che hanno creato. I gestori di emoji assegnati dall'amministratore possono eliminare qualsiasi emoji personalizzata nell'organizzazione. Consulta l'articolo Informazioni sulle emoji personalizzate in Google Chat.

Le emoji personalizzate sono disponibili solo per gli account Google Workspace e l'amministratore deve attivarle per l'organizzazione. Per saperne di più, vedi Informazioni sulle emoji personalizzate in Google Chat e Gestire le autorizzazioni per le emoji personalizzate.

Richiede l'autenticazione utente con l'ambito di autorizzazione:

  • https://www.googleapis.com/auth/chat.customemojis
Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

DeleteMembership

rpc DeleteMembership(