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(DeleteMembershipRequest) returns (Membership)

Elimina un abbonamento. Per un esempio, vedi Rimuovere un utente o un'app Google Chat da uno spazio.

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 rimuovere l'app di chiamata dallo 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:

  • Rimozione di un gruppo Google da uno spazio.
  • Rimozione di un'app di chat da uno spazio.

Per eliminare le iscrizioni dei gestori dello spazio, il richiedente deve essere un gestore dello spazio. Se utilizzi l'autenticazione dell'app, l'app Chat deve essere il creatore dello spazio.

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.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Elimina un messaggio. Per un esempio, vedi Eliminare 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
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)

Quando utilizzi l'autenticazione dell'app, le richieste possono eliminare solo i messaggi creati dall'app Chat chiamante.

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Elimina una reazione a un messaggio. Per un esempio, vedi Eliminare una reazione.

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

  • 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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Elimina uno spazio denominato. Esegue sempre un'eliminazione a cascata, il che significa che vengono eliminate anche le risorse secondarie dello spazio, come i messaggi pubblicati nello spazio e le iscrizioni allo spazio. Per un esempio, vedi Eliminare uno spazio.

Supporta i seguenti tipi di autenticazione:

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

    • https://www.googleapis.com/auth/chat.app.delete (solo negli spazi creati dall'app)
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.delete
    • 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.delete
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Restituisce il messaggio diretto esistente con l'utente specificato. Se non viene trovato alcuno spazio per i messaggi diretti, viene restituito un errore 404 NOT_FOUND. Per un esempio, consulta la sezione Trovare un messaggio diretto.

Con l'autenticazione dell'app, restituisce lo spazio di messaggi diretti tra l'utente specificato e l'app di Chat chiamante.

Con l'autenticazione utente, restituisce lo spazio dei messaggi diretti tra l'utente specificato e l'utente autenticato.

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.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Recupera i metadati di un allegato del messaggio. I dati degli allegati vengono recuperati utilizzando l'API Media. Per un esempio, vedi Recuperare i metadati di un allegato di un messaggio.

Richiede l'autenticazione dell'app con l'ambito di autorizzazione:

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

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Restituisce i dettagli di 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 uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Restituisce i dettagli di un abbonamento. Per un esempio, vedi Visualizzare i dettagli dell'iscrizione di un utente o di un'app Google Chat.

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • L'autenticazione utente concede privilegi amministrativi quando un account amministratore esegue l'autenticazione, use_admin_access è true e viene utilizzato uno dei seguenti ambiti di autorizzazione:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Restituisce i dettagli di un messaggio. Per un esempio, vedi Visualizzare i dettagli di un messaggio.

Supporta i seguenti tipi di autenticazione:

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

    • https://www.googleapis.com/auth/chat.bot: quando utilizzi questo ambito di autorizzazione, questo metodo restituisce i dettagli di un messaggio a cui l'app Chat ha accesso, come i messaggi diretti e i comandi slash che richiamano l'app Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly con approvazione dell'amministratore (disponibile in Anteprima per gli sviluppatori). Quando utilizzi questo ambito di autenticazione, questo metodo restituisce i dettagli di un messaggio pubblico in uno spazio.
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

Nota: potrebbe restituire un messaggio di un membro o spazio bloccato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Restituisce i dettagli di uno spazio. Per un esempio, vedi Visualizzare i dettagli di uno spazio.

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • L'autenticazione utente concede privilegi amministrativi quando un account amministratore esegue l'autenticazione, use_admin_access è true e viene utilizzato uno dei seguenti ambiti di autorizzazione:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

L'autenticazione delle app presenta le seguenti limitazioni:

  • space.access_settings viene compilato solo quando viene utilizzato l'ambito chat.app.spaces.
  • space.predefind_permission_settings e space.permission_settings vengono compilati solo quando viene utilizzato l'ambito chat.app.spaces e solo per gli spazi creati dall'app.
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Restituisce un evento da uno spazio Google Chat. Il payload dell'evento contiene la versione più recente della risorsa modificata. Ad esempio, se richiedi un evento relativo a un nuovo messaggio, ma il messaggio è stato aggiornato in un secondo momento, il server restituisce la risorsa Message aggiornata nel payload dell'evento.

Nota: il campo permissionSettings non viene restituito nell'oggetto Space dei dati degli eventi dello spazio per questa richiesta.

Supporta i seguenti tipi di autenticazione con un ambito di autorizzazione appropriato per la lettura dei dati richiesti:

  • Autenticazione dell'app con approvazione dell'amministratore nella Developer Preview con uno dei seguenti ambiti di autorizzazione:

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

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Per ottenere un evento, il chiamante autenticato deve essere un membro dello spazio.

Per un esempio, vedi Visualizzare i dettagli di un evento da uno spazio Google Chat.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Recupera l'impostazione di notifica dello spazio. Per un esempio, vedi Recuperare l'impostazione di notifica dello spazio del chiamante.

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

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

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Restituisce i dettagli sullo stato di lettura di un utente all'interno di uno spazio, utilizzati per identificare i messaggi letti e non letti. Per un esempio, vedi Visualizzare i dettagli sullo stato di lettura di uno spazio di un utente.

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

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Restituisce i dettagli sullo stato di lettura di un utente all'interno di un thread, utilizzati per identificare i messaggi letti e non letti. Per un esempio, vedi Visualizzare i dettagli sullo stato di lettura di un thread di un utente.

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

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Elenca le emoji personalizzate visibili all'utente autenticato.

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 uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Elenca le iscrizioni in uno spazio. Per un esempio, vedi Elencare utenti e app Google Chat in uno spazio. L'elenco delle iscrizioni con autenticazione app elenca le iscrizioni agli spazi a cui l'app Chat ha accesso, ma esclude le iscrizioni all'app Chat, inclusa la propria. L'elenco delle iscrizioni con Autenticazione utente mostra le iscrizioni agli spazi a cui l'utente autenticato ha accesso.

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • 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 uno dei seguenti ambiti di autorizzazione:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Elenca i messaggi in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da membri e spazi bloccati. I messaggi di sistema, come quelli che annunciano i nuovi membri dello spazio, non sono inclusi. Se elenchi i messaggi di uno spazio senza messaggi, la risposta è un oggetto vuoto. Quando utilizzi un'interfaccia REST/HTTP, la risposta contiene un oggetto JSON vuoto, {}. Per un esempio, vedi Elenco dei messaggi.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con approvazione dell'amministratore nella Developer Preview con l'ambito di autorizzazione:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Quando utilizzi questo ambito di autenticazione, questo metodo restituisce solo i messaggi pubblici in uno spazio. Non include i messaggi privati.
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • 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.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Elenca le reazioni a un messaggio. Per un esempio, vedi Elencare le reazioni a un messaggio.

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

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Elenca gli eventi di uno spazio Google Chat. Per ogni evento, il payload contiene la versione più recente della risorsa Chat. Ad esempio, se elenchi eventi relativi a nuovi membri dello spazio, il server restituisce risorse Membership che contengono i dettagli di appartenenza più recenti. Se sono stati rimossi nuovi membri durante il periodo richiesto, il payload dell'evento contiene una risorsa Membership vuota.

Supporta i seguenti tipi di autenticazione con un ambito di autorizzazione appropriato per la lettura dei dati richiesti:

  • Autenticazione dell'app con approvazione dell'amministratore nella Developer Preview con uno dei seguenti ambiti di autorizzazione:

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

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Per elencare gli eventi, il chiamante autenticato deve essere un membro dello spazio.

Per un esempio, vedi Elencare gli eventi di uno spazio Google Chat.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Elenca gli spazi di cui il chiamante è membro. Le chat di gruppo e i messaggi diretti non vengono visualizzati finché non viene inviato il primo messaggio. Per un esempio, vedi Elenco degli spazi.

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.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Per elencare tutti gli spazi denominati per organizzazione Google Workspace, utilizza il metodo spaces.search() con i privilegi di amministratore di Workspace.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Restituisce un elenco di spazi in un'organizzazione Google Workspace in base alla ricerca di un amministratore. Nella richiesta, imposta use_admin_access su true. Per un esempio, vedi Cercare e gestire spazi.

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

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Crea uno spazio e vi aggiunge gli utenti specificati. L'utente chiamante viene aggiunto automaticamente allo spazio e non deve essere specificato come membro nella richiesta. Per un esempio, vedi Configurare uno spazio con i membri iniziali.

Per specificare i membri umani da aggiungere, aggiungi le iscrizioni con il membership.member.name appropriato. Per aggiungere un utente umano, utilizza users/{user}, dove {user} può essere l'indirizzo email dell'utente. Per gli utenti della stessa organizzazione Workspace, {user} può essere anche id per la persona dell'API People o id per l'utente dell'API Directory. Ad esempio, se l'ID profilo persona dell'API People per [email protected] è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/[email protected] o users/123456789.

Per specificare i gruppi Google da aggiungere, aggiungi le iscrizioni con il membership.group_member.name appropriato. Per aggiungere o invitare un gruppo Google, utilizza groups/{group}, dove {group} è id per il gruppo dell'API Cloud Identity Groups. Ad esempio, puoi utilizzare l'API Cloud Identity Groups Lookup per recuperare l'ID 123456789 per l'email di gruppo [email protected], quindi puoi aggiungere il gruppo allo spazio impostando membership.group_member.name su groups/123456789. L'email di gruppo non è supportata e i gruppi Google possono essere aggiunti solo come membri negli spazi denominati.

Per uno spazio o una chat di gruppo con nome, se il chiamante blocca o è bloccato da alcuni membri oppure non dispone dell'autorizzazione per aggiungere alcuni membri, questi non vengono aggiunti allo spazio creato.

Per creare un messaggio diretto (DM) tra l'utente chiamante e un altro utente umano, specifica esattamente un'iscrizione per rappresentare l'utente umano. Se un utente blocca l'altro, la richiesta non va a buon fine e il messaggio diretto non viene creato.

Per creare un messaggio diretto tra l'utente chiamante e l'app chiamante, imposta Space.singleUserBotDm su true e non specificare abbonamenti. Puoi utilizzare questo metodo solo per configurare un messaggio diretto con l'app di chiamata. Per aggiungere l'app di chiamata come membro di uno spazio o di un messaggio diretto esistente tra due utenti umani, vedi Invitare o aggiungere un utente o un'app a uno spazio.

Se esiste già un messaggio diretto tra due utenti, anche se uno blocca l'altro al momento dell'invio di una richiesta, viene restituito il messaggio diretto esistente.

Gli spazi con risposte in thread non sono supportati. Se ricevi il messaggio di errore ALREADY_EXISTS durante la configurazione di uno spazio, prova un displayName diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Aggiorna un abbonamento. Per un esempio, vedi Aggiornare l'appartenenza di un utente a uno spazio.

Supporta i seguenti tipi di autenticazione: