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 delle app e la delega a livello di dominio. 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.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Crea un abbonamento umano o all'app per l'app per le chiamate. La creazione di abbonamenti per altre app non è supportata. Ad esempio, vedi Invitare o aggiungere un utente o un'app Google Chat a uno spazio. Durante la creazione di un abbonamento, se il membro specificato ha disattivato le norme di accettazione automatica, riceverà un invito e dovrà accettare l'invito allo spazio prima di partecipare. Altrimenti, se crei un'iscrizione, il membro verrà aggiunto direttamente allo spazio specificato. Richiede l'autenticazione dell'utente.

Per specificare il membro da aggiungere, imposta membership.member.name per l'utente o il membro dell'app oppure imposta membership.group_member.name per il membro del gruppo.

  • Per aggiungere l'app per le chiamate a uno spazio o a un messaggio diretto tra due utenti, usa users/app. Impossibile aggiungere altre app allo spazio.

  • 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ò anche essere il id per la persona dell'API People o il id per l'utente nell'API Directory. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com o users/123456789.

  • Per aggiungere o invitare un gruppo Google in uno spazio denominato, utilizza groups/{group}, dove {group} è il id del 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 group@example.com, quindi puoi aggiungere o invitare il gruppo in uno spazio denominato impostando membership.group_member.name su groups/123456789. L'email del gruppo non è supportata e i gruppi Google possono essere aggiunti solo come membri di spazi denominati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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. La dimensione massima dei messaggi, inclusi testo e schede, è di 32.000 byte. Per un esempio, vedi Inviare un messaggio.

La chiamata di questo metodo richiede l'autenticazione e supporta i seguenti tipi di autenticazione:

  • Per i messaggi è supportata l'autenticazione utente o l'autenticazione delle app.
  • Per i messaggi cartacei è supportata solo l'autenticazione app. Solo le app di chat possono creare messaggi di schede.
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. Sono supportate solo le emoji Unicode. Ad esempio, vedi Aggiungere una reazione a un messaggio. Richiede l'autenticazione dell'utente.

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 denominato. Gli spazi raggruppati per argomento non sono supportati. Ad esempio, vedi Creare uno spazio.

Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Richiede l'autenticazione dell'utente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Richiede l'autenticazione dell'utente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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. Ad esempio, vedi Eliminare un messaggio.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti. Quando utilizzi l'autenticazione delle app, le richieste possono eliminare solo i messaggi creati dall'app Chat che chiama.

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. Sono supportate solo le emoji Unicode. Ad esempio, vedi Eliminare una reazione. Richiede l'autenticazione dell'utente.

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 e le iscrizioni allo spazio. Ad esempio, vedi Eliminare uno spazio. Richiede l'autenticazione dell'utente da parte di un utente che dispone dell'autorizzazione per eliminare lo spazio.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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 nessuno spazio per i messaggi diretti, restituisce un errore 404 NOT_FOUND. Per un esempio, vedi Trovare un messaggio diretto.

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

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

Richiede l'autenticazione dell'utente o l'autenticazione delle app.

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 dell'allegato di un messaggio. I dati degli allegati vengono recuperati utilizzando l'API Media. Per un esempio, vedi Recuperare i metadati relativi all'allegato di un messaggio. Richiede l'autenticazione delle app.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Restituisce i dettagli di un abbonamento. Per un esempio, consulta Ottenere dettagli sull'abbonamento di un utente o di un'app Google Chat.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

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.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 Ottenere dettagli su un messaggio.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

Nota: potrebbe restituire un messaggio proveniente da un membro o da uno spazio bloccati.

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Restituisce i dettagli di uno spazio. Per un esempio, consulta Ottenere i dettagli su uno spazio.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Restituisce un evento da uno spazio di Google Chat. Il payload evento contiene la versione più recente della risorsa che è stata modificata. Ad esempio, se richiedi un evento per un nuovo messaggio, ma quest'ultimo è stato successivamente aggiornato, il server restituisce la risorsa Message aggiornata nel payload dell'evento.

Richiede l'autenticazione dell'utente. Per ricevere un evento, l'utente autenticato deve essere membro dello spazio.

Per un esempio, vedi Ricevere dettagli su un evento da uno spazio di Google Chat.

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.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.
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 da leggere. Per un esempio, vedi Ottenere dettagli sullo stato di lettura dello spazio di un utente.

Richiede l'autenticazione dell'utente.

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 da leggere. Per un esempio, vedi Ottenere dettagli sullo stato di lettura dei thread di un utente.

Richiede l'autenticazione dell'utente.

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.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Elenca le iscrizioni in uno spazio. Per un esempio, vedi Elencare gli utenti e le app Google Chat in uno spazio. La scheda degli abbonamenti con autenticazione app elenca le iscrizioni agli spazi a cui l'app Chat ha accesso, ma esclude le iscrizioni all'app Chat, incluse le sue. La scheda delle iscrizioni con Autenticazione utente elenca le iscrizioni agli spazi a cui l'utente autenticato ha accesso.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

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.import
  • 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.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Elenca i messaggi presenti in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da spazi e membri bloccati. Per un esempio, vedi Elencare i messaggi. Richiede l'autenticazione dell'utente.

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

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 dell'utente.

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 da uno spazio di Google Chat. Per ogni evento, il payload contiene la versione più recente della risorsa di Chat. Ad esempio, se elenchi eventi relativi a nuovi membri dello spazio, il server restituisce Membership risorse contenenti i dettagli più recenti dell'iscrizione. Se sono stati rimossi nuovi membri durante il periodo richiesto, il payload dell'evento contiene una risorsa Membership vuota.

Richiede l'autenticazione dell'utente. Per elencare gli eventi, l'utente autenticato deve essere membro dello spazio.

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

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.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 elencati finché non viene inviato il primo messaggio. Per un esempio, vedi Elencare gli spazi.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

Elenca gli spazi visibili al chiamante o all'utente autenticato. Le chat di gruppo e i messaggi diretti non vengono elencati finché non viene inviato il primo messaggio.

Per elencare tutti gli spazi denominati dell'organizzazione Google Workspace, utilizza il metodo spaces.search() utilizzando 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 base alla ricerca di un utente. Richiede l'autenticazione dell'utente. L'utente deve essere un amministratore dell'organizzazione Google Workspace. Nella richiesta, imposta use_admin_access su true.

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 utenti specificati. L'utente che chiama viene aggiunto automaticamente allo spazio e non deve essere specificato come iscrizione nella richiesta. Per un esempio, vedi Configurare uno spazio con membri iniziali.

Per specificare i membri da aggiungere, aggiungi abbonamenti 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ò anche essere il id per la persona dell'API People o il id per l'utente nell'API Directory. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com 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} è il id del 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 group@example.com e poi aggiungere il gruppo allo spazio impostando membership.group_member.name su groups/123456789. L'email del gruppo non è supportata e i gruppi Google possono essere aggiunti solo come membri di spazi denominati.

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

Per creare un messaggio diretto tra l'utente chiamante e un altro utente umano, specifica esattamente un'appartenenza 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 che chiama e l'app per la chiamata, imposta Space.singleUserBotDm su true e non specificare alcuna iscrizione. Puoi utilizzare questo metodo solo per configurare un messaggio diretto con l'app per le chiamate. Per aggiungere l'app per le chiamate come membro di uno spazio o come 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 quando un utente blocca l'altro quando viene effettuata 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 con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Richiede l'autenticazione dell'utente.

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 le iscrizioni di un utente a uno spazio.

Richiede l'autenticazione dell'utente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Aggiorna un messaggio. C'è una differenza tra i metodi patch e update. Il metodo patch usa una richiesta patch, mentre il metodo update usa una richiesta put. Ti consigliamo di utilizzare il metodo patch. Per un esempio, vedi Aggiornare un messaggio.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti. Quando utilizzi l'autenticazione delle app, le richieste possono aggiornare solo i messaggi creati dall'app Chat che chiama.

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.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Aggiorna uno spazio. Ad esempio, vedi Aggiornare uno spazio.

Se aggiorni il campo displayName e ricevi il messaggio di errore ALREADY_EXISTS, prova con un nome visualizzato diverso. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Richiede l'autenticazione dell'utente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aggiorna lo stato di lettura di un utente all'interno di uno spazio, utilizzato per identificare i messaggi letti e da leggere. Ad esempio, vedi Aggiornare lo stato di lettura dello spazio di un utente.

Richiede l'autenticazione dell'utente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

AccessoryWidget

Uno o più widget interattivi che vengono visualizzati nella parte inferiore di un messaggio. Per maggiori dettagli, vedi Aggiungere widget interattivi nella parte inferiore di un messaggio.

Campi
Campo unione action. Il tipo di azione. action può essere solo uno dei seguenti:
button_list

ButtonList

Un elenco di pulsanti.

ActionResponse

Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta.

Campi
type

ResponseType

Solo input. Il tipo di risposta dell'app di Chat.
url

string

Solo input. URL per l'autenticazione o la configurazione da parte degli utenti. (Solo per i tipi di risposta REQUEST_CONFIG.)
dialog_action

DialogAction

Solo input. Una risposta a un evento di interazione relativo a una finestra di dialogo. Deve essere accompagnato da ResponseType.Dialog.
updated_widget

UpdatedWidget

Solo input. La risposta del widget aggiornato.

ResponseType

Il tipo di risposta dell'app di Chat.

Enum
TYPE_UNSPECIFIED Tipo predefinito gestito come NEW_MESSAGE.
NEW_MESSAGE Pubblica come nuovo messaggio nell'argomento.
UPDATE_MESSAGE Aggiorna il messaggio dell'app Chat. Questa operazione è consentita solo in un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT.
UPDATE_USER_MESSAGE_CARDS Aggiornare le schede nel messaggio di un utente. Ciò è consentito solo in risposta a un evento MESSAGE con un URL corrispondente o a un evento CARD_CLICKED in cui il tipo di mittente del messaggio è HUMAN. Il testo viene ignorato.
REQUEST_CONFIG Chiedi privatamente all'utente un'ulteriore autenticazione o configurazione.
DIALOG Apre una finestra di dialogo.
UPDATE_WIDGET Query delle opzioni di completamento automatico del testo del widget.

SelectionItems

Elenco dei risultati del completamento automatico del widget.

Campi
items[]

SelectionItem

Un array di oggetti SelectionItem.

UpdatedWidget

La risposta del widget aggiornato. Utilizzato per fornire opzioni di completamento automatico per un widget.

Campi
widget

string

L'ID del widget aggiornato. L'ID deve corrispondere a quello del widget che ha attivato la richiesta di aggiornamento.
Campo unione updated_widget. Il widget è stato aggiornato in risposta a un'azione dell'utente. updated_widget può essere solo uno dei seguenti:
suggestions

SelectionItems

Elenco dei risultati di completamento automatico del widget

ActionStatus

Rappresenta lo stato di una richiesta per richiamare o inviare una finestra di dialogo.

Campi
status_code

Code

Il codice di stato.
user_facing_message

string

Il messaggio per inviare agli utenti lo stato della loro richiesta. Se il criterio non viene configurato, viene inviato un messaggio generico basato sul valore status_code.

Annotazione

Solo output. Annotazioni associate al corpo in testo normale del messaggio. Per aggiungere la formattazione di base a un messaggio di testo, vedi Formattare i messaggi di testo.

Esempio di corpo del messaggio di testo normale:

Hello @FooBot how are you!"

I metadati delle annotazioni corrispondenti:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Campi
type

AnnotationType

Il tipo di questa annotazione.
length

int32

Lunghezza della sottostringa nel corpo del messaggio in testo normale a cui corrisponde questa annotazione.
start_index

int32

Indice iniziale (in base 0, incluso) nel corpo del messaggio in testo normale a cui corrisponde questa annotazione.
Campo unione metadata. Metadati aggiuntivi sull'annotazione. metadata può essere solo uno dei seguenti:
user_mention

UserMentionMetadata

I metadati della menzione dell'utente.
slash_command

SlashCommandMetadata

I metadati per un comando slash.

AnnotationType

Tipo di annotazione.

Enum
ANNOTATION_TYPE_UNSPECIFIED Valore predefinito per l'enumerazione. Non utilizzare.
USER_MENTION Viene menzionato un utente.
SLASH_COMMAND Viene richiamato un comando slash.

AttachedGif

Un'immagine GIF specificata da un URL.

Campi
uri

string

Solo output. L'URL che ospita l'immagine GIF.

Allegato

Un allegato in Google Chat.

Campi
name

string

Nome risorsa dell'allegato, nel formato spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Solo output. Il nome file originale per i contenuti, non il percorso completo.
content_type

string

Solo output. Il tipo di contenuti (tipo MIME) del file.
thumbnail_uri

string

Solo output. L'URL della miniatura che deve essere utilizzato per visualizzare l'anteprima dell'allegato a un utente umano. Le app di chat non devono utilizzare questo URL per scaricare i contenuti degli allegati.
download_uri

string

Solo output. L'URL di download che deve essere utilizzato per consentire a un utente di scaricare l'allegato. Le app di chat non devono utilizzare questo URL per scaricare i contenuti degli allegati.
source

Source

Solo output. L'origine dell'allegato.
Campo unione data_ref. Il riferimento dati all'allegato. data_ref può essere solo uno dei seguenti:
attachment_data_ref

AttachmentDataRef

Un riferimento ai dati degli allegati. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati.
drive_data_ref

DriveDataRef

Solo output. Un riferimento all'allegato di Google Drive. Questo campo viene utilizzato con l'API Google Drive.

Origine

L'origine dell'allegato.

Enum
SOURCE_UNSPECIFIED Riservato.
DRIVE_FILE Il file è un file di Google Drive.
UPLOADED_CONTENT Il file viene caricato su Chat.

AttachmentDataRef

Un riferimento ai dati degli allegati.

Campi
resource_name

string

Il nome risorsa dei dati degli allegati. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati.
attachment_upload_token

string

Token opaco contenente un riferimento a un allegato caricato. Trattati dai client come una stringa opaca e utilizzata per creare o aggiornare i messaggi di Chat con allegati.

CardWithId

Una scheda in un messaggio di Google Chat.

Solo le app di chat possono creare schede. Se la tua app Chat si autentica come utente, il messaggio non può contenere schede.

Progettare e visualizzare l'anteprima delle schede con il generatore di schede.

Apri il generatore di schede

Campi
card_id

string

Obbligatorio se il messaggio contiene più schede. Identificatore univoco di una scheda in un messaggio.
card

Card

Una scheda. La dimensione massima è 32 kB.

ChatSpaceLinkData

Dati per i link agli spazi di Chat.

Campi
space

string

Lo spazio della risorsa dello spazio di Chat collegata.

Formato: spaces/{space}
thread

string

Il thread della risorsa dello spazio di Chat collegata.

Formato: spaces/{space}/threads/{thread}
message

string

Il messaggio della risorsa dello spazio di Chat collegata.

Formato: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Messaggio di richiesta per il completamento del processo di importazione di uno spazio.

Campi
name

string

Obbligatorio. Nome della risorsa dello spazio in modalità di importazione.

Formato: spaces/{space}

CompleteImportSpaceResponse

Messaggio di risposta per il completamento del processo di importazione di uno spazio.

Campi
space

Space

Lo spazio in modalità di importazione.

ContextualAddOnMarkup

Questo tipo non contiene campi.

Il markup che consente agli sviluppatori di specificare i contenuti di un componente aggiuntivo contestuale.

Scheda

Una scheda è un elemento UI che può contenere widget UI come testo e immagini.

Campi
header

CardHeader

L'intestazione della scheda. Un'intestazione di solito contiene un titolo e un'immagine.
sections[]

Section

Le sezioni sono separate da un separatore di linea.
card_actions[]

CardAction

Le azioni di questa scheda.
name

string

Nome della carta.

CardAction

Un'azione della scheda è l'azione associata alla scheda. Per una scheda fattura, un'azione tipica è: elimina la fattura, invia una fattura via email o apri la fattura nel browser.

Non supportata dalle app Google Chat.

Campi
action_label

string

L'etichetta che veniva visualizzata nella voce del menu azione.
on_click

OnClick

L'azione YAML per questa attività.

CardHeader

Campi
title

string

È necessario specificare il titolo. L'intestazione ha un'altezza fissa: se vengono specificati sia un titolo che un sottotitolo, entrambi occupano una riga. Se viene specificato solo il titolo, questo occupa entrambe le righe.
subtitle

string

Il sottotitolo dell'intestazione della scheda.
image_style

ImageStyle

Il tipo di immagine (ad esempio bordo quadrato o bordo circolare).
image_url

string

L'URL dell'immagine nell'intestazione della scheda.

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Bordo quadrato.
AVATAR Bordo circolare.

Sezione

Una sezione contiene una raccolta di widget che vengono visualizzati (verticalmente) nell'ordine in cui sono specificati. Su tutte le piattaforme, le schede hanno una larghezza fissa fissa, quindi al momento non sono necessarie le proprietà di layout (ad esempio, mobile).

Campi
header

string

L'intestazione della sezione. Il testo formattato è supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
widgets[]

WidgetMarkup

Una sezione deve contenere almeno un widget.

CreateMembershipRequest

Messaggio di richiesta per la creazione di un'iscrizione.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio per il quale creare l'appartenenza.

Formato: workspace/{space}
membership

Membership

Obbligatorio. La relazione di appartenenza da creare. Il campo memberType deve contenere un utente con i campi user.name e user.type compilati. Il server assegnerà un nome risorsa e sovrascriverà qualsiasi elemento specificato. Quando un'app di Chat crea una relazione di appartenenza per un utente umano, deve utilizzare l'ambito chat.memberships, impostare user.type su HUMAN e impostare user.name con il formato users/{user}, dove {user} può essere l'indirizzo email dell'utente. Per gli utenti della stessa organizzazione Workspace, {user} può anche essere il id della persona dell'API People o il id dell'utente nell'API Directory. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com o users/123456789. Quando un'app di chat crea una relazione di appartenenza per se stessa, deve utilizzare l'ambito chat.memberships.app, impostare user.type su BOT e impostare user.name su users/app.
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.

La creazione di abbonamenti per app o la creazione di abbonamenti per gli utenti esterni all'organizzazione Google Workspace dell'amministratore non è supportata utilizzando l'accesso amministrativo.

CreateMessageRequest

Crea un messaggio.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio in cui creare un messaggio.

Formato: spaces/{space}
message

Message

Obbligatorio. Corpo del messaggio.
thread_key
(deprecated)

string

(Facoltativo) Deprecato: usa invece thread.thread_key. ID del thread. Supporta fino a 4000 caratteri. Per avviare o aggiungere elementi a un thread, crea un messaggio e specifica un threadKey o il thread.name. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.
request_id

string

(Facoltativo) Un ID richiesta univoco per questo messaggio. Se viene specificato un ID richiesta esistente, viene restituito il messaggio creato con quell'ID anziché crearne uno nuovo.
message_reply_option

MessageReplyOption

(Facoltativo) Specifica se un messaggio avvia un thread o risponde a un thread. Funzionalità supportata solo negli spazi denominati.
message_id

string

(Facoltativo) Un ID personalizzato per un messaggio. Consente alle app di Chat di recuperare, aggiornare o eliminare un messaggio senza dover archiviare l'ID assegnato dal sistema nel nome della risorsa del messaggio (rappresentato nel campo name del messaggio).

Il valore di questo campo deve soddisfare i seguenti requisiti:

  • Inizia con client-. Ad esempio, client-custom-name è un ID personalizzato valido, mentre custom-name non lo è.
  • Contiene fino a 63 caratteri e solo lettere minuscole, numeri e trattini.
  • Sia univoco all'interno di uno spazio. Un'app di Chat non può utilizzare lo stesso ID personalizzato per messaggi diversi.

Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

MessageReplyOption

Specifica come rispondere a un messaggio. In futuro potrebbero essere aggiunti altri stati.

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Predefinita. Avvia un nuovo thread. Se utilizzi questa opzione, i valori thread ID o thread_key inclusi vengono ignorati.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crea il messaggio come risposta al thread specificato da thread ID o thread_key. Se non riesce, il messaggio avvia un nuovo thread.
REPLY_MESSAGE_OR_FAIL Crea il messaggio come risposta al thread specificato da thread ID o thread_key. Se viene utilizzato un nuovo thread_key, viene creato un nuovo thread. Se la creazione del messaggio non riesce, viene restituito un errore NOT_FOUND.

CreateReactionRequest

Crea una reazione a un messaggio.

Campi
parent

string

Obbligatorio. Il messaggio in cui viene creata la reazione.

Formato: spaces/{space}/messages/{message}
reaction

Reaction

Obbligatorio. La reazione da creare.

CreateSpaceRequest

Una richiesta per creare uno spazio denominato.

Campi
space

Space

Obbligatorio. I campi displayName e spaceType devono essere compilati. È supportato solo SpaceType.SPACE.

Se viene visualizzato il messaggio di errore ALREADY_EXISTS, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Lo spazio name è assegnato sul server, pertanto tutto ciò che è specificato in questo campo verrà ignorato.
request_id

string

(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app di Chat con un utente autenticato diverso, viene restituito un errore.

CustomEmoji

Rappresenta un'emoji personalizzata.

Campi
uid

string

Solo output. Chiave univoca per la risorsa di emoji personalizzate.

DeleteMembershipRequest

Richiedere l'eliminazione di un'appartenenza a uno spazio.

Campi
name

string

Obbligatorio. Nome della risorsa dell'appartenenza da eliminare. Le app di chat possono eliminare gli utenti o le proprie iscrizioni. Le app di chat non possono eliminare altre app di abbonamento.

Quando si elimina un'appartenenza umana, sono necessari l'ambito chat.memberships e il formato spaces/{space}/members/{member}. Puoi utilizzare l'email come alias per {member}. Ad esempio, spaces/{space}/members/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

Quando elimini un abbonamento a un'app, sono necessari l'ambito chat.memberships.app e il formato spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app.
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.

L'eliminazione degli abbonamenti alle app in uno spazio non è supportata utilizzando l'accesso amministrativo.

DeleteMessageRequest

Richiesta di eliminazione di un messaggio.

Campi
name

string

Obbligatorio. Nome della risorsa del messaggio.

Formato: spaces/{space}/messages/{message}

Se hai impostato un ID personalizzato per il tuo messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
force

bool

Quando true, l'eliminazione di un messaggio comporta anche l'eliminazione delle relative risposte in thread. Quando false, se un messaggio ha risposte in thread, l'eliminazione non riesce.

Si applica solo in caso di autenticazione come utente. Non ha effetto durante l'autenticazione come app di Chat.

DeleteReactionRequest

Elimina una reazione a un messaggio.

Campi
name

string

Obbligatorio. Nome della reazione da eliminare.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Richiesta di eliminazione di uno spazio.

Campi
name

string

Obbligatorio. Nome risorsa dello spazio da eliminare.

Formato: spaces/{space}
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.delete.

DeletionMetadata

Informazioni su un messaggio eliminato. Viene eliminato un messaggio impostando delete_time.

Campi
deletion_type

DeletionType

Indica chi ha eliminato il messaggio.

DeletionType

Chi ha eliminato il messaggio e come.

Enum
DELETION_TYPE_UNSPECIFIED Questo valore non è utilizzato.
CREATOR L'utente ha eliminato il proprio messaggio.
SPACE_OWNER Il proprietario dello spazio ha eliminato il messaggio.
ADMIN Un amministratore di Google Workspace ha eliminato il messaggio.
APP_MESSAGE_EXPIRY Un'app di Chat ha eliminato il proprio messaggio alla scadenza.
CREATOR_VIA_APP Un'app di Chat ha eliminato il messaggio per conto dell'utente.
SPACE_OWNER_VIA_APP Un'app di Chat ha eliminato il messaggio per conto del proprietario dello spazio.

Dialog

Wrapper intorno al corpo della scheda della finestra di dialogo.

Campi
body

Card

Solo input. Corpo della finestra di dialogo, visualizzato in modalità modale. Le app Google Chat non supportano le seguenti entità delle carte: DateTimePicker, OnChangeAction.

DialogAction

Contiene una finestra di dialogo e un codice di stato della richiesta.

Campi
action_status

ActionStatus

Solo input. Stato di una richiesta per richiamare o inviare una finestra di dialogo. Se necessario, mostra uno stato e un messaggio agli utenti. Ad esempio, in caso di errore o riuscita.
Campo unione action. Azione da eseguire. action può essere solo uno dei seguenti:
dialog

Dialog

Solo input. Finestra di dialogo per la richiesta.

DriveDataRef

Un riferimento ai dati di un collegamento di Drive.

Campi
drive_file_id

string

L'ID del file di Drive. Da utilizzare con l'API Drive.

DriveLinkData

Dati per i link di Google Drive.

Campi
drive_data_ref

DriveDataRef

Un DriveDataRef che fa riferimento a un file di Google Drive.
mime_type

string

Il tipo MIME della risorsa di Google Drive collegata.

Emoji

Un'emoji utilizzata come reazione a un messaggio.

Campi
Campo unione content. I contenuti dell'emoji. content può essere solo uno dei seguenti:
unicode

string

Un'emoji di base rappresentata da una stringa Unicode.
custom_emoji

CustomEmoji

Solo output. Un'emoji personalizzata.

EmojiReactionSummary

Il numero di persone che hanno reagito a un messaggio con un'emoji specifica.

Campi
emoji

Emoji

Emoji associate alle reazioni.
reaction_count

int32

Il numero totale di reazioni utilizzando l'emoji associata.

FindDirectMessageRequest

Una richiesta per ottenere uno spazio di messaggi diretti basata sulla risorsa utente.

Campi
name

string

Obbligatorio. Nome della risorsa dell'utente con cui trovare il messaggio diretto.

Formato: users/{user}, dove {user} è il id per la persona dell'API People o il id per l'utente nell'API Directory. Ad esempio, se l'ID profilo dell'API People è 123456789, puoi trovare un messaggio diretto con quella persona utilizzando users/123456789 come name. Una volta eseguito l'autenticazione come utente, puoi utilizzare l'email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

GetAttachmentRequest

Richiedi un allegato.

Campi
name

string

Obbligatorio. Nome risorsa dell'allegato, nel formato spaces/{space}/messages/{message}/attachments/{attachment}.

GetMembershipRequest

Richiedi l'iscrizione a uno spazio.

Campi
name

string

Obbligatorio. Nome della risorsa dell'appartenenza da recuperare.

Per usufruire dell'abbonamento all'app utilizzando l'autenticazione utente, puoi facoltativamente utilizzare spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app

Dopo aver eseguito l'autenticazione come utente, puoi utilizzare l'email dell'utente come alias per {member}. Ad esempio, spaces/{space}/members/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede gli ambiti OAuth 2.0 chat.admin.memberships o chat.admin.memberships.readonly.

L'acquisto di abbonamenti a un'app in uno spazio non è supportato se si utilizza l'accesso amministrativo.

GetMessageRequest

Richiedi di ricevere un messaggio.

Campi
name

string

Obbligatorio. Nome della risorsa del messaggio.

Formato: spaces/{space}/messages/{message}

Se hai impostato un ID personalizzato per il tuo messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

GetSpaceEventRequest

Richiedi un messaggio per ricevere un evento dello spazio.

Campi
name

string

Obbligatorio. Il nome della risorsa dell'evento dello spazio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

Messaggio di richiesta per l'API GetSpaceReadState.

Campi
name

string

Obbligatorio. Nome risorsa dello stato di lettura dello spazio da recuperare.

Supporta solo il recupero dello stato di lettura per l'utente chiamante.

Per fare riferimento all'utente chiamante, imposta una delle seguenti opzioni:

  • L'alias me. Ad esempio, users/me/spaces/{space}/spaceReadState.

  • L'indirizzo email di Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

  • Il relativo ID utente. Ad esempio, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Richiesta per restituire un singolo spazio.

Campi
name

string

Obbligatorio. Nome risorsa dello spazio, nel formato spaces/{space}.

Formato: spaces/{space}
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede gli ambiti OAuth 2.0 chat.admin.spaces o chat.admin.spaces.readonly.

GetThreadReadStateRequest

Messaggio di richiesta per l'API GetThreadReadStateRequest.

Campi
name

string

Obbligatorio. Nome della risorsa dello stato di lettura del thread da recuperare.

Supporta solo il recupero dello stato di lettura per l'utente chiamante.

Per fare riferimento all'utente chiamante, imposta una delle seguenti opzioni:

  • L'alias me. Ad esempio, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • L'indirizzo email di Workspace. Ad esempio, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • Il relativo ID utente. Ad esempio, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Gruppo

Un gruppo Google in Google Chat.

Campi
name

string

Nome della risorsa per un gruppo Google.

Rappresenta un gruppo nell'API Cloud Identity Groups.

Formato: groups/{group}

HistoryState

Lo stato della cronologia per i messaggi e gli spazi. Specifica per quanto tempo vengono conservati i messaggi e i thread di conversazione dopo la creazione.

Enum
HISTORY_STATE_UNSPECIFIED Valore predefinito. Non utilizzare.
HISTORY_OFF Cronologia disattivata. I messaggi e i thread vengono conservati per 24 ore.
HISTORY_ON Cronologia attivata. Le regole di conservazione di Vault dell'organizzazione specificano la durata di conservazione dei messaggi e dei thread.

ListMembershipsRequest

Messaggio di richiesta relativo alla scheda degli abbonamenti.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio per il quale recuperare un elenco di membri.

Formato: workspace/{space}
page_size

int32

(Facoltativo) Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore.

Se non specificato, vengono restituite al massimo 100 abbonamenti.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata per elencare le iscrizioni. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.
filter

string

(Facoltativo) Un filtro di query.

Puoi filtrare le iscrizioni in base al ruolo (role) e al tipo (member.type) di un membro.

Per filtrare in base al ruolo, imposta role su ROLE_MEMBER o ROLE_MANAGER.

Per filtrare per tipo, imposta member.type su HUMAN o BOT. Anteprima per gli sviluppatori: puoi anche filtrare in base a member.type utilizzando l'operatore !=.

Per filtrare sia in base al ruolo che al tipo, utilizza l'operatore AND. Per filtrare in base a ruolo o tipo, utilizza l'operatore OR.

Se use_admin_access è impostato su true, è obbligatorio member.type = "HUMAN" o member.type != "BOT". Gli altri filtri dei tipi di membri verranno rifiutati.

Ad esempio, le seguenti query sono valide:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Le seguenti query non sono valide:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.
show_groups

bool

(Facoltativo) Quando true, oltre ad altri tipi di abbonamenti, restituisce anche gli abbonamenti associati a un Google Group. Se viene impostato un filter, le appartenenze a Google Group che non corrispondono ai criteri del filtro non vengono restituite.
show_invited

bool

(Facoltativo) Quando true, restituisce anche gli abbonamenti associati ai membri invited, oltre ad altri tipi di abbonamenti. Se viene impostato un filtro, le appartenenze a invited che non corrispondono ai criteri del filtro non vengono restituite.

Attualmente richiede l'autenticazione dell'utente.
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

Se si utilizza l'accesso amministrativo, non è possibile elencare gli abbonamenti all'app in uno spazio.

ListMembershipsResponse

Risposta all'elenco dei membri dello spazio.

Campi
memberships[]

Membership

Elenco non ordinato. Elenco degli abbonamenti nella pagina richiesta (o nella prima).
next_page_token

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

ListMessagesRequest

Elenca i messaggi nello spazio specificato di cui l'utente è membro.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio da cui elencare i messaggi.

Formato: spaces/{space}
page_size

int32

Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire meno messaggi di questo valore.

Se non specificato, vengono restituiti al massimo 25.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo, se riprendi da una query precedente.

Un token di pagina ricevuto da una precedente chiamata di messaggi dell'elenco. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.
filter

string

Un filtro di query.

Puoi filtrare i messaggi per data (create_time) e thread (thread.name).

Per filtrare i messaggi in base alla data di creazione, specifica create_time con un timestamp nel formato RFC-3339 e le virgolette doppie. Ad esempio: "2023-04-21T11:30:00-04:00". Puoi utilizzare l'operatore maggiore di > per elencare i messaggi creati dopo un timestamp o l'operatore minore di < per elencare i messaggi creati prima di un timestamp. Per filtrare i messaggi entro un intervallo di tempo, utilizza l'operatore AND tra due timestamp.

Per filtrare in base al thread, specifica il valore thread.name, nel formato spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare sia in base al thread che alla data, utilizza l'operatore AND nella query.

Ad esempio, le seguenti query sono valide:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.
order_by

string

Facoltativo, se riprendi da una query precedente.

Ordinamento dell'elenco dei messaggi. Specifica un valore da ordinare tramite un'operazione di ordinamento. I valori validi per le operazioni di ordinamento sono i seguenti:

  • ASC per l'ordine crescente.

  • DESC per la modalità discendente.

L'ordine predefinito è create_time ASC.
show_deleted

bool

Se includere i messaggi eliminati. I messaggi eliminati includono l'ora e i metadati relativi alla loro eliminazione, ma i contenuti dei messaggi non sono disponibili.

ListMessagesResponse

Messaggio di risposta relativo ai messaggi dell'elenco.

Campi
messages[]

Message

Elenco dei messaggi.
next_page_token

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

ListReactionsRequest

Elenca le reazioni a un messaggio.

Campi
parent

string

Obbligatorio. Il messaggio a cui gli utenti hanno reagito.

Formato: spaces/{space}/messages/{message}
page_size

int32

(Facoltativo) Il numero massimo di reazioni restituite. Il servizio può restituire meno reazioni di questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200. superiori a 200 vengono modificati in 200.
page_token

string

(Facoltativo) (se riprendi da una query precedente).

Un token di pagina ricevuto da una precedente chiamata di reazioni dell'elenco. Forniscilo per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti.
filter

string

(Facoltativo) Un filtro di query.

Puoi filtrare le reazioni per emoji (emoji.unicode o emoji.custom_emoji.uid) e per utente (user.name).

Per filtrare le reazioni per più emoji o utenti, unisci campi simili con l'operatore OR, ad esempio emoji.unicode = "🙂" OR emoji.unicode = "👍" e user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Per filtrare le reazioni per emoji e utente, utilizza l'operatore AND, ad esempio emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Se la query utilizza sia AND sia OR, raggruppali tra parentesi.

Ad esempio, le seguenti query sono valide:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Le seguenti query non sono valide:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

ListReactionsResponse

Risposta a una richiesta di reazioni in elenco.

Campi
reactions[]

Reaction

Elenco delle reazioni nella pagina richiesta (o nella prima).
next_page_token

string

Token di continuazione per recuperare la pagina dei risultati successiva. È vuota per l'ultima pagina dei risultati.

ListSpaceEventsRequest

Messaggio di richiesta per la scheda degli eventi dello spazio.

Campi
parent

string

Obbligatorio. Nome della risorsa dello spazio di Google Chat in cui si sono verificati gli eventi.

Formato: spaces/{space}.
page_size

int32

(Facoltativo) Il numero massimo di eventi dello spazio restituiti. Il servizio potrebbe restituire un valore inferiore a questo valore.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Un token di pagina, ricevuto da una precedente chiamata di eventi dello spazio elenco. Forniscilo per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.
filter

string

Obbligatorio. Un filtro di query.

Devi specificare almeno un tipo di evento (event_type) utilizzando l'operatore has :. Per filtrare in base a più tipi di eventi, utilizza l'operatore OR. Ometti tipi di eventi batch nel filtro. La richiesta restituisce automaticamente tutti gli eventi batch correlati. Ad esempio, se filtri in base alle nuove reazioni (google.workspace.chat.reaction.v1.created), il server restituisce anche gli eventi batch di nuove reazioni (google.workspace.chat.reaction.v1.batchCreated). Per un elenco dei tipi di eventi supportati, consulta la documentazione di riferimento SpaceEvents.

Se vuoi, puoi anche filtrare in base all'ora di inizio (start_time) e all'ora di fine (end_time):

  • start_time: timestamp esclusivo da cui iniziare a elencare gli eventi dello spazio. Puoi elencare gli eventi che si sono verificati fino a 28 giorni fa. Se non specificati, sono elencati gli eventi dello spazio degli ultimi 28 giorni.
  • end_time: timestamp inclusivo fino al quale gli eventi dello spazio vengono elencati. Se non specificato, elenca gli eventi fino al momento della richiesta.

Per specificare un'ora di inizio o di fine, utilizza l'operatore = uguale a e il formato in RFC-3339. Per filtrare sia in base a start_time che a end_time, utilizza l'operatore AND.

Ad esempio, le seguenti query sono valide:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Le seguenti query non sono valide:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

ListSpaceEventsResponse

Messaggio di risposta relativo alla creazione di una scheda per gli eventi dello spazio.

Campi
space_events[]

SpaceEvent

I risultati vengono restituiti in ordine cronologico (dall'evento meno recente).
next_page_token

string

Token di continuazione utilizzato per recuperare più eventi. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListSpacesRequest

Una richiesta per elencare gli spazi di cui il chiamante è membro.

Campi
page_size

int32

(Facoltativo) Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore.

Se non specificati, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata agli spazi di elenco. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso può portare a risultati imprevisti.
filter

string

(Facoltativo) Un filtro di query.

Puoi filtrare gli spazi in base al tipo (space_type).

Per filtrare in base al tipo di spazio, devi specificare un valore enum valido, come SPACE o GROUP_CHAT (il space_type non può essere SPACE_TYPE_UNSPECIFIED). Per eseguire query su più tipi di spazi, utilizza l'operatore OR.

Ad esempio, le seguenti query sono valide:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

ListSpacesResponse

La risposta per una richiesta di elenchi spazi.

Campi
spaces[]

Space

Elenco degli spazi nella pagina richiesta (o nella prima).
next_page_token

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

MatchedUrl

Un URL corrispondente in un messaggio di Chat. Le app di chat possono visualizzare l'anteprima degli URL corrispondenti. Per ulteriori informazioni, consulta la sezione Link di anteprima.

Campi
url

string

Solo output. L'URL corrispondente.

Abbonamento

Rappresenta una relazione di adesione in Google Chat, ad esempio se un utente o un'app di Chat è invitato a uno spazio, se ne fa parte o se è assente.

Campi
name

string

Nome risorsa dell'appartenenza, assegnato dal server.

Formato: spaces/{space}/members/{member}
state

MembershipState

Solo output. Stato dell'abbonamento.
role

MembershipRole

(Facoltativo) Il ruolo dell'utente all'interno di uno spazio di Chat, che determina le azioni consentite nello spazio.

Questo campo può essere utilizzato solo come input in UpdateMembership.
create_time

Timestamp

(Facoltativo) Immutabile. L'ora di creazione dell'abbonamento, ad esempio quando un membro si è unito o è stato invitato a partecipare a uno spazio. Questo campo viene solo generato, tranne quando viene utilizzato per importare le appartenenze storiche negli spazi in modalità di importazione.
delete_time

Timestamp

(Facoltativo) Immutabile. La data e l'ora di eliminazione dell'abbonamento, ad esempio quando un membro ha abbandonato uno spazio o è stato rimosso. Questo campo viene solo generato, tranne quando viene utilizzato per importare le appartenenze storiche negli spazi in modalità di importazione.
Campo unione memberType. Membro associato a questo abbonamento. In futuro potrebbero essere supportati altri tipi di membri. memberType può essere solo uno dei seguenti:
member

User

L'utente o l'app di Google Chat a cui corrisponde l'abbonamento. Se l'app Chat si autentica come utente, l'output compila i campi utente name e type.
group_member

Group

Il gruppo Google a cui corrisponde l'iscrizione.

MembershipRole

Rappresenta le azioni consentite di un utente in uno spazio di Chat. In futuro potrebbero essere aggiunti altri valori enum.

Enum
MEMBERSHIP_ROLE_UNSPECIFIED Valore predefinito. users: non è membro dello spazio, ma può essere invitato. Per Google Groups: verrà sempre assegnato questo ruolo (in futuro potrebbero essere utilizzati altri valori enum).
ROLE_MEMBER Un membro dello spazio. L'utente dispone delle autorizzazioni di base, come l'invio di messaggi allo spazio. Nelle conversazioni 1:1 e senza nome, tutti hanno questo ruolo.
ROLE_MANAGER Un gestore dello spazio. L'utente dispone di tutte le autorizzazioni di base, oltre alle autorizzazioni amministrative che gli consentono di gestire lo spazio, come l'aggiunta o la rimozione di membri. Supportata solo nel seguente paese: SpaceType.SPACE.

MembershipState

Specifica la relazione del membro con uno spazio. In futuro potrebbero essere supportati altri stati di appartenenza.

Enum
MEMBERSHIP_STATE_UNSPECIFIED Valore predefinito. Non utilizzare.
JOINED L'utente viene aggiunto allo spazio e può partecipare allo spazio.
INVITED L'utente è stato invitato a partecipare allo spazio, ma non l'ha ancora fatto.
NOT_A_MEMBER L'utente non appartiene allo spazio e non ha un invito in attesa per partecipare allo spazio.

MembershipBatchCreatedEventData

Payload dell'evento per più nuove iscrizioni.

Tipo di evento: google.workspace.chat.membership.v1.batchCreated

Campi
memberships[]

MembershipCreatedEventData

Un elenco dei nuovi abbonamenti.

MembershipBatchDeletedEventData

Payload dell'evento per più appartenenze eliminate.

Tipo di evento: google.workspace.chat.membership.v1.batchDeleted

Campi
memberships[]

MembershipDeletedEventData

Un elenco delle iscrizioni eliminate.

MembershipBatchUpdatedEventData

Payload dell'evento per più appartenenze aggiornate.

Tipo di evento: google.workspace.chat.membership.v1.batchUpdated

Campi
memberships[]

MembershipUpdatedEventData

Un elenco degli abbonamenti aggiornati.

MembershipCreatedEventData

Payload dell'evento per una nuova appartenenza.

Tipo di evento: google.workspace.chat.membership.v1.created.

Campi
membership

Membership

Il nuovo abbonamento.

MembershipDeletedEventData

Payload dell'evento per un'appartenenza eliminata.

Tipo di evento: google.workspace.chat.membership.v1.deleted

Campi
membership

Membership

L'abbonamento eliminato. Vengono compilati solo i campi name e state.

MembershipUpdatedEventData

Payload dell'evento per un'appartenenza aggiornata.

Tipo di evento: google.workspace.chat.membership.v1.updated

Campi
membership

Membership

L'abbonamento aggiornato.

Messaggio

Un messaggio in uno spazio di Google Chat.

Campi
name

string

Nome della risorsa del messaggio.

Formato: spaces/{space}/messages/{message}

dove {space} è l'ID dello spazio in cui viene pubblicato il messaggio e {message} è un ID assegnato dal sistema al messaggio. Ad esempio: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Se imposti un ID personalizzato durante la creazione di un messaggio, puoi utilizzarlo per specificarlo in una richiesta sostituendo {message} con il valore del campo clientAssignedMessageId. Ad esempio: spaces/AAAAAAAAAAA/messages/client-custom-name. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
sender

User

Solo output. L'utente che ha creato il messaggio. Se l'app Chat si autentica come utente, l'output compila i campi utente name e type.
create_time

Timestamp

(Facoltativo) Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo viene solo generato, tranne quando viene utilizzato negli spazi in modalità di importazione.

Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui è stato creato il messaggio nell'origine per conservare l'ora di creazione originale.
last_update_time

Timestamp

Solo output. L'ultima modifica del messaggio da parte di un utente. Se il messaggio non è mai stato modificato, questo campo è vuoto.
delete_time

Timestamp

Solo output. L'ora in cui il messaggio è stato eliminato in Google Chat. Se il messaggio non viene mai eliminato, questo campo è vuoto.
text

string

Corpo del messaggio in testo normale. Il primo link a un'immagine, un video o una pagina web genera un chip di anteprima. Puoi anche @menzionare un utente di Google Chat o tutte le persone presenti nello spazio.

Per ulteriori informazioni sulla creazione di messaggi di testo, vedi Inviare un messaggio.
formatted_text

string

Solo output. Contiene il messaggio text con markup aggiunti per comunicare la formattazione. Questo campo potrebbe non acquisire tutta la formattazione visibile nella UI, ma include quanto segue:

  • Sintassi di markup per grassetto, corsivo, barrato, monospaziale, blocco monospaziale ed elenco puntato.

  • L'utente menziona nel formato <users/{user}>.

  • Link ipertestuali personalizzati nel formato <{url}|{rendered_text}>, dove la prima stringa corrisponde all'URL e la seconda al testo visualizzato, ad esempio <http://example.com|custom text>.

  • Emoji personalizzate nel formato :{emoji_name}:, ad esempio :smile:. Non vale per le emoji Unicode, ad esempio U+1F600 per l'emoji di una faccina che sorride.

Per ulteriori informazioni, vedi Visualizzare la formattazione del testo inviata in un messaggio.
cards[]
(deprecated)

Card

Deprecato: usa invece cards_v2.

Schede complete, formattate e interattive che puoi utilizzare per visualizzare elementi dell'interfaccia utente come testi formattati, pulsanti e immagini cliccabili. In genere le schede vengono visualizzate sotto il corpo in testo normale del messaggio. cards e cards_v2 possono avere una dimensione massima di 32 kB.
cards_v2[]

CardWithId

Un array di schede.

Solo le app di chat possono creare schede. Se la tua app Chat si autentica come utente, i messaggi non possono contenere schede.

Per informazioni sulle schede e su come crearle, consulta Inviare i messaggi delle schede.

Progettare e visualizzare l'anteprima delle schede con il generatore di schede.

Apri il generatore di schede
annotations[]

Annotation

Solo output. Annotazioni associate all'elemento text in questo messaggio.
thread

Thread

Il thread a cui appartiene il messaggio. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.
space

Space

Se l'app Chat si autentica come utente, l'output compila lo spazio name.
fallback_text

string

Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio per le notifiche su dispositivi mobili.
action_response

ActionResponse

Solo input. Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta.
argument_text

string

Solo output. Corpo in testo normale del messaggio con tutte le menzioni dell'app Chat eliminate.
slash_command

SlashCommand

Solo output. Informazioni sul comando slash, se applicabili.
attachment[]

Attachment

Allegato caricato dall'utente.
matched_url

MatchedUrl

Solo output. Un URL in spaces.messages.text che corrisponde a un pattern di anteprima del link. Per ulteriori informazioni, consulta la sezione Link di anteprima.
thread_reply

bool

Solo output. Quando true, il messaggio è una risposta in un thread di risposta. Quando false, il messaggio è visibile nella conversazione di primo livello dello spazio come primo messaggio di un thread o come messaggio senza risposte in thread.

Se lo spazio non supporta le risposte nei thread, questo campo è sempre false.
client_assigned_message_id

string

(Facoltativo) Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio o per ricevere, eliminare o aggiornare un messaggio. Per impostare un ID personalizzato, specifica il campo messageId quando crei il messaggio. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
emoji_reaction_summaries[]

EmojiReactionSummary

Solo output. L'elenco di riepiloghi di reazioni emoji sul messaggio.
private_message_viewer

User

Immutabile. Input per la creazione di un messaggio, altrimenti solo output. L'utente che può visualizzare il messaggio. Se impostato, il messaggio è privato e visibile solo all'utente specificato e all'app Chat. Le anteprime dei link e gli allegati non sono supportati per i messaggi privati.

Solo le app di Chat possono inviare messaggi privati. Se la tua app Chat si autentica come utente per inviare un messaggio, il messaggio non può essere privato e deve omettere questo campo.

Per maggiori dettagli, vedi Inviare messaggi privati agli utenti di Google Chat.
deletion_metadata

DeletionMetadata

Solo output. Informazioni su un messaggio eliminato. Viene eliminato un messaggio impostando delete_time.
quoted_message_metadata

QuotedMessageMetadata

Solo output. Informazioni su un messaggio citato da un utente di Google Chat in uno spazio. Gli utenti di Google Chat possono citare un messaggio per rispondere.
attached_gifs[]

AttachedGif

Solo output. GIF allegate al messaggio.
accessory_widgets[]

AccessoryWidget

Uno o più widget interattivi che vengono visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o testo e schede. Non supportata per i messaggi che contengono finestre di dialogo. Per maggiori dettagli, vedi Aggiungere widget interattivi nella parte inferiore di un messaggio.

La creazione di un messaggio con widget accessori richiede l'autenticazione delle app.

MessageBatchCreatedEventData

Payload dell'evento per più nuovi messaggi.

Tipo di evento: google.workspace.chat.message.v1.batchCreated

Campi
messages[]

MessageCreatedEventData

Un elenco di nuovi messaggi.

MessageBatchDeletedEventData

Payload dell'evento per più messaggi eliminati.

Tipo di evento: google.workspace.chat.message.v1.batchDeleted

Campi
messages[]

MessageDeletedEventData

Un elenco di messaggi eliminati.

MessageBatchUpdatedEventData

Payload dell'evento per più messaggi aggiornati.

Tipo di evento: google.workspace.chat.message.v1.batchUpdated

Campi
messages[]

MessageUpdatedEventData

Un elenco dei messaggi aggiornati.

MessageCreatedEventData

Payload dell'evento per un nuovo messaggio.

Tipo di evento: google.workspace.chat.message.v1.created

Campi
message

Message

Il nuovo messaggio.

MessageDeletedEventData

Payload dell'evento per un messaggio eliminato.

Tipo di evento: google.workspace.chat.message.v1.deleted

Campi
message

Message

Il messaggio eliminato. Vengono compilati solo i campi name, createTime, deleteTime e deletionMetadata.

MessageUpdatedEventData

Payload dell'evento per un messaggio aggiornato.

Tipo di evento: google.workspace.chat.message.v1.updated

Campi
message

Message

Il messaggio aggiornato.

QuotedMessageMetadata

Informazioni su un messaggio citato.

Campi
name

string

Solo output. Nome della risorsa del messaggio tra virgolette.

Formato: spaces/{space}/messages/{message}
last_update_time

Timestamp

Solo output. Il timestamp di creazione del messaggio citato o dell'ultimo aggiornamento di quest'ultimo.

Reazioni

Una reazione a un messaggio.

Campi
name

string

Il nome risorsa della reazione.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

Solo output. L'utente che ha creato la reazione.
emoji

Emoji

L'emoji utilizzata nella reazione.

ReactionBatchCreatedEventData

Payload dell’evento per diverse nuove reazioni.

Tipo di evento: google.workspace.chat.reaction.v1.batchCreated

Campi
reactions[]

ReactionCreatedEventData

Un elenco di nuove reazioni.

ReactionBatchDeletedEventData

Payload dell'evento per più reazioni eliminate.

Tipo di evento: google.workspace.chat.reaction.v1.batchDeleted

Campi
reactions[]

ReactionDeletedEventData

Un elenco di reazioni eliminate.

ReactionCreatedEventData

Payload dell'evento per una nuova reazione.

Tipo di evento: google.workspace.chat.reaction.v1.created

Campi
reaction

Reaction

La nuova reazione.

ReactionDeletedEventData

Payload dell'evento per una reazione eliminata.

Tipo: google.workspace.chat.reaction.v1.deleted

Campi
reaction

Reaction

La reazione eliminata.

RichLinkMetadata

Un link avanzato a una risorsa.

Campi
uri

string

L'URI di questo link.
Campo unione data. Dati relativi alla risorsa collegata. data può essere solo uno dei seguenti:

RichLinkType

Il tipo di link avanzato. In futuro potrebbero essere aggiunti altri tipi.

Enum
DRIVE_FILE Un tipo di link avanzato di Google Drive.
CHAT_SPACE Un tipo di link avanzato a uno spazio di Chat. Ad esempio, uno smart chip di spazio.

SearchSpacesRequest

Richiesta di ricerca di un elenco di spazi in base a una query.

Campi
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

Al momento questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo true.
page_size

int32

Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore.

Se non specificati, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.
page_token

string

Un token, ricevuto dalla chiamata precedente agli spazi di ricerca. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.
query

string

Obbligatorio. Una query di ricerca.

Puoi eseguire ricerche utilizzando i seguenti parametri:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time e last_active_time accettano un timestamp nel formato RFC-3339 e gli operatori di confronto supportati sono: =, <, >, <= e >=.

customer è obbligatorio e viene utilizzato per indicare da quale cliente recuperare gli spazi. customers/my_customer è l'unico valore supportato.

display_name accetta solo l'operatore HAS (:). Il testo da abbinare viene prima tokenizzato in token e ogni token viene associato, senza distinzione tra maiuscole e minuscole e indipendentemente dal prefisso, come sottostringa in qualsiasi punto dello spazio display_name. Ad esempio, Fun Eve corrisponde a Fun event o The evening was fun, ma non a notFun event o even.

external_user_allowed accetta true o false.

space_history_state accetta solo valori dal campo historyState di una risorsa space.

space_type è obbligatorio e l'unico valore valido è SPACE.

In diversi campi sono supportati solo gli operatori AND. Un esempio valido è space_type = "SPACE" AND display_name:"Hello", mentre un esempio non valido è space_type = "SPACE" OR display_name:"Hello".

Nello stesso campo, space_type non supporta gli operatori AND o OR. display_name, "space_history_state" e "external_user_allowed" supporta solo gli operatori OR. last_active_time e create_time supportano sia gli operatori AND che OR. AND può essere utilizzato solo per rappresentare un intervallo, ad esempio last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

I seguenti esempi di query sono validi:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

(Facoltativo) Come viene ordinato l'elenco degli spazi.

Gli attributi supportati per l'ordinamento sono:

  • membership_count.joined_direct_human_user_count: indica il numero di utenti che sono entrati direttamente in uno spazio.
  • last_active_time: indica la data e l'ora in cui l'ultimo elemento idoneo viene aggiunto a qualsiasi argomento di questo spazio.
  • create_time: indica l'ora in cui è stato creato lo spazio.

I valori validi per le operazioni di ordinamento sono:

  • ASC per l'ordine crescente. Valore predefinito.

  • DESC per la modalità discendente.

La sintassi supportata è:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

Risposta con un elenco di spazi corrispondenti alla richiesta di spazi di ricerca.

Campi
spaces[]

Space

Una pagina degli spazi richiesti.
next_page_token

string

Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci saranno pagine successive.
total_size

int32

Il numero totale di spazi che corrispondono alla query, in tutte le pagine. Se il risultato è superiore a 10.000 spazi, questo valore è una stima.

SetUpSpaceRequest

Richiedi di creare uno spazio a cui aggiungere utenti specificati.

Campi
space

Space

Obbligatorio. Il campo Space.spaceType è obbligatorio.

Per creare uno spazio, imposta Space.spaceType su SPACE e imposta Space.displayName. Se ricevi il messaggio di errore ALREADY_EXISTS durante la configurazione di uno spazio, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Per creare una chat di gruppo, imposta Space.spaceType su GROUP_CHAT. Non impostare Space.displayName.

Per creare una conversazione 1:1 tra persone, imposta Space.spaceType su DIRECT_MESSAGE e imposta Space.singleUserBotDm su false. Non impostare Space.displayName o Space.spaceDetails.

Per creare una conversazione 1:1 tra una persona e l'app Chat per le chiamate, imposta Space.spaceType su DIRECT_MESSAGE e Space.singleUserBotDm su true. Non impostare Space.displayName o Space.spaceDetails.

Se esiste già uno spazio DIRECT_MESSAGE, viene restituito quel spazio invece di crearne uno nuovo.
request_id

string

(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app di Chat con un utente autenticato diverso, viene restituito un errore.
memberships[]

Membership

(Facoltativo) Gli utenti o i gruppi di Google Chat da invitare a partecipare allo spazio. Ometti l'utente chiamante poiché viene aggiunto automaticamente.

L'impostazione attualmente consente fino a 20 abbonamenti (oltre al chiamante).

Per l'appartenenza umana, il campo Membership.member deve contenere un valore user con name compilato (formato: users/{user}) e type impostato su User.Type.HUMAN. Puoi aggiungere utenti solo quando configuri uno spazio (l'aggiunta di app di Chat è supportata solo per la configurazione dei messaggi diretti con l'app per le chiamate). Puoi anche aggiungere membri utilizzando l'indirizzo email dell'utente come alias per {user}. Ad esempio, user.name può essere users/example@gmail.com. Per invitare utenti di Gmail o utenti di domini Google Workspace esterni, è necessario utilizzare l'indirizzo email dell'utente per {user}.

Per l'appartenenza a gruppi Google, il campo Membership.group_member deve contenere un elemento group con name compilato (formato groups/{group}). Puoi aggiungere gruppi Google solo se imposti Space.spaceType su SPACE.

Facoltativo se imposti Space.spaceType su SPACE.

Obbligatorio quando si imposta Space.spaceType su GROUP_CHAT, insieme ad almeno due abbonamenti.

Richiesto quando si imposta Space.spaceType su DIRECT_MESSAGE con un utente, insieme a un solo abbonamento.

Deve essere vuoto durante la creazione di una conversazione 1:1 tra una persona e l'app Chat per le chiamate (se Space.spaceType è impostato su DIRECT_MESSAGE e Space.singleUserBotDm su true).

SlashCommand

Un comando slash in Google Chat.

Campi
command_id

int64

L'ID del comando slash richiamato.

SlashCommandMetadata

Metadati di annotazione per i comandi slash (/).

Campi
bot

User

L'app Chat di cui è stato richiamato il comando.
type

Type

Il tipo di comando slash.
command_name

string

Il nome del comando slash richiamato.
command_id

int64

L'ID del comando slash richiamato.
triggers_dialog

bool

Indica se il comando slash è riferito a una finestra di dialogo.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enumerazione. Non utilizzare.
ADD Aggiungi l'app Chat allo spazio.
INVOKE Richiama il comando slash nello spazio.

Spazio

Uno spazio in Google Chat. Gli spazi sono conversazioni tra due o più utenti o messaggi 1:1 tra un utente e un'app di Chat.

Campi
name

string

Nome risorsa dello spazio.

Formato: spaces/{space}
type
(deprecated)

Type

Solo output. Deprecato: usa invece space_type. Il tipo di uno spazio.
space_type

SpaceType

Il tipo di spazio. Obbligatorio quando crei uno spazio o aggiorni il tipo di spazio di uno spazio. Output solo per altri utilizzi.
single_user_bot_dm

bool

(Facoltativo) Indica se lo spazio è un messaggio diretto tra un'app di Chat e un singolo essere umano.
threaded
(deprecated)

bool

Solo output. Deprecato: usa invece spaceThreadingState. Indica se i messaggi sono organizzati in thread in questo spazio.
display_name

string

Il nome visualizzato dello spazio. Obbligatorio durante la creazione di uno spazio. Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio o aggiorni il displayName, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Per i messaggi diretti, questo campo potrebbe essere vuoto.

Supporta fino a 128 caratteri.
external_user_allowed

bool

Immutabile. Indica se questo spazio consente a qualsiasi utente di Google Chat di diventare membro. Input durante la creazione di uno spazio in un'organizzazione Google Workspace. Ometti questo campo quando crei spazi nelle seguenti condizioni:

  • L'utente autenticato utilizza un account consumer (account utente non gestito). Per impostazione predefinita, uno spazio creato da un account consumer autorizza qualsiasi utente di Google Chat.

Questo campo viene restituito solo per gli spazi esistenti.
space_threading_state

SpaceThreadingState

Solo output. Lo stato dei thread nello spazio di Chat.
space_details

SpaceDetails

Dettagli sullo spazio, tra cui descrizione e regole.
space_history_state

HistoryState

Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio.
import_mode

bool

(Facoltativo) Indica se questo spazio è stato creato in Import Mode nell'ambito di una migrazione dei dati in Google Workspace. Durante l'importazione, gli spazi non saranno visibili agli utenti fino al completamento dell'importazione.
create_time

Timestamp

(Facoltativo) Immutabile. Per gli spazi creati in Chat, la data e l'ora di creazione dello spazio. Questo campo viene solo generato, tranne quando viene utilizzato negli spazi in modalità di importazione.

Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui lo spazio è stato creato nell'origine per conservare l'ora di creazione originale.

Compilato nell'output solo quando spaceType è GROUP_CHAT o SPACE.
last_active_time

Timestamp

Solo output. Timestamp dell'ultimo messaggio nello spazio.

admin_installed

bool

Solo output. Per gli spazi di messaggi diretti (DM) con un'app di Chat, se lo spazio è stato creato da un amministratore di Google Workspace. Gli amministratori possono installare e configurare un messaggio diretto con un'app di Chat per conto degli utenti della loro organizzazione.

Per supportare l'installazione da parte degli amministratori, l'app Chat deve includere la messaggistica diretta.
membership_count

MembershipCount

Solo output. Il numero di iscrizioni raggruppate per tipo di membro. Compilato quando space_type è SPACE, DIRECT_MESSAGE o GROUP_CHAT.

access_settings

AccessSettings

(Facoltativo) Specifica l'impostazione di accesso dello spazio. Compilato solo quando space_type è SPACE.
space_uri

string

Solo output. L'URI di un utente per accedere allo spazio.
Campo unione space_permission_settings. Rappresenta le impostazioni dell'autorizzazione di uno spazio. Compilato solo quando space_type è SPACE. space_permission_settings può essere solo uno dei seguenti:
predefined_permission_settings

PredefinedPermissionSettings

(Facoltativo) Solo input. Impostazioni di autorizzazione dello spazio. Input per la creazione di uno spazio, se questo campo non viene impostato viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono compilate nel campo PermissionSettings.

permission_settings

PermissionSettings

(Facoltativo) Impostazioni di autorizzazione esatte che possono essere impostate per aggiornare lo spazio. Input per l'aggiornamento di uno spazio. In caso contrario, solo output. Per la creazione dello spazio, usa invece predefined_permission_settings.

AccessSettings

Rappresenta l'impostazione di accesso dello spazio.

Campi
access_state

AccessState

Solo output. Indica lo stato di accesso allo spazio.
audience

string

(Facoltativo) Il nome della risorsa del pubblico di destinazione che può scoprire lo spazio, partecipare allo spazio e visualizzare l'anteprima dei messaggi nello spazio. Se il criterio non viene configurato, solo gli utenti o i gruppi Google che sono stati invitati singolarmente o sono stati aggiunti allo spazio potranno accedervi. Per maggiori dettagli, vedi Rendere uno spazio rilevabile per un pubblico di destinazione.

Formato: audiences/{audience}

Per utilizzare il pubblico di destinazione predefinito per l'organizzazione Google Workspace, imposta audiences/default.

AccessState

Rappresenta lo stato di accesso allo spazio.

Enum
ACCESS_STATE_UNSPECIFIED Lo stato dell'accesso è sconosciuto o non supportato in questa API.
PRIVATE Solo gli utenti o i gruppi Google che sono stati aggiunti o invitati singolarmente da altri utenti o da amministratori di Google Workspace possono rilevare e accedere allo spazio.
DISCOVERABLE Un gestore dello spazio ha concesso l'accesso allo spazio a un pubblico di destinazione. Anche gli utenti o i gruppi Google che sono stati aggiunti o invitati singolarmente allo spazio possono scoprire lo spazio e accedervi. Per scoprire di più, consulta Rendere uno spazio rilevabile per utenti specifici.

MembershipCount

Rappresenta il numero di appartenenze a uno spazio, raggruppate in categorie.

Campi
joined_direct_human_user_count

int32

Numero di utenti umani che sono entrati direttamente nello spazio, senza contare gli utenti che si sono uniti a un gruppo iscritto.
joined_group_count

int32

Numero di tutti i gruppi che sono entrati direttamente nello spazio.

PermissionSetting

Rappresenta un'impostazione di autorizzazione dello spazio.

Campi
managers_allowed

bool

Indica se i gestori degli spazi hanno questa autorizzazione.
members_allowed

bool

Indica se i membri non amministratori dispongono di questa autorizzazione.

PermissionSettings

Impostazioni delle autorizzazioni per uno spazio denominato. Per configurare le impostazioni di autorizzazione quando crei uno spazio, specifica il campo PredefinedPermissionSettings nella richiesta.

Campi
manage_members_and_groups

PermissionSetting

Impostazione per la gestione di membri e gruppi in uno spazio.
modify_space_details

PermissionSetting

Impostazione per l'aggiornamento del nome dello spazio, dell'avatar, della descrizione e delle linee guida.
toggle_history

PermissionSetting

Impostazione per attivare e disattivare la cronologia degli spazi.
use_at_mention_all

PermissionSetting

Impostazione per l'utilizzo di @tutti in uno spazio.
manage_apps

PermissionSetting

Impostazione per la gestione delle app in uno spazio.
manage_webhooks

PermissionSetting

Impostazione per la gestione dei webhook in uno spazio.
post_messages

PermissionSetting

Solo output. Impostazione per la pubblicazione di messaggi in uno spazio.
reply_messages

PermissionSetting

Impostazione per rispondere ai messaggi in uno spazio.

PredefinedPermissionSettings

Le impostazioni delle autorizzazioni per lo spazio che puoi specificare quando crei uno spazio denominato. In futuro potrebbero essere aggiunte altre impostazioni. Per maggiori dettagli sulle impostazioni delle autorizzazioni per gli spazi denominati, vedi Scopri di più sugli spazi.

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Non specificato. Non utilizzare.
COLLABORATION_SPACE Impostazione per rendere lo spazio uno spazio di collaborazione in cui tutti i membri possono pubblicare messaggi.
ANNOUNCEMENT_SPACE Impostazione per rendere lo spazio uno spazio per gli annunci in cui solo i gestori dello spazio possono pubblicare messaggi.

SpaceDetails

Dettagli sullo spazio, tra cui descrizione e regole.

Campi
description

string

(Facoltativo) Una descrizione dello spazio. Ad esempio, descrivi l'argomento di discussione, lo scopo funzionale o i partecipanti dello spazio.

Supporta fino a 150 caratteri.
guidelines

string

(Facoltativo) Le regole, le aspettative e l'etichetta dello spazio.

Supporta fino a 5000 caratteri.

SpaceThreadingState

Specifica il tipo di stato dei thread nello spazio di Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Riservato.
THREADED_MESSAGES Spazi con nome che supportano i thread di messaggi. Quando gli utenti rispondono a un messaggio, possono rispondere in thread, conservando la risposta nel contesto del messaggio originale.
GROUPED_MESSAGES Spazi con nome in cui la conversazione è organizzata per argomento. Gli argomenti e le relative risposte vengono raggruppati insieme.
UNTHREADED_MESSAGES Messaggi diretti tra due persone e conversazioni di gruppo tra tre o più persone.

SpaceType

Il tipo di spazio. Obbligatorio quando crei o aggiorni uno spazio. Output solo per altri utilizzi.

Enum
SPACE_TYPE_UNSPECIFIED Riservato.
SPACE Un luogo in cui le persone inviano messaggi, condividono file e collaborano. Un SPACE può includere app di chat.
GROUP_CHAT Conversazioni di gruppo tra 3 o più persone. Un GROUP_CHAT può includere app di chat.
DIRECT_MESSAGE Messaggi 1:1 tra due persone o una persona e un'app di Chat.

Tipo

Deprecato: usa invece SpaceType.

Enum
TYPE_UNSPECIFIED Riservato.
ROOM Conversazioni tra due o più persone.
DM Messaggio diretto 1:1 tra un utente e un'app di Chat, in cui tutti i messaggi sono piatti. Tieni presente che non sono inclusi i messaggi diretti tra due persone.

SpaceBatchUpdatedEventData

Payload dell’evento per più aggiornamenti di uno spazio.

Tipo di evento: google.workspace.chat.space.v1.batchUpdated

Campi
spaces[]

SpaceUpdatedEventData

Un elenco degli spazi aggiornati.

SpaceEvent

Un evento che rappresenta una modifica o un'attività in uno spazio di Google Chat. Per scoprire di più, vedi Utilizzare gli eventi di Google Chat.

Campi
name

string

Nome risorsa dell'evento dello spazio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

L'ora in cui si è verificato l'evento.
event_type

string

Tipo di evento nello spazio. Ogni tipo di evento ha una versione batch, che rappresenta più istanze del tipo di evento che si verificano in un breve periodo di tempo. Per le richieste spaceEvents.list(), ometti i tipi di eventi batch nel filtro di query. Per impostazione predefinita, il server restituisce sia il tipo di evento sia la sua versione batch.

Tipi di eventi supportati per i messaggi:

  • Nuovo messaggio: google.workspace.chat.message.v1.created
  • Messaggio aggiornato: google.workspace.chat.message.v1.updated
  • Messaggio eliminato: google.workspace.chat.message.v1.deleted
  • Più nuovi messaggi: google.workspace.chat.message.v1.batchCreated
  • Più messaggi aggiornati: google.workspace.chat.message.v1.batchUpdated
  • Più messaggi eliminati: google.workspace.chat.message.v1.batchDeleted

Tipi di eventi supportati per gli abbonamenti:

  • Nuovo abbonamento: google.workspace.chat.membership.v1.created
  • Abbonamento aggiornato: google.workspace.chat.membership.v1.updated
  • Abbonamento eliminato: google.workspace.chat.membership.v1.deleted
  • Nuovi abbonamenti multipli: google.workspace.chat.membership.v1.batchCreated
  • Più abbonamenti aggiornati: google.workspace.chat.membership.v1.batchUpdated
  • Più abbonamenti eliminati: google.workspace.chat.membership.v1.batchDeleted

Tipi di eventi supportati per le reazioni:

  • Nuova reazione: google.workspace.chat.reaction.v1.created
  • Reazione eliminata: google.workspace.chat.reaction.v1.deleted
  • Molteplici nuove reazioni: google.workspace.chat.reaction.v1.batchCreated
  • Più reazioni eliminate: google.workspace.chat.reaction.v1.batchDeleted

Tipi di eventi supportati per lo spazio:

  • Spazio aggiornato: google.workspace.chat.space.v1.updated
  • Più aggiornamenti dello spazio: google.workspace.chat.space.v1.batchUpdated

Campo unione payload.

payload può essere solo uno dei seguenti:
message_created_event_data

MessageCreatedEventData

Payload dell'evento per un nuovo messaggio.

Tipo di evento: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

Payload dell'evento per un messaggio aggiornato.

Tipo di evento: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

Payload dell'evento per un messaggio eliminato.

Tipo di evento: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

Payload dell'evento per più nuovi messaggi.

Tipo di evento: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

Payload dell'evento per più messaggi aggiornati.

Tipo di evento: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

Payload dell'evento per più messaggi eliminati.

Tipo di evento: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

Payload dell'evento per un aggiornamento dello spazio.

Tipo di evento: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

Payload dell’evento per più aggiornamenti di uno spazio.

Tipo di evento: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

Payload dell'evento per una nuova appartenenza.

Tipo di evento: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

Payload dell'evento per un'appartenenza aggiornata.

Tipo di evento: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

Payload dell'evento per un'appartenenza eliminata.

Tipo di evento: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

Payload dell'evento per più nuove iscrizioni.

Tipo di evento: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Payload dell'evento per più appartenenze aggiornate.

Tipo di evento: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Payload dell'evento per più appartenenze eliminate.

Tipo di evento: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

Payload dell'evento per una nuova reazione.

Tipo di evento: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

Payload dell'evento per una reazione eliminata.

Tipo di evento: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

Payload dell’evento per diverse nuove reazioni.

Tipo di evento: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Payload dell'evento per più reazioni eliminate.

Tipo di evento: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

Lo stato di lettura di un utente all'interno di uno spazio, utilizzato per identificare i messaggi letti e da leggere.

Campi
name

string

Nome risorsa dello stato di lettura dello spazio.

Formato: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

(Facoltativo) L'ora in cui lo stato di lettura dello spazio dell'utente è stato aggiornato. Di solito corrisponde al timestamp dell'ultimo messaggio letto o a un timestamp specificato dall'utente per contrassegnare l'ultima posizione di lettura in uno spazio.

SpaceUpdatedEventData

Payload dell'evento per uno spazio aggiornato.

Tipo di evento: google.workspace.chat.space.v1.updated

Campi
space

Space

Lo spazio aggiornato.

Thread

Un thread in uno spazio di Google Chat. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.

Se specifichi un thread durante la creazione di un messaggio, puoi impostare il campo messageReplyOption per determinare cosa succede se non viene trovato alcun thread corrispondente.

Campi
name

string

Nome risorsa del thread.

Esempio: spaces/{space}/threads/{thread}
thread_key

string

(Facoltativo) Input per la creazione o l'aggiornamento di un thread. In caso contrario, solo output. ID del thread. Supporta fino a 4000 caratteri.

Questo ID è univoco per l'app Chat che lo imposta. Ad esempio, se più app di Chat creano un messaggio utilizzando la stessa chiave di thread, i messaggi vengono pubblicati in thread diversi. Per rispondere in un thread creato da una persona o da un'altra app di Chat, specifica invece il campo name del thread.

ThreadReadState

Lo stato di lettura di un utente all'interno di un thread, utilizzato per identificare i messaggi letti e da leggere.

Campi
name

string

Nome risorsa dello stato di lettura del thread.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

L'ora in cui è stato aggiornato lo stato di lettura del thread dell'utente. Di solito corrisponde al timestamp dell'ultimo messaggio letto in un thread.

UpdateMembershipRequest

Messaggio di richiesta di aggiornamento di un abbonamento.

Campi
membership

Membership

Obbligatorio. L'abbonamento da aggiornare. Vengono aggiornati solo i campi specificati da update_mask.
update_mask

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza * per aggiornare tutti i percorsi dei campi.

Percorsi dei campi attualmente supportati:

  • role
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

Richiedere l'aggiornamento di un messaggio.

Campi
message

Message

Obbligatorio. Messaggio con campi aggiornati.
update_mask

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza * per aggiornare tutti i percorsi dei campi.

Percorsi dei campi attualmente supportati:
allow_missing

bool

(Facoltativo) Se true e il messaggio non vengono trovati, viene creato un nuovo messaggio e updateMask viene ignorato. L'ID messaggio specificato deve essere assegnato dal client, altrimenti la richiesta non va a buon fine.

UpdateSpaceReadStateRequest

Messaggio di richiesta per l'API UpdateSpaceReadState.

Campi
space_read_state

SpaceReadState

Obbligatorio. Lo stato di lettura dello spazio e i campi da aggiornare.

Supporta solo l'aggiornamento dello stato di lettura per l'utente chiamante.

Per fare riferimento all'utente chiamante, imposta una delle seguenti opzioni:

  • L'alias me. Ad esempio, users/me/spaces/{space}/spaceReadState.

  • L'indirizzo email di Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

  • Il relativo ID utente. Ad esempio, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Percorsi dei campi attualmente supportati:

  • last_read_time

Quando last_read_time è precedente all'ora di creazione dell'ultimo messaggio, lo spazio appare come da leggere nell'interfaccia utente.

Per contrassegnare lo spazio come letto, imposta last_read_time su un valore successivo (più grande) dell'ora di creazione dell'ultimo messaggio. Il valore last_read_time viene forzato in modo che corrisponda all'ora di creazione del messaggio più recente. Tieni presente che lo stato di lettura dello spazio influisce solo sullo stato di lettura dei messaggi visibili nella conversazione di primo livello dello spazio. Le risposte nei thread non sono interessate da questo timestamp e si basano invece sullo stato di lettura del thread.

UpdateSpaceRequest

Richiesta di aggiornamento di un singolo spazio.

Campi
space

Space

Obbligatorio. Spazio con campi da aggiornare. Space.name deve essere compilato nel formato spaces/{space}. Vengono aggiornati solo i campi specificati da update_mask.
update_mask

FieldMask

Obbligatorio. I percorsi dei campi aggiornati, separati da virgole, se presenti.

Puoi aggiornare i seguenti campi per uno spazio:

  • space_details

  • display_name: è supportato solo l'aggiornamento del nome visualizzato per gli spazi in cui il campo spaceType è SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS, prova con un valore diverso. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

  • space_type: supporta solo la modifica di un tipo di spazio GROUP_CHAT in SPACE. Includi display_name insieme a space_type nella maschera di aggiornamento e assicurati che lo spazio specificato abbia un nome visualizzato non vuoto e il tipo di spazio SPACE. L'inclusione della maschera space_type e del tipo SPACE nello spazio specificato durante l'aggiornamento del nome visualizzato è facoltativa se lo spazio esistente presenta già il tipo SPACE. Se provi ad aggiornare il tipo di spazio in altri modi, viene visualizzato un errore relativo a un argomento non valido. L'app space_type non è supportata con l'accesso amministrativo.

  • space_history_state: aggiorna le impostazioni della cronologia degli spazi attivando o disattivando la cronologia per lo spazio. Funzionalità supportata solo se le impostazioni della cronologia sono attivate per l'organizzazione Google Workspace. Per aggiornare lo stato della cronologia degli spazi, devi omettere tutte le altre maschere dei campi nella richiesta. L'app space_history_state non è supportata con l'accesso amministrativo.

  • access_settings.audience: aggiorna l'impostazione di accesso relativa a chi può scoprire e partecipare allo spazio, nonché visualizzare l'anteprima dei messaggi nello spazio denominato in cui il campo spaceType è SPACE. Se lo spazio esistente ha un pubblico di destinazione, puoi rimuoverlo e limitare l'accesso allo spazio omettendo un valore per questa maschera di campo. Per aggiornare le impostazioni di accesso per uno spazio, l'utente che esegue l'autenticazione deve essere un gestore dello spazio e omettere tutte le altre maschere dei campi nella richiesta. Non puoi aggiornare questo campo se lo spazio è in modalità di importazione. Per scoprire di più, consulta Rendere uno spazio rilevabile per utenti specifici. L'app access_settings.audience non è supportata con l'accesso amministrativo.

  • Anteprima per gli sviluppatori: supporta la modifica delle impostazioni delle autorizzazioni di uno spazio. I percorsi dei campi supportati includono: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (avviso: si escludono a vicenda tutti gli altri percorsi dei campi relativi alle impostazioni non di autorizzazione). L'app permission_settings non è supportata con l'accesso amministrativo.
use_admin_access

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.spaces.

Alcuni valori di FieldMask non sono supportati se utilizzi l'accesso amministrativo. Per maggiori dettagli, vedi la descrizione di update_mask.

Utente

Un utente di Google Chat. Quando viene restituito come output da una richiesta, se la tua app Chat si autentica come utente, l'output per una risorsa User completa solo i valori name e type dell'utente.

Campi
name

string

Nome risorsa per user di Google Chat.

Formato: users/{user}. users/app può essere utilizzato come alias per l'utente bot dell'app per la chiamata.

Per human users, {user} è lo stesso identificatore utente di:

  • id per la persona nell'API People. Ad esempio, users/123456789 nell'API Chat rappresenta la stessa persona dell'ID profilo persona 123456789 nell'API People.

  • id per un utente nell'API Admin SDK Directory.

  • l'indirizzo email dell'utente può essere utilizzato come alias per {user} nelle richieste API. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi utilizzare users/user@example.com come alias per fare riferimento a users/123456789. L'API restituirà solo il nome canonico della risorsa (ad esempio users/123456789).
display_name

string

Solo output. Il nome visualizzato dell'utente.
domain_id

string

L'identificatore univoco del dominio Google Workspace dell'utente.
type

Type

Tipo di utente.
is_anonymous

bool

Solo output. Quando true, l'utente viene eliminato o il suo profilo non è visibile.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enumerazione. NON UTILIZZARE.
HUMAN Utente umano.
BOT Utente dell'app di chat.

UserMentionMetadata

Metadati delle annotazioni per le menzioni degli utenti (@).

Campi
user

User

L'utente menzionato.
type

Type

Il tipo di menzione dell'utente.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enumerazione. Non utilizzare.
ADD Aggiungi utente allo spazio.
MENTION Menziona l'utente nello spazio.

WidgetMarkup

Un widget è un elemento dell'interfaccia utente che presenta testo e immagini.

Campi
buttons[]

Button

Un elenco di pulsanti. Anche i pulsanti sono oneof data e solo uno di questi campi deve essere impostato.
Campo unione data. Un WidgetMarkup può avere solo uno dei seguenti elementi. Puoi utilizzare più campi WidgetMarkup per visualizzare più elementi. data può essere solo uno dei seguenti:
text_paragraph

TextParagraph

Visualizza un paragrafo di testo in questo widget.
image

Image

Visualizza un'immagine in questo widget.
key_value

KeyValue

Visualizza un elemento chiave-valore in questo widget.

Pulsante

Un pulsante. Può essere un pulsante di testo o un pulsante immagine.

Campi

Campo unione type.

type può essere solo uno dei seguenti:
text_button

TextButton

Un pulsante con testo e azione di onclick.
image_button

ImageButton

Un pulsante con immagine e azione di onclick.

FormAction

Un'azione del modulo descrive il comportamento quando viene inviato. Ad esempio, puoi richiamare Apps Script per gestire il modulo.

Campi
action_method_name

string

Il nome del metodo viene utilizzato per identificare quale parte del modulo ha attivato l'invio del modulo. Queste informazioni vengono riportate nell'app Chat come parte dell'evento di clic sulla scheda. Puoi utilizzare lo stesso nome di metodo per diversi elementi che attivano un comportamento comune.
parameters[]

ActionParameter

Elenco dei parametri di azione.

ActionParameter

Elenco di parametri stringa da fornire quando viene richiamato il metodo di azione. Ad esempio, considera tre pulsanti per posticiparla: Posticipa ora, Posticipa un giorno e Posticipa la prossima settimana. Puoi utilizzare action method = snooze(), per trasmettere il tipo e il tempo di posticipazione nell'elenco dei parametri stringa.

Campi
key

string

Il nome del parametro per l'action script.
value

string

Il valore del parametro.

Icona

L'insieme di icone supportate.

Enum
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Immagine

Un'immagine che è specificata da un URL e può avere un'azione onclick.

Campi
image_url

string

L'URL dell'immagine.
on_click

OnClick

L'azione onclick.
aspect_ratio

double

Le proporzioni dell'immagine (larghezza e altezza). Questo campo ti consente di riservare l'altezza giusta per l'immagine in attesa del suo caricamento. Questa funzione non intende sostituire le proporzioni integrate dell'immagine. Se il criterio non viene configurato, il server lo riempie precaricando l'immagine.

ImageButton

Un pulsante immagine con un'azione onclick.

Campi
on_click

OnClick

L'azione onclick.
name

string

Il nome di questo elemento image_button utilizzato per l'accessibilità. Se questo nome non è specificato, viene fornito il valore predefinito.
Campo unione icons. L'icona può essere specificata da un Icon enum o da un URL. icons può essere solo uno dei seguenti:
icon

Icon

L'icona specificata da un enum che indirizza a un'icona fornita dall'API Chat.
icon_url

string

L'icona specificata da un URL.

KeyValue

Un elemento UI contiene una chiave (etichetta) e un valore (contenuti). Questo elemento può anche contenere alcune azioni, come il pulsante onclick.

Campi
top_label

string

Il testo dell'etichetta in alto. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
content

string

Il testo dei contenuti. Testo formattato supportato e sempre obbligatorio. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
content_multiline

bool

Se i contenuti devono essere su più righe.
bottom_label

string

Il testo dell'etichetta in basso. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
on_click

OnClick

L'azione onclick. Sono selezionabili solo l'etichetta superiore, l'etichetta inferiore e l'area di contenuti.
Campo unione icons. È necessario definire almeno una delle icone, top_label e bottom_label. icons può essere solo uno dei seguenti:
icon

Icon

Un valore enum sostituito dall'API Chat con l'immagine dell'icona corrispondente.
icon_url

string

L'icona specificata da un URL.
Campo unione control. Un widget di controllo. Puoi impostare button o switch_widget, ma non entrambi. control può essere solo uno dei seguenti:
button

Button

Un pulsante su cui è possibile fare clic per attivare un'azione.

OnClick

Un'azione onclick (ad esempio, aprire un link).

Campi

Campo unione data.

data può essere solo uno dei seguenti:
action

FormAction

Un'azione del modulo viene attivata da questa azione onclick, se specificata.

TextButton

Un pulsante con testo e azione di onclick.

Campi
text

string

Il testo del pulsante.
on_click

OnClick

L'azione onclick del pulsante.

TextParagraph

Un paragrafo di testo. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

Campi
text

string