Package google.chat.v1

Indice

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Crea un'emoji personalizzata.

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

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

Supporta i seguenti tipi di autenticazione:

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

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

Per un esempio di utilizzo, consulta:

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

Supporta i seguenti tipi di autenticazione:

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

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

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

Messaggio inviato con autenticazione con app

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

Messaggio inviato con autenticazione utente

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

Crea un messaggio bloccato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

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

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateSection

rpc CreateSection(CreateSectionRequest) returns (Section)

Crea una sezione in Google Chat. Le sezioni aiutano gli utenti a raggruppare le conversazioni e a personalizzare l'elenco degli spazi visualizzati nel riquadro di navigazione di Chat. È possibile creare solo sezioni di tipo CUSTOM_SECTION. Per maggiori dettagli, vedi Crea e organizza le sezioni in Google Chat.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Crea uno spazio. Può essere utilizzato per creare uno spazio con nome o una chat di gruppo in Import mode. Per un esempio, consulta Crea uno spazio.

Supporta i seguenti tipi di autenticazione:

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

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

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

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Supporta i seguenti tipi di autenticazione:

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Elimina un messaggio. Per un esempio, vedi Elimina un messaggio.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteMessagePin

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

Elimina un messaggio fissato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Elimina una reazione a un messaggio. Per un esempio, consulta Elimina una reazione.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

Elimina una sezione di tipo CUSTOM_SECTION.

Se la sezione contiene elementi, ad esempio spazi, questi vengono spostati nelle sezioni predefinite di Google Chat e non vengono eliminati.

Per maggiori dettagli, vedi Crea e organizza le sezioni in Google Chat.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

Supporta i seguenti tipi di autenticazione:

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

    • https://www.googleapis.com/auth/chat.app.delete (solo negli spazi creati dall'app)

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Restituisce il messaggio diretto esistente con l'utente specificato. Se non viene trovato alcuno spazio per i messaggi diretti, restituisce un errore 404 NOT_FOUND. Per un esempio, vedi Trova un messaggio diretto.

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

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

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

Restituisce tutti gli spazi con spaceType == GROUP_CHAT, le cui iscrizioni umane contengono esattamente l'utente chiamante e gli utenti specificati in FindGroupChatsRequest.users. Sono supportati solo i membri che hanno partecipato alla conversazione. Per un esempio, vedi Trova chat di gruppo.

Se l'utente chiamante blocca o viene bloccato da alcuni utenti e non vengono trovati spazi con l'intero insieme di utenti specificato, questo metodo restituisce spazi che non includono gli utenti bloccati o che bloccano.

L'insieme di utenti specificato deve contenere solo iscrizioni umane (non di app). Una richiesta che contiene utenti non umani non restituisce spazi.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Recupera i metadati di un allegato del messaggio. I dati dell'allegato vengono recuperati utilizzando l'API Media. Per un esempio, consulta Recupera i metadati relativi a un allegato di un messaggio.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

Restituisce le informazioni sulla disponibilità di un utente umano in Google Chat. Ad esempio, può essere utilizzato per verificare se un utente è online o assente o per recuperare il suo messaggio di stato personalizzato.

Questo metodo recupera solo la disponibilità dell'utente autenticato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Restituisce i dettagli di un'emoji personalizzata.

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

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Restituisce i dettagli di un messaggio. Per un esempio, consulta Recupera i dettagli di un messaggio.

Supporta i seguenti tipi di autenticazione:

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

    • https://www.googleapis.com/auth/chat.bot: quando utilizzi questo ambito di autorizzazione, questo metodo restituisce i dettagli di un messaggio a cui l'app di Chat ha accesso, ad esempio i messaggi diretti e i comandi slash che richiamano l'app di Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly con l'approvazione dell'amministratore. Quando utilizzi questo ambito di autenticazione, questo metodo restituisce i dettagli di un messaggio pubblico in uno spazio.

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

L'autenticazione delle app presenta le seguenti limitazioni:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

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

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

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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 saperne di più, consulta la guida all'autorizzazione.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, 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, utilizzato per identificare i messaggi letti e non letti. Per un esempio, consulta Recupera i dettagli sullo stato di lettura dello spazio di un utente.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, 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, utilizzato per identificare i messaggi letti e non letti. Per un esempio, vedi Visualizza i dettagli dello stato di lettura di un thread di un utente.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Elenca le emoji personalizzate visibili all'utente autenticato.

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

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

Supporta i seguenti tipi di autenticazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

Elenca i messaggi bloccati in uno spazio. Gli utenti possono fissare i messaggi importanti negli spazi per accedervi facilmente. Per saperne di più, vedi Fissare o sganciare una conversazione in Google Chat.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

Supporta i seguenti tipi di autenticazione:

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Elenca le reazioni a un messaggio. Per un esempio, consulta Elenca le reazioni a un messaggio.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

Elenca gli elementi di una sezione.

Solo gli spazi possono essere elementi di una sezione. Per maggiori dettagli, vedi Creare e organizzare le sezioni in Google Chat.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

Elenca le sezioni disponibili per l'utente di Chat. Le sezioni aiutano gli utenti a raggruppare le conversazioni e a personalizzare l'elenco degli spazi visualizzati nel riquadro di navigazione di Chat. Per maggiori dettagli, vedi Crea e organizza le sezioni in Google Chat.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

Per un esempio, consulta Elenca gli eventi di uno spazio di Google Chat.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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 saperne di più, 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, consulta Elenca gli spazi.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Per elencare tutti gli spazi con nome per organizzazione Google Workspace, utilizza invece il metodo spaces.search() con i privilegi amministrativi 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 saperne di più, consulta la guida all'autorizzazione.
MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

Contrassegna l'utente come ACTIVE in Google Chat.

Imposta lo stato di disponibilità dell'utente su ACTIVE. Lo stato ACTIVE dura fino alla scadenza specificata, dopodiché lo stato dell'utente diventa AWAY. Tieni presente che se l'utente utilizza attivamente Chat, la durata dello stato ACTIVE potrebbe estendersi oltre la scadenza fornita.

Questo metodo aggiorna solo la disponibilità dell'utente autenticato.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
MarkAsAway

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

Contrassegna l'utente come AWAY in Google Chat.

Imposta lo stato dell'utente su Assente e non è influenzato dall'attività dell'utente.

Questo metodo aggiorna solo la disponibilità dell'utente autenticato.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

Contrassegna l'utente come DO_NOT_DISTURB in Google Chat.

Imposta lo stato di disponibilità di un utente su DO_NOT_DISTURB fino a una data di scadenza specificata. Quando è attiva la modalità DO_NOT_DISTURB, in genere gli utenti non ricevono notifiche.

Questo metodo aggiorna solo la disponibilità dell'utente autenticato.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
MoveSectionItem

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

Sposta un elemento da una sezione all'altra. Ad esempio, se una sezione contiene spazi, questo metodo può essere utilizzato per spostare uno spazio in un'altra sezione. Per maggiori dettagli, vedi Crea e organizza le sezioni in Google Chat.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
PositionSection

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

Modifica l'ordinamento di una sezione. Per maggiori dettagli, vedi Creare e organizzare le sezioni in Google Chat.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

Sostituisce le schede incluse in un messaggio.

Un'app di Chat può sostituire le schede di un messaggio creato da una persona solo se il messaggio contiene già schede e queste sono state create dall'app.

Se l'app sostituisce le tessere con un elenco vuoto, le tessere vengono rimosse. Dopo aver rimosso le schede, l'app non può aggiungerle nuovamente al messaggio.

Richiede l'autenticazione dell'app con l'ambito di autorizzazione: - https://www.googleapis.com/auth/chat.bot

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

Cerca i messaggi in Google Chat a cui l'utente chiamante ha accesso. Restituisce un elenco di messaggi corrispondenti ai criteri di ricerca.

Per eseguire la ricerca in tutti gli spazi a cui l'utente ha accesso, imposta parent su spaces/-. L'utilizzo di qualsiasi altro valore per parent genera un errore INVALID_ARGUMENT. I messaggi restituiti hanno il campo name compilato con il nome completo della risorsa, che include l'argomento space specifico in cui si trova il messaggio.

Questa API non restituisce tutti i tipi di messaggi. I tipi di messaggi elencati di seguito non sono inclusi nella risposta. Utilizza ListMessages per elencare tutti i messaggi.

  • Messaggi privati visibili all'utente autenticato.
  • Messaggi pubblicati dalle app di Chat negli spazi o nelle chat di gruppo.
  • Messaggi in un DM di un'app di Chat.
  • Messaggi di utenti bloccati.
  • Messaggi negli spazi che il chiamante ha disattivato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Restituisce un elenco di spazi in un'organizzazione Google Workspace. Per un esempio, consulta Cerca e gestisci gli spazi.

Quando use_admin_access è impostato su false, i risultati sono limitati agli spazi in cui l'utente chiamante è un membro che ha eseguito l'accesso. Per eseguire la ricerca con privilegi amministrativi, imposta use_admin_access su true.

Supporta i seguenti tipi di autenticazione:

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

Per saperne di più, consulta la guida all'autorizzazione.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

Per specificare i membri umani da aggiungere, aggiungi le iscrizioni con il valore 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 della persona dall'API People o il id dell'utente nell'API Directory. Ad esempio, se l'ID profilo della persona dell'API People per 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 valore membership.group_member.name appropriato. Per aggiungere o invitare un gruppo Google, utilizza groups/{group}, dove {group} è il id del gruppo dall'API Cloud Identity Groups. Ad esempio, puoi utilizzare l'API di ricerca di Cloud Identity Groups per recuperare l'ID 123456789 per l'indirizzo email del gruppo group@example.com, quindi puoi aggiungere il gruppo allo spazio impostando membership.group_member.name su groups/123456789. L'indirizzo email del gruppo non è supportato e i gruppi Google possono essere aggiunti come membri solo negli spazi con nome.

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

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

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

Se esiste già un messaggio diretto tra due utenti, anche se un utente blocca l'altro al momento della 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 displayName diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

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

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateAvailability

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

Aggiorna le informazioni sulla disponibilità di un utente umano. Solo il campo custom_status può essere aggiornato tramite questo metodo.

Questo metodo aggiorna solo la disponibilità dell'utente autenticato.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Aggiorna un'iscrizione. Per un esempio, consulta Aggiorna l'iscrizione di un utente a uno spazio.

Supporta i seguenti tipi di autenticazione:

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

    • https://www.googleapis.com/auth/chat.app.memberships (solo negli spazi creati dall'app)

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Aggiorna un messaggio. Esiste una differenza tra i metodi patch e update. Il metodo patch utilizza una richiesta patch, mentre il metodo update utilizza una richiesta put. Ti consigliamo di utilizzare il metodo patch. Per un esempio, consulta Aggiorna un messaggio.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateSection

rpc UpdateSection(UpdateSectionRequest) returns (Section)

Aggiorna una sezione. È possibile aggiornare solo le sezioni di tipo CUSTOM_SECTION. Per maggiori dettagli, vedi Crea e organizza le sezioni in Google Chat.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Aggiorna uno spazio. Per un esempio, consulta Aggiorna uno spazio.

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

Supporta i seguenti tipi di autenticazione:

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

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

L'autenticazione delle app presenta le seguenti limitazioni:

  • Per aggiornare space.predefined_permission_settings o space.permission_settings, l'app deve essere il creatore dello spazio.
  • L'aggiornamento di space.access_settings.audience non è supportato per l'autenticazione dell'app.
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, 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 non letti. Per un esempio, consulta Aggiorna lo stato di lettura di uno spazio di un utente.

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

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

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.

AccessoryWidget

Uno o più widget interattivi 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 tipi:
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 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 Pubblicare un nuovo messaggio nell'argomento.
UPDATE_MESSAGE Aggiorna il messaggio dell'app di Chat. Questa operazione è consentita solo per un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT.
UPDATE_USER_MESSAGE_CARDS Aggiorna le schede nel messaggio di un utente. Questa operazione è consentita solo come 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 Presenta una finestra di dialogo.
UPDATE_WIDGET Query delle opzioni di completamento automatico del testo del widget.

SelectionItems

Elenco dei risultati di completamento automatico del widget.

Campi
items[]

SelectionItem

Un array di oggetti SelectionItem.

UpdatedWidget

Per i widget selectionInput, restituisce i suggerimenti di completamento automatico per un menu a selezione multipla.

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 tipi:
suggestions

SelectionItems

Elenco dei risultati del completamento automatico del widget

ActionStatus

Rappresenta lo stato di una richiesta di richiamo o invio di una finestra di dialogo.

Campi
status_code

Code

Il codice di stato.
user_facing_message

string

Il messaggio da inviare agli utenti sullo stato della loro richiesta. Se non viene impostato, viene inviato un messaggio generico basato su status_code.

Annotazione

Le annotazioni possono essere associate al corpo del messaggio in testo normale o ai chip che rimandano a risorse di Google Workspace come Documenti Google o Fogli Google con start_index e length pari a 0. Per aggiungere la formattazione di base a un messaggio, consulta Formattare i messaggi.

Esempio di corpo del messaggio in 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. Se non è presente, indica una lunghezza pari a 0.
start_index

int32

Indice iniziale (in base 0, inclusivo) 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 tipi:
user_mention

UserMentionMetadata

I metadati della menzione dell'utente.
slash_command

SlashCommandMetadata

I metadati di un comando slash.
custom_emoji_metadata

CustomEmojiMetadata

I metadati di un'emoji personalizzata.

AnnotationType

Il tipo di annotazione.

Enum
ANNOTATION_TYPE_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
USER_MENTION Un utente viene menzionato.
SLASH_COMMAND Viene richiamato un comando slash.
CUSTOM_EMOJI Un'annotazione di emoji personalizzata.

AppCommandMetadata

Metadati relativi a un comando dell'app di Chat.

Campi
app_command_id

int32

L'ID del comando specificato nella configurazione dell'API Chat.
app_command_type

AppCommandType

Il tipo di comando dell'app di Chat.

AppCommandType

Il tipo di comando dell'app di Chat. Per maggiori dettagli, vedi Tipi di comandi delle app di Chat.

Enum
APP_COMMAND_TYPE_UNSPECIFIED Valore predefinito. Non specificato.
SLASH_COMMAND Un comando slash. L'utente invia il comando in un messaggio chat.
QUICK_COMMAND Un comando rapido. L'utente seleziona il comando dal menu di Chat nell'area di risposta ai messaggi.
MESSAGE_ACTION Un'azione suggerita. L'utente seleziona il comando dal menu contestuale del messaggio in Chat.

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

Identificatore. Nome della risorsa dell'allegato.

Formato: spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

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

string

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

string

Solo output. L'URL della miniatura che deve essere utilizzato per visualizzare l'anteprima dell'allegato per 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 umano di scaricare l'allegato. Le app di Chat non devono utilizzare questo URL per scaricare i contenuti degli allegati.
source

Source

Solo output. La fonte dell'allegato.
Campo unione data_ref. Il riferimento ai dati dell'allegato. data_ref può essere solo uno dei seguenti tipi:
attachment_data_ref

AttachmentDataRef

Facoltativo. Un riferimento ai dati dell'allegato. Questo campo viene utilizzato per creare o aggiornare i messaggi con allegati o con l'API Media 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 dell'allegato.

Campi
resource_name

string

Facoltativo. Il nome della risorsa dei dati dell'allegato. Questo campo viene utilizzato con l'API Media per scaricare i dati dell'allegato.
attachment_upload_token

string

Facoltativo. Token opaco contenente un riferimento a un allegato caricato. Trattato dai client come una stringa opaca e utilizzato per creare o aggiornare i messaggi chat con allegati.

Pubblico

Un pubblico di destinazione in Google Chat. Un pubblico di destinazione rappresenta un gruppo di utenti all'interno di un'organizzazione Google Workspace, definito da un amministratore. I segmenti di pubblico di destinazione vengono utilizzati per configurare le impostazioni di accesso e visibilità per le risorse, ad esempio per rendere uno spazio rilevabile da un gruppo specifico di utenti.

Per maggiori dettagli, vedi Pubblico di destinazione e Rendere uno spazio rilevabile da un pubblico di destinazione.

Campi
name

string

Il nome della risorsa del pubblico di destinazione che può scoprire o partecipare allo spazio. Per maggiori dettagli, vedi Rendi uno spazio rilevabile per un pubblico di destinazione. Formato: audiences/{audience}

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

Disponibilità

Rappresenta le informazioni sulla disponibilità corrente di un utente in Google Chat, incluso il suo stato (ad esempio Attivo, Assente, Non disturbare) e qualsiasi stato personalizzato.

Campi
name

string

Identificatore. Nome risorsa della disponibilità dell'utente.

Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me
state

State

Solo output. Lo stato di disponibilità attuale dell'utente.
custom_status

CustomStatus

Facoltativo. Lo stato personalizzato dell'utente.
Campo unione state_metadata. Metadati aggiuntivi associati allo stato di disponibilità dell'utente. state_metadata può essere solo uno dei seguenti tipi:
do_not_disturb_metadata

DoNotDisturbMetadata

Solo output. Metadati se lo stato dell'utente è impostato su DO_NOT_DISTURB.

Stato

Rappresenta lo stato di disponibilità corrente dell'utente.

Enum
STATE_UNSPECIFIED Valore predefinito. Lo stato non è specificato.
ACTIVE L'utente è attualmente attivo, in base all'attività recente.
IDLE L'utente è attualmente inattivo. Questo stato indica un periodo di inattività dopo lo stato ATTIVO, prima di passare potenzialmente allo stato FUORI CASA.
AWAY L'utente è attualmente assente. Questo stato può essere impostato automaticamente dopo un periodo di inattività in stato ACTIVE o IDLE oppure può essere impostato manualmente dall'utente. Se impostato manualmente tramite MarkAsAway, questo stato persiste indipendentemente dall'attività utente.
DO_NOT_DISTURB L'utente si trova nello stato Non disturbare, impostato manualmente.

CalendarEventLinkData

Dati per i link agli eventi nel calendario.

Campi
calendar_id

string

L'identificatore del calendario collegato.
event_id

string

L'identificatore dell'evento nel calendario collegato.

CardWithId

Una scheda in un messaggio chat di Google Chat.

Le app di Chat possono creare schede con l'autenticazione dell'app. Nell'ambito del Programma Anteprima per gli sviluppatori, se la tua app di Chat esegue l'autenticazione come utente, può creare messaggi con schede. Se la tua app di Chat non fa parte del Programma Anteprima per gli sviluppatori, non può creare schede con l'autenticazione utente.

Per scoprire come creare un messaggio contenente schede, consulta Invia un messaggio.

Progetta e visualizza l'anteprima delle schede con Card Builder.

Apri il generatore di schede

Campi
card_id

string

Obbligatorio se il messaggio contiene più schede. Un identificatore univoco per una scheda in un messaggio.
card

Card

Una scheda. La dimensione massima è 32 kB.
owner_user

User

Solo output. L'app proprietaria della tessera.

ChatSpaceLinkData

Dati per i link degli spazi di Chat.

Campi
space

string

Lo spazio della risorsa dello spazio di Chat collegato.

Formato: spaces/{space}
thread

string

Il thread della risorsa dello spazio di Chat collegato.

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

string

Il messaggio della risorsa dello spazio di Chat collegato.

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

Citazione

Le citazioni sono riferimenti in linea che possono fornire agli utenti informazioni più dettagliate sul riferimento in linea. Le citazioni in linea corrispondenti devono essere presenti nel testo del messaggio in un formato di markup di <chat-citation data-id="{id}">{text}</chat-citation>. Le citazioni sono supportate solo quando il valore markup_syntax del messaggio è impostato su MARKDOWN.

Le citazioni non referenziate in Elements.citations (quelle senza un tag <chat-citation> corrispondente nel testo del messaggio) vengono ignorate e non causano il rifiuto del messaggio.

Campi
id

string

Obbligatorio. ID definito dall'app. Deve contenere solo lettere e numeri ASCII e meno di 63 caratteri.
cited_sources[]

CitedSource

Facoltativo. Un elenco di fonti pertinenti alla citazione. Le fonti vengono visualizzate nella scheda riepilogativa della citazione.

CitedSource

Un riferimento a una fonte di informazioni.

Campi
title

string

Obbligatorio. Il titolo in testo non crittografato di CitedSource. Questo campo non supporta la formattazione.
uri

string

Obbligatorio. L'URI che punta alla risorsa a cui fa riferimento questo CitedSource.
snippet

Snippet

Facoltativo. Snippet contenente informazioni direttamente dalla fonte.
footer

Footer

Facoltativo. Informazioni aggiuntive da mostrare insieme allo snippet sotto forma di piè di pagina.

Un piè di pagina per una fonte, utilizzato per l'attribuzione.

Campi
text

string

Facoltativo. Il testo da visualizzare nel piè di pagina.

Snippet

Un oggetto snippet che rappresenta un estratto di un corpus più ampio.

Campi
text

string

Facoltativo. Un breve estratto di testo non crittografato direttamente dal corpus che potrebbe essere visualizzato in Chat. Non supporta il formato Markdown.
image_preview

ElementsImage

Facoltativo. Anteprima dell'immagine dello snippet fornito come input durante la creazione della citazione.

CompleteImportSpaceRequest

Messaggio di richiesta per completare il processo di importazione per 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 ha campi.

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

Carta

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 divisore di riga.
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 di fattura, un'azione tipica potrebbe essere: eliminare la fattura, inviarla via email o aprirla nel browser.

Non supportato dalle app Google Chat.

Campi
action_label

string

L'etichetta utilizzata per la visualizzazione nella voce del menu Azioni.
on_click

OnClick

L'azione onclick 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, ciascuno occupa 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 ridotta, quindi al momento non sono necessarie proprietà di layout (ad esempio, float).

Campi
header

string

L'intestazione della sezione. Il testo formattato è supportato. Per saperne di più sulla formattazione del testo, consulta 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.

CreateCustomEmojiRequest

Una richiesta per creare un'emoji personalizzata.

Campi
custom_emoji

CustomEmoji

Obbligatorio. L'emoji personalizzata da creare.

CreateMembershipRequest

Messaggio di richiesta per la creazione di un abbonamento.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio per cui creare l'iscrizione.

Formato: spaces/{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 alla risorsa e sovrascriverà qualsiasi nome specificato.

Quando un'app di Chat crea una relazione di iscrizione per un utente umano, deve utilizzare determinati ambiti di autorizzazione e impostare valori specifici per determinati campi:

  • Quando esegui l'autenticazione come utente, è richiesto l'ambito di autorizzazione chat.memberships.

  • Quando esegui l'autenticazione come app, è richiesto l'ambito di autorizzazione chat.app.memberships.

  • Imposta user.type su HUMAN e imposta 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 dall'API People o il id dell'utente nell'API Directory. Ad esempio, se l'ID profilo della persona dell'API People per user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com o users/123456789.

Per invitare utenti esterni all'organizzazione Workspace proprietaria dello spazio, è necessaria l'autenticazione utente.

Quando un'app di Chat crea una relazione di iscrizione per se stessa, deve eseguire l'autenticazione come utente e utilizzare l'ambito chat.memberships.app, impostare user.type su BOT e impostare user.name su users/app.
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

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

CreateMessageNotificationOptions

Opzioni per il comportamento delle notifiche quando viene pubblicato il messaggio.

Campi
notification_type

NotificationType

Il tipo di notifica per il messaggio.

NotificationType

Le opzioni dei tipi di notifica per il messaggio.

Enum
NOTIFICATION_TYPE_NONE Comportamento predefinito. Il comportamento delle notifiche è simile a quello che si verifica quando l'utente umano invia il messaggio utilizzando la UI di Chat: non viene inviata alcuna notifica al mittente umano.
NOTIFICATION_TYPE_FORCE_NOTIFY

Forza la notifica ai destinatari. In questo modo, vengono ignorate le impostazioni di notifica dello spazio degli utenti e le impostazioni Non disturbare di Chat. Questa opzione non ignora le impostazioni Non disturbare a livello di dispositivo.

Richiede l'autenticazione dell'app.
NOTIFICATION_TYPE_SILENT

Non inviare notifiche ai destinatari e non contrassegnare il messaggio come da leggere. Questo comportamento è simile a quello dell'utente che disattiva l'audio della conversazione o attiva la modalità Non disturbare di Chat.

Richiede l'autenticazione dell'app.

CreateMessagePinRequest

Messaggio di richiesta per la creazione di un messaggio bloccato.

Campi
parent

string

Obbligatorio. Lo spazio principale in cui creare il messaggio bloccato. Formato: spaces/{space}
message_pin

MessagePin

Obbligatorio. Il MessagePin da creare.

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. Ritirato: utilizza invece thread.thread_key. ID del thread. Supporta fino a 4000 caratteri. Per avviare o aggiungere un thread, crea un messaggio e specifica un threadKey o il thread.name. Per un esempio di utilizzo, consulta Avviare o rispondere a un thread di messaggi.
request_id

string

Facoltativo. Un ID univoco per questa richiesta. Si consiglia un UUID casuale. Se specifichi un ID richiesta, la richiesta diventa idempotente, il che garantisce che più richieste identiche con lo stesso ID richiesta generino la creazione di un solo messaggio. Le richieste successive con lo stesso ID richiesta restituiscono il messaggio esistente e non lo aggiornano, anche se i dettagli richiesti differiscono dallo stato attuale.

Per utilizzare questo campo in modo efficace:

  • Assicurati che le richieste successive siano identiche e utilizzino le stesse credenziali di autenticazione della richiesta originale.
  • Se è già stato creato un messaggio con l'ID richiesta fornito, la richiesta restituisce quel messaggio. Tieni presente che il messaggio restituito potrebbe non essere completamente compilato; l'API restituisce il messaggio nella richiesta con i nomi delle risorse assegnati dal sistema compilati. Per recuperare i metadati più recenti del messaggio, chiama GetMessage.
  • Il riutilizzo di un ID richiesta esistente con un utente autenticato diverso genera un errore.
message_reply_option

MessageReplyOption

Facoltativo. Specifica se un messaggio avvia un thread o risponde a un thread. Funzionalità supportata solo negli spazi con un nome.

Quando rispondi alle interazioni degli utenti, questo campo viene ignorato. Per le interazioni all'interno di un thread, la risposta viene creata nello stesso thread. In caso contrario, la risposta viene creata come un nuovo thread.
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.
  • È 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.
create_message_notification_options

CreateMessageNotificationOptions

Facoltativo. Controlla il comportamento delle notifiche quando il messaggio viene pubblicato. Per scoprire di più, consulta Forza le notifiche o invia messaggi silenziosi.

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, vengono ignorati tutti i thread ID o thread_key inclusi.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crea il messaggio come risposta al thread specificato da thread ID o thread_key. In caso contrario, 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 va a buon fine, 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.

CreateSectionRequest

Messaggio di richiesta per la creazione di una sezione.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre in cui viene creata la sezione.

Formato: users/{user}
section

Section

Obbligatorio. La sezione da creare.

CreateSpaceRequest

Una richiesta di creazione di uno spazio con nome senza membri.

Campi
space

Space

Obbligatorio. I campi displayName e spaceType devono essere compilati. Sono supportati solo SpaceType.SPACE e SpaceType.GROUP_CHAT. SpaceType.GROUP_CHAT può essere utilizzato solo se importMode è impostato su true.

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

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

string

Facoltativo. Un ID univoco per questa richiesta. Si consiglia un UUID casuale. Se specifichi un ID richiesta, la richiesta diventa idempotente, il che garantisce che più richieste identiche con lo stesso ID richiesta comportino la creazione di un solo spazio. Le richieste successive con lo stesso ID richiesta restituiscono lo spazio esistente e non lo aggiornano, anche se i dettagli richiesti differiscono dallo stato attuale.

Per utilizzare questo campo in modo efficace:

  • Assicurati che le richieste successive siano identiche e utilizzino le stesse credenziali di autenticazione della richiesta originale.
  • Se è già stato creato uno spazio con l'ID richiesta fornito, la richiesta restituisce quello spazio. Tieni presente che lo spazio restituito potrebbe non essere completamente compilato. L'API restituisce lo spazio nella richiesta con il nome della risorsa assegnato dal sistema. Per recuperare i metadati più recenti dello spazio, chiama GetSpace.
  • Il riutilizzo di un ID richiesta esistente con un utente autenticato diverso genera un errore.

CustomEmoji

Rappresenta un'emoji personalizzata.

Campi
name

string

Identificatore. Il nome della risorsa dell'emoji personalizzata, assegnato dal server.

Formato: customEmojis/{customEmoji}
uid

string

Solo output. Chiave univoca per la risorsa emoji personalizzata.
emoji_name

string

Facoltativo. Immutabile. Nome fornito dall'utente per l'emoji personalizzata, che è univoco all'interno dell'organizzazione.

Obbligatorio quando viene creata l'emoji personalizzata, altrimenti solo output.

I nomi delle emoji devono iniziare e terminare con i due punti, devono essere in minuscolo e possono contenere solo caratteri alfanumerici, trattini e trattini bassi. I trattini e i trattini bassi dovrebbero essere utilizzati per separare le parole e non possono essere digitati uno di seguito all'altro.

Esempio: :valid-emoji-name:
temporary_image_uri

string

Solo output. Un URL immagine temporaneo per l'emoji personalizzata, valido per almeno 10 minuti. Tieni presente che questo campo non viene compilato nella risposta quando viene creata l'emoji personalizzata.
payload

CustomEmojiPayload

Facoltativo. Solo input. Dati di payload. Obbligatorio quando viene creata l'emoji personalizzata.

CustomEmojiPayload

Dati del payload per l'emoji personalizzata.

Campi
file_content

bytes

Obbligatorio. Solo input. L'immagine utilizzata per l'emoji personalizzata.

Il payload deve essere inferiore a 256 kB e l'immagine deve essere quadrata e avere una dimensione compresa tra 64 e 500 pixel. Le limitazioni sono soggette a modifiche.
filename

string

Obbligatorio. Solo input. Il nome del file immagine.

Estensioni file supportate: .png, .jpg, .gif.

CustomEmojiMetadata

Metadati di annotazione per le emoji personalizzate.

Campi
custom_emoji

CustomEmoji

L'emoji personalizzata.

CustomStatus

Rappresenta lo stato personalizzato di un utente in Google Chat. Questo include un breve messaggio con un'emoji facoltativa che un utente imposta per fornire maggiori informazioni sulla sua disponibilità.

Campi
text

string

Obbligatorio. Il testo dello stato personalizzato. Si tratta di una stringa con una lunghezza massima di 64 caratteri.
emoji

Emoji

Obbligatorio. L'emoji dello stato personalizzato. Sono supportate solo le emoji Unicode; le emoji personalizzate non sono supportate.
Campo unione expiration. La data e l'ora di scadenza dello stato personalizzato. Può essere specificato come timestamp assoluto o come durata (TTL). expiration può essere solo uno dei seguenti tipi:
expire_time

Timestamp

Il timestamp di scadenza dello stato personalizzato.
ttl

Duration

Solo input. La durata della durata (TTL) dopo la quale lo stato personalizzato scade.

DeleteCustomEmojiRequest

Richiesta di eliminazione di un'emoji personalizzata.

Campi
name

string

Obbligatorio. Nome della risorsa dell'emoji personalizzata da eliminare.

Formato: customEmojis/{customEmoji}

Puoi utilizzare il nome dell'emoji come alias per {customEmoji}. Ad esempio, customEmojis/:example-emoji:, dove :example-emoji: è il nome di un'emoji personalizzata.

DeleteMembershipRequest

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

Campi
name

string

Obbligatorio. Nome della risorsa dell'abbonamento da eliminare. Le app di Chat possono eliminare le iscrizioni degli utenti umani o le proprie. Le app di Chat non possono eliminare le iscrizioni di altre app.

Quando elimini un'iscrizione umana, è necessario l'ambito chat.memberships con l'autenticazione utente o l'ambito chat.memberships.app con l'autenticazione dell'app e il formato spaces/{space}/members/{member}. Puoi utilizzare l'indirizzo 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'iscrizione a un'app, è necessario 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

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

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

DeleteMessagePinRequest

Messaggio di richiesta per l'eliminazione di un messaggio bloccato.

Campi
name

string

Obbligatorio. Il nome della risorsa del messaggio bloccato da rimuovere. Formato: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

Richiedi l'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 messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
force

bool

Facoltativo. 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 va a buon fine.

Si applica solo quando esegui l'autenticazione come utente. Non ha alcun effetto quando l'autenticazione viene eseguita 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}

DeleteSectionRequest

Messaggio di richiesta per l'eliminazione di una sezione.

Campi
name

string

Obbligatorio. Il nome della sezione da eliminare.

Formato: users/{user}/sections/{section}

DeleteSpaceRequest

Richiesta di eliminazione di uno spazio.

Campi
name

string

Obbligatorio. Nome della risorsa dello spazio da eliminare.

Formato: spaces/{space}
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

DeletionMetadata

Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato delete_time.

Campi
deletion_type

DeletionType

Indica chi ha eliminato il messaggio.

DeletionType

Chi ha eliminato il messaggio e come è stato eliminato. In futuro potrebbero essere aggiunti altri valori. Per informazioni dettagliate su quando è possibile eliminare i messaggi, vedi Modifica o elimina un messaggio in Google Chat.

Enum
DELETION_TYPE_UNSPECIFIED Questo valore non è utilizzato.
CREATOR L'utente ha eliminato il proprio messaggio.
SPACE_OWNER Un proprietario o un gestore ha eliminato il messaggio.
ADMIN Un amministratore di Google Workspace ha eliminato il messaggio. Gli amministratori possono eliminare qualsiasi messaggio nello spazio, inclusi i messaggi inviati da qualsiasi membro dello spazio o app di Chat.
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'autore (utilizzando l'autenticazione utente).
SPACE_OWNER_VIA_APP Un'app di Chat ha eliminato il messaggio per conto di un gestore dello spazio (utilizzando l'autenticazione utente).
SPACE_MEMBER Un membro dello spazio ha eliminato il messaggio. Gli utenti possono eliminare i messaggi inviati dalle app.

Dialog

Wrapper attorno al corpo della scheda della finestra di dialogo.

Campi
body

Card

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

DialogAction

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

Campi
action_status

ActionStatus

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

Dialog

Solo input. Finestra di dialogo per la richiesta.

DoNotDisturbMetadata

Metadati associati allo stato di disponibilità DO_NOT_DISTURB, che specificano quando è prevista la scadenza dello stato.

Campi
expiration_time

Timestamp

Solo output. Timestamp fino al quale l'utente deve essere contrassegnato come DO_NOT_DISTURB. Può essere di massimo un anno nel futuro.

DriveDataRef

Un riferimento ai dati di un allegato di Drive.

Campi
drive_file_id

string

L'ID del file di Drive. Utilizzalo 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 Google Drive collegata.

Elementi

Gli elementi sono componenti aggiuntivi che possono essere associati o meno al testo del messaggio fornito durante la creazione del messaggio.

Campi
cited_sources[]

CitedSource

Un elenco di fonti da visualizzare sotto il messaggio come link nel piè di pagina. Questi non sono indicati in linea. Per i riferimenti in linea, utilizza citations.
citations[]

Citation

Un elenco di citazioni in linea a cui si fa riferimento nel testo del messaggio (tramite i tag <chat-citation>) che vengono visualizzate come schede riepilogative interattive.

ElementsImage

Un oggetto che incapsula diversi modi di rappresentare un'immagine. Rappresentazioni attualmente supportate: - Un'immagine recuperata da un URI. In futuro potrebbero essere supportate altre rappresentazioni.

Campi
Campo unione image. Obbligatorio. Una delle rappresentazioni di immagini supportate. image può essere solo uno dei seguenti tipi:
image_uri

string

Obbligatorio. Un URI accessibile pubblicamente per un'immagine.

Emoji

Un'emoji utilizzata come reazione a un messaggio.

Campi
Campo unione content. Obbligatorio. Il contenuto dell'emoji. content può essere solo uno dei seguenti tipi:
unicode

string

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

CustomEmoji

Un'emoji personalizzata.

EmojiReactionSummary

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

Campi
emoji

Emoji

Solo output. Emoji associata alle reazioni.
reaction_count

int32

Solo output. Il numero totale di reazioni che utilizzano l'emoji associata.

FindDirectMessageRequest

Una richiesta per ottenere lo spazio dei messaggi diretti in base alla risorsa utente.

Campi
name

string

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

Formato: users/{user}, dove {user} è il id della persona dall'API People o il id dell'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. Quando l'autenticazione viene eseguita come utente, puoi utilizzare l'indirizzo email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

FindGroupChatsRequest

Una richiesta per ottenere spazi di chat di gruppo in base alle risorse utente.

Campi
users[]

string

Facoltativo. Nomi delle risorse di tutti gli utenti umani nella chat di gruppo con l'utente che effettua la chiamata. Le app di Chat non possono essere incluse nella richiesta.

Il numero massimo di utenti che è possibile specificare in una singola richiesta è 49.

Formato: users/{user}, dove {user} è il id della persona dall'API People o il id dell'utente nell'API Directory. Ad esempio, per trovare tutte le chat di gruppo con l'utente chiamante e altri due utenti, con gli ID profilo dell'API People 123456789 e 987654321, puoi utilizzare users/123456789 e users/987654321. Puoi anche utilizzare l'indirizzo email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.
page_size

int32

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

Se non viene specificato, vengono restituiti al massimo 10 spazi.

Il valore massimo è 30. Se utilizzi un valore superiore a 30, questo viene modificato automaticamente in 30.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una chiamata precedente per trovare le chat di gruppo. Specifica questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token. Il passaggio di valori diversi potrebbe portare a risultati imprevisti.
space_view

SpaceView

Tipo di visualizzazione dello spazio richiesto. Se non viene impostato, il valore predefinito è SPACE_VIEW_RESOURCE_NAME_ONLY. Le richieste che specificano SPACE_VIEW_EXPANDED devono includere ambiti che consentono la lettura dei dati dello spazio, ad esempio https://www.googleapis.com/auth/chat.spaces o https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Una risposta contenente spazi di chat di gruppo con esattamente l'utente chiamante e gli utenti richiesti.

Campi
spaces[]

Space

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

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

ForwardedMetadata

Metadati relativi allo spazio di origine da cui è stato inoltrato un messaggio.

Campi
space

string

Solo output. Il nome della risorsa dello spazio di origine. Formato: spaces/{space}
space_display_name

string

Solo output. Il nome visualizzato dello spazio o del messaggio diretto di origine al momento dell'inoltro. Per SPACE, questo è il nome dello spazio. Per DIRECT_MESSAGE, questo è il nome dell'altro partecipante (ad es. "Utente A"). Per GROUP_CHAT, si tratta di un nome generato in base ai nomi dei membri, limitato a 5, incluso il creator (ad es. "Utente A, Utente B").

GetAttachmentRequest

Richiedi di ricevere un allegato.

Campi
name

string

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

GetAvailabilityRequest

Messaggio di richiesta per il metodo GetAvailability.

Campi
name

string

Obbligatorio. Il nome della risorsa della disponibilità da recuperare.

Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me

GetCustomEmojiRequest

Una richiesta per restituire una singola emoji personalizzata.

Campi
name

string

Obbligatorio. Nome risorsa dell'emoji personalizzata.

Formato: customEmojis/{customEmoji}

Puoi utilizzare il nome dell'emoji come alias per {customEmoji}. Ad esempio, customEmojis/:example-emoji:, dove :example-emoji: è il nome di un'emoji personalizzata.

GetMembershipRequest

Richiedi di diventare membro di uno spazio.

Campi
name

string

Obbligatorio. Nome della risorsa dell'abbonamento da recuperare.

Per ottenere l'iscrizione dell'app utilizzando l'autenticazione utente, puoi utilizzare facoltativamente spaces/{space}/members/app.

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

Puoi utilizzare l'indirizzo 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

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

Il recupero delle iscrizioni delle app in uno spazio non è supportato quando 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 messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
markup_syntax

MarkupSyntax

Facoltativo. Specifica la sintassi di output desiderata per il campo formatted_text del messaggio chat.

GetSpaceEventRequest

Messaggio di richiesta per ricevere un evento di uno spazio.

Campi
name

string

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

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

GetSpaceNotificationSettingRequest

Messaggio di richiesta per ottenere l'impostazione di notifica dello spazio. Supporta solo il recupero dell'impostazione di notifica per l'utente che effettua la chiamata.

Campi
name

string

Obbligatorio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting, OR
  • users/user@example.com/spaces/{space}/spaceNotificationSetting, OR
  • users/123456789/spaces/{space}/spaceNotificationSetting. Nota: nel percorso sono consentiti solo l'ID utente o l'indirizzo email del chiamante.

GetSpaceReadStateRequest

Messaggio di richiesta per l'API GetSpaceReadState.

Campi
name

string

Obbligatorio. Nome della 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.

  • Il suo indirizzo email Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

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

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

GetSpaceRequest

Una richiesta per restituire un singolo spazio.

Campi
name

string

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

Formato: spaces/{space}
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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.

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

  • Il suo 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 i messaggi e i thread di conversazione vengono conservati 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 per quanto tempo vengono conservati i messaggi e i thread.

ListCustomEmojisRequest

Una richiesta per restituire un elenco di emoji personalizzate.

Campi
page_size

int32

Facoltativo. Il numero massimo di emoji personalizzate restituite. Il servizio può restituire un numero di emoji personalizzate inferiore a questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200; i valori 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 elenco di emoji personalizzate. Fornisci questo valore per recuperare la pagina successiva.

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

string

Facoltativo. Un filtro di query.

Supporta l'applicazione di filtri per autore.

Per filtrare in base al creator, devi specificare un valore valido. Al momento sono accettati solo creator("users/me") e NOT creator("users/me") per filtrare le emoji personalizzate in base al fatto che siano state create o meno dall'utente che effettua la chiamata.

Ad esempio, la seguente query restituisce le emoji personalizzate create dal chiamante:

creator("users/me")

Le query non valide vengono rifiutate con un errore INVALID_ARGUMENT.

ListCustomEmojisResponse

Una risposta per elencare le emoji personalizzate.

Campi
custom_emojis[]

CustomEmoji

Elenco non ordinato. Elenco di emoji personalizzate.
next_page_token

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

ListMembershipsRequest

Messaggio di richiesta per l'elenco delle iscrizioni.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio per cui recuperare un elenco di iscrizioni.

Formato: spaces/{space}
page_size

int32

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

Se non viene specificato, vengono restituite al massimo 100 iscrizioni.

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

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una chiamata precedente per elencare gli abbonamenti. Specifica questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di valori diversi agli altri parametri potrebbe 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 membro.

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

Per filtrare in base al tipo, imposta member.type su HUMAN o BOT. Puoi anche filtrare per member.type utilizzando l'operatore !=.

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

È obbligatorio specificare member.type = "HUMAN" o member.type != "BOT" quando use_admin_access è impostato su true. Altri filtri per tipo di iscrizione 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. Se true, restituisce anche gli abbonamenti associati a un Google Group, oltre ad altri tipi di abbonamenti. Se viene impostato un filter, le iscrizioni Google Group che non corrispondono ai criteri di filtro non vengono restituite.
show_invited

bool

Facoltativo. Se true, restituisce anche le iscrizioni associate ai membri invited, oltre ad altri tipi di iscrizioni. Se è impostato un filtro, le iscrizioni a invited che non corrispondono ai criteri di filtro non vengono restituite.

Al momento richiede l'autenticazione dell'utente.
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

L'elenco delle iscrizioni alle app in uno spazio non è supportato quando si utilizza l'accesso amministrativo.

ListMembershipsResponse

Risposta per elencare le iscrizioni allo spazio.

Campi
memberships[]

Membership

Elenco non ordinato. Elenco delle iscrizioni nella pagina richiesta (o nella prima pagina).
next_page_token

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

ListMessagePinsRequest

Messaggio di richiesta per elencare i messaggi bloccati.

Campi
parent

string

Obbligatorio. Lo spazio principale proprietario della raccolta di elementi bloccati. Formato: spaces/{space}
page_size

int32

Facoltativo. Il numero massimo di messaggi fissati restituiti. Il servizio potrebbe restituire un numero di messaggi inferiore a questo valore. Il valore massimo è 100. Se utilizzi un valore superiore a 100, questo viene modificato automaticamente in 100. Se non specificato, verranno restituiti al massimo 100 messaggi bloccati. I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina ricevuto da una precedente chiamata di elenco dei messaggi fissati. Specifica questo parametro per recuperare la pagina successiva.

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

ListMessagePinsResponse

Messaggio di risposta per l'elenco dei messaggi bloccati.

Campi
message_pins[]

MessagePin

I messaggi bloccati dello spazio specificato.
next_page_token

string

Puoi inviare un token come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

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

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

Se non è specificato, vengono restituiti al massimo 25 elementi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo 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 di elenco dei messaggi. Specifica questo parametro per recuperare la pagina successiva.

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

string

Facoltativo. 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 tra 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 thread.name, formattato come spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare sia per thread sia per 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. Come viene ordinato l'elenco dei messaggi. Specifica un valore per ordinare in base a un'operazione di ordinamento. I valori validi per l'operazione di ordinamento sono i seguenti:

  • ASC per l'ordine crescente.

  • DESC per l'ordine decrescente.

L'ordinamento predefinito è create_time ASC.
show_deleted

bool

Facoltativo. Indica se includere i messaggi eliminati. I messaggi eliminati includono l'ora dell'eliminazione e i metadati relativi all'eliminazione, ma i contenuti dei messaggi non sono disponibili.
markup_syntax

MarkupSyntax

Facoltativo. Specifica la sintassi di output desiderata per il campo formatted_text del messaggio chat.

ListMessagesResponse

Messaggio di risposta per l'elenco dei messaggi.

Campi
messages[]

Message

Elenco dei messaggi.
next_page_token

string

Puoi inviare un token come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

ListReactionsRequest

Elenca le reazioni a un messaggio.

Campi
parent

string

Obbligatorio. Il messaggio che ha generato una reazione da parte degli utenti.

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

int32

Facoltativo. Il numero massimo di reazioni restituite. Il servizio può restituire un numero di reazioni inferiore a questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200; i valori 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 elenco delle reazioni. Fornisci questo valore per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token di 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 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 in base a 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 con le 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 con un errore INVALID_ARGUMENT.

ListReactionsResponse

Risposta a una richiesta di elenco delle reazioni.

Campi
reactions[]

Reaction

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

string

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

ListSectionItemsRequest

Messaggio di richiesta per elencare gli elementi della sezione.

Campi
parent

string

Obbligatorio. Il livello principale, ovvero il nome della risorsa della sezione proprietaria di questa raccolta di elementi della sezione. Supporta solo l'elenco degli elementi della sezione per l'utente che effettua la chiamata.

Quando filtri per spazio, utilizza il carattere jolly - per eseguire ricerche in tutte le sezioni. Ad esempio, users/{user}/sections/-.

Formato: users/{user}/sections/{section}
page_size

int32

Facoltativo. Il numero massimo di elementi della sezione da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non è specificato, verranno restituiti al massimo 10 elementi della sezione.

Il valore massimo è 100. Se utilizzi un valore superiore a 100, questo viene modificato automaticamente in 100.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata di elenco degli elementi della sezione. Fornisci questo valore per recuperare la pagina successiva.

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

string

Facoltativo. Un filtro di query.

Al momento è supportato solo il filtro per spazio.

Ad esempio, space = spaces/{space}.

Le query non valide vengono rifiutate con un errore INVALID_ARGUMENT.

ListSectionItemsResponse

Messaggio di risposta per l'elenco degli elementi della sezione.

Campi
section_items[]

SectionItem

Gli elementi della sezione specificata.
next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListSectionsRequest

Messaggio di richiesta per l'elenco delle sezioni.

Campi
parent

string

Obbligatorio. L'elemento principale, ovvero il nome della risorsa utente proprietaria di questa raccolta di sezioni. Supporta solo la visualizzazione delle sezioni per l'utente che effettua la chiamata. Per fare riferimento all'utente chiamante, imposta una delle seguenti opzioni:

  • L'alias me. Ad esempio, users/me.

  • Il suo indirizzo email Workspace. Ad esempio, users/user@example.com.

  • Il suo ID utente. Ad esempio, users/123456789.

Formato: users/{user}
page_size

int32

Facoltativo. Il numero massimo di sezioni da restituire. Il servizio potrebbe restituire un numero inferiore di elementi.

Se non viene specificato, verranno restituite al massimo 10 sezioni.

Il valore massimo è 100. Se utilizzi un valore superiore a 100, questo viene modificato automaticamente in 100.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata di elenco delle sezioni. Fornisci questo valore per recuperare la pagina successiva.

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

ListSectionsResponse

Messaggio di risposta per le sezioni della scheda.

Campi
sections[]

Section

Le sezioni dell'utente specificato.
next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListSpaceEventsRequest

Messaggio di richiesta per elencare gli 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 numero inferiore a questo valore.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata di elenco degli eventi dello spazio. Fornisci questo valore 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 di pagina. Il passaggio di valori diversi agli altri parametri potrebbe 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 i tipi di eventi in gruppo 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 relativi alle nuove reazioni in batch (google.workspace.chat.reaction.v1.batchCreated). Per un elenco dei tipi di eventi supportati, consulta la documentazione di riferimento di SpaceEvents.

Facoltativamente, puoi anche filtrare per ora di inizio (start_time) e 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 specificato, elenca gli eventi dello spazio degli ultimi 28 giorni.
  • end_time: Timestamp inclusivo fino al quale sono elencati gli eventi spaziali. Se non specificato, elenca gli eventi fino al momento della richiesta.

Per specificare un'ora di inizio o di fine, utilizza l'operatore di uguaglianza = e il formato RFC-3339. Per filtrare in base a start_time e 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 per l'elenco degli eventi dello spazio.

Campi
space_events[]

SpaceEvent

I risultati vengono restituiti in ordine cronologico (prima l'evento meno recente). Nota: il campo permissionSettings non viene restituito nell'oggetto Space per le richieste di elenco.
next_page_token

string

Token di continuazione utilizzato per recuperare altri 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 numero inferiore a questo valore.

Se non viene specificato, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo 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 gli spazi. Specifica questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di un valore diverso potrebbe 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, ad esempio SPACE o GROUP_CHAT (space_type non può essere SPACE_TYPE_UNSPECIFIED). Per eseguire query su più tipi di spazio, 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 a una richiesta di elenco degli spazi.

Campi
spaces[]

Space

Elenco degli spazi nella pagina richiesta (o nella prima pagina). Nota: il campo permissionSettings non viene restituito nell'oggetto Space per le richieste di elenco.
next_page_token

string

Puoi inviare un token come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

MarkAsActiveRequest

Messaggio di richiesta per il metodo MarkAsActive.

Campi
name

string

Obbligatorio. Il nome della risorsa della disponibilità da contrassegnare come attiva. Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me
Campo unione expiration. La scadenza dello stato di disponibilità ACTIVE. L'utente verrà contrassegnato come Fuori sede dopo la scadenza. Se non viene fornita una scadenza, lo stato ATTIVO scadrà 30 minuti dopo l'ora corrente. expiration può essere solo uno dei seguenti tipi:
expire_time

Timestamp

Il timestamp assoluto della scadenza dello stato ACTIVE.
ttl

Duration

La durata dal momento attuale fino alla scadenza dello stato ATTIVO. L'utilizzo di un TTL breve può reimpostare efficacemente lo stato dell'utente in modo che si basi sull'attività dopo questa breve durata.

MarkAsAwayRequest

Messaggio di richiesta per il metodo MarkAsAway.

Campi
name

string

Obbligatorio. Il nome della risorsa della disponibilità da contrassegnare come assente. Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me

MarkAsDoNotDisturbRequest

Messaggio di richiesta per il metodo MarkAsDoNotDisturb.

Campi
name

string

Obbligatorio. Il nome della risorsa della disponibilità da contrassegnare come Non disturbare. Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me
Campo unione expiration. Obbligatorio. La scadenza dello stato di disponibilità Non disturbare. L'utente verrà contrassegnato come Assente dopo la scadenza. Può essere al massimo un anno dall'ora corrente. expiration può essere solo uno dei seguenti tipi:
expire_time

Timestamp

Il timestamp assoluto della scadenza dello stato Non disturbare.
ttl

Duration

La durata dal momento corrente fino alla scadenza dello stato Non disturbare.

MarkupSyntax

Specifica la sintassi di markup utilizzata per formattare il testo del messaggio chat. Si applica al campo text della risorsa Message.

Enum
MARKUP_SYNTAX_UNSPECIFIED Rappresenta il valore non specificato.
MARKUP_SYNTAX_CHAT Utilizza la sintassi di markup di Google Chat. Per saperne di più, visita la pagina https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Utilizza la sintassi Markdown. Questa sintassi si basa sulla specifica CommonMark, con estensioni aggiuntive. Per saperne di più, visita la pagina https://developers.google.com/workspace/chat/format-messages#format-texts.

MatchedUrl

Un URL corrispondente in un messaggio chat. Le app di Chat possono visualizzare l'anteprima degli URL corrispondenti. Per saperne di più, vedi Visualizza l'anteprima dei link.

Campi
url

string

Solo output. L'URL corrispondente.

MeetSpaceLinkData

Dati per i link degli spazi di Meet.

Campi
meeting_code

string

Codice riunione dello spazio di Meet collegato.
type

Type

Indica il tipo di spazio di Meet.
huddle_status

HuddleStatus

Facoltativo. Solo output. Se la riunione è un Huddle, indica lo stato dell'Huddle. In caso contrario, questo valore non è impostato.

HuddleStatus

Lo stato della riunione

Enum
HUDDLE_STATUS_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
STARTED La riunione rapida è iniziata.
ENDED La riunione rapida è terminata. In questo caso, l'URI e gli identificatori dello spazio di Meet non saranno più validi.
MISSED L'huddle è stato perso. In questo caso, l'URI e gli identificatori dello spazio di Meet non saranno più validi.

Tipo

Il tipo di spazio di Meet.

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
MEETING Lo spazio di Meet è una riunione.
HUDDLE Lo spazio di Meet è una riunione rapida.

Abbonamento

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

Campi
name

string

Identificatore. Nome risorsa dell'abbonamento, 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'iscrizione, ad esempio quando un membro si è unito o è stato invitato a unirsi a uno spazio. Questo campo è di solo output, tranne quando viene utilizzato per importare le iscrizioni storiche negli spazi in modalità di importazione.
delete_time

Timestamp

Facoltativo. Immutabile. L'ora di eliminazione dell'iscrizione, ad esempio quando un membro ha lasciato o è stato rimosso da uno spazio. Questo campo è di solo output, tranne quando viene utilizzato per importare le iscrizioni storiche negli spazi in modalità di importazione.
affiliation

Affiliation

Solo output. La relazione di un utente con l'organizzazione Workspace proprietaria dello spazio. Negli spazi di proprietà di account consumer, l'affiliazione di tutti i membri è EXTERNAL.
Campo unione memberType. Membro associato a questo abbonamento. In futuro potrebbero essere supportati altri tipi di membri. memberType può essere solo uno dei seguenti tipi:
member

User

Facoltativo. L'utente o l'app Google Chat a cui corrisponde l'iscrizione. Se l'app di Chat esegue l'autenticazione come utente, l'output compila solo i campi user name e type per gli utenti interni ed esterni, a meno che non siano membri dello spazio o abbiano un'affinità precedente, ad esempio una conversazione con messaggio diretto (DM), con l'utente chiamante.
group_member

Group

Facoltativo. Il gruppo Google a cui corrisponde l'iscrizione.

La lettura o la modifica delle iscrizioni a Google Gruppi richiede l'autenticazione dell'utente.

Affiliazione

Rappresenta l'affiliazione di un utente all'organizzazione Google Workspace proprietaria dello spazio. In futuro potrebbero essere aggiunti altri valori a questo enum.

Enum
AFFILIATION_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
INTERNAL Un account gestito dalla stessa organizzazione Google Workspace proprietaria dello spazio.
EXTERNAL Un account esterno all'organizzazione Google Workspace proprietaria dello spazio (ad esempio un account consumer o un account gestito da un'altra organizzazione Workspace).
MANAGED_EXTERNAL Un account gestito dall'organizzazione Workspace proprietaria dello spazio, ma di cui è stato eseguito il provisioning per un utente esterno all'organizzazione (ad esempio un utente ospite). Per scoprire di più sugli ospiti, visita la pagina https://support.google.com/chat/answer/16997417.

MembershipRole

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

Enum
MEMBERSHIP_ROLE_UNSPECIFIED Valore predefinito. Per users: non è un membro dello spazio, ma può essere invitato. Per Google Groups: viene sempre assegnato questo ruolo (in futuro potrebbero essere utilizzati altri valori enum).
ROLE_MEMBER

Un membro dello spazio. Nella UI di Chat, questo ruolo è chiamato Membro.

L'utente dispone di autorizzazioni di base, ad esempio l'invio di messaggi allo spazio. I gestori e i proprietari possono concedere ai membri autorizzazioni aggiuntive in uno spazio, tra cui:

  • Aggiungere o rimuovere membri.
  • Modificare i dettagli dello spazio.
  • Attivare o disattivare la cronologia.
  • Menziona tutti i partecipanti allo spazio con @all.
  • Gestire le app di Chat e i webhook installati nello spazio.

Nei messaggi diretti e nelle conversazioni di gruppo senza nome, tutti hanno questo ruolo.
ROLE_MANAGER

Un proprietario dello spazio. Nella UI di Chat, questo ruolo è chiamato Proprietario.

L'utente dispone del set completo di autorizzazioni per gestire lo spazio, tra cui:

  • Modificare il ruolo di altri membri dello spazio in membro, gestore o proprietario.
  • Eliminare lo spazio.

Funzionalità supportata solo in SpaceType.SPACE (spazi con nome).

Per saperne di più, vedi Scopri di più sul tuo ruolo di proprietario o gestore dello spazio.
ROLE_ASSISTANT_MANAGER

Un gestore dello spazio. Nella UI di Chat, questo ruolo è chiamato Gestore.

L'utente dispone di tutte le autorizzazioni di base di ROLE_MEMBER e un proprietario può concedergli un sottoinsieme di autorizzazioni amministrative. Per impostazione predefinita, i gestori dispongono di tutte le autorizzazioni di un proprietario, ad eccezione della possibilità di:

  • Eliminare lo spazio.
  • Rendere proprietario un altro membro dello spazio.
  • Modificare il ruolo di un proprietario.

Per impostazione predefinita, le autorizzazioni dei gestori includono, a titolo esemplificativo:

  • Rendere gestore un altro membro.
  • Eliminare i messaggi nello spazio.
  • Gestisci le autorizzazioni dello spazio.
  • Ricevere notifiche per le richieste di partecipazione allo spazio se il gestore dispone dell'autorizzazione "Gestisci membri" nelle impostazioni dello spazio.
  • Rendi uno spazio rilevabile.

Funzionalità supportata solo in SpaceType.SPACE (spazi con nome).

Per saperne di più, vedi Gestisci le impostazioni dello spazio.

MembershipState

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

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

MembershipBatchCreatedEventData

Payload evento per più nuovi abbonamenti.

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

Campi
memberships[]

MembershipCreatedEventData

Un elenco dei nuovi abbonamenti.

MembershipBatchDeletedEventData

Payload dell'evento per più abbonamenti eliminati.

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

Campi
memberships[]

MembershipDeletedEventData

Un elenco degli abbonamenti eliminati.

MembershipBatchUpdatedEventData

Payload evento per più abbonamenti aggiornati.

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

Campi
memberships[]

MembershipUpdatedEventData

Un elenco degli abbonamenti aggiornati.

MembershipCreatedEventData

Payload evento per un nuovo abbonamento.

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

Campi
membership

Membership

Il nuovo abbonamento.

MembershipDeletedEventData

Payload dell'evento per un'iscrizione 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 evento per un abbonamento aggiornato.

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

Campi
membership

Membership

L'iscrizione aggiornata.

Messaggio

Un messaggio in uno spazio di Google Chat.

Campi
name

string

Identificatore. 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 per il messaggio. Ad esempio: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Se imposti un ID personalizzato quando crei un messaggio, puoi utilizzarlo per specificare il messaggio 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 di Chat esegue l'autenticazione come utente, l'output compila solo i campi user name e type per gli utenti interni ed esterni, a meno che non siano membri dello spazio o abbiano un'affinità precedente, ad esempio una conversazione con messaggio diretto (DM), con l'utente chiamante.
create_time

Timestamp

Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo è di solo output, 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 il messaggio è stato creato nell'origine per conservare l'ora di creazione originale.
last_update_time

Timestamp

Solo output. L'ora dell'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

Facoltativo. 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 tutti gli utenti dello spazio.

Per scoprire come creare messaggi, consulta Invia 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 nell'interfaccia utente, ma include quanto segue:

  • Sintassi di markup per grassetto, corsivo, barrato, monospazio, blocco monospazio, elenco puntato e citazione.

  • Menzioni degli utenti utilizzando il formato <users/{user}>.

  • Link ipertestuali personalizzati che utilizzano il formato <{url}|{rendered_text}>, dove la prima stringa è l'URL e la seconda è il testo visualizzato, ad esempio <http://example.com|custom text>.

  • Emoji personalizzate che utilizzano il formato :{emoji_name}:, ad esempio :smile:. Questo non si applica alle emoji Unicode, come U+1F600 per un'emoji con una faccina sorridente.

  • Elementi di un elenco puntato utilizzando gli asterischi (*), ad esempio * item.

Per saperne di più, consulta Visualizza la formattazione del testo inviata in un messaggio
cards[]
(deprecated)

Card

Ritirato: utilizza invece cards_v2.

Schede interattive, formattate e avanzate che puoi utilizzare per visualizzare elementi UI come testi formattati, pulsanti e immagini cliccabili. Le schede vengono normalmente visualizzate sotto il corpo del messaggio in testo normale. cards e cards_v2 possono avere una dimensione massima di 32 KB.
cards_v2[]

CardWithId

Facoltativo. Un array di schede.

Le app di Chat possono creare schede con l'autenticazione dell'app. Nell'ambito del Programma Anteprima per gli sviluppatori, se la tua app di Chat esegue l'autenticazione come utente, può creare messaggi con schede. Se la tua app di Chat non fa parte del Programma Anteprima per gli sviluppatori, non può creare schede con l'autenticazione utente.

Per scoprire come creare un messaggio contenente schede, consulta Invia un messaggio.

Progetta e visualizza l'anteprima delle schede con Card Builder.

Apri il generatore di schede
annotations[]

Annotation

Solo output. Le annotazioni possono essere associate al corpo del messaggio in testo normale o ai chip che rimandano a risorse di Google Workspace come Documenti Google o Fogli Google con start_index e length pari a 0.
thread

Thread

Il thread a cui appartiene il messaggio. Per un esempio di utilizzo, consulta Avviare o rispondere a un thread di messaggi.
space

Space

Solo output. Se l'app di Chat esegue l'autenticazione come utente, l'output compila solo lo spazio name.
fallback_text

string

Facoltativo. Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio nelle notifiche mobile.
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 del messaggio in testo normale con tutte le menzioni dell'app di Chat rimosse.
slash_command

SlashCommand

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

Attachment

Facoltativo. Allegato caricato dall'utente.
matched_url

MatchedUrl

Solo output. Un URL nel campo del messaggio chat text che corrisponde a un pattern di anteprima del link. Per saperne di più, consulta Link di anteprima.
thread_reply

bool

Solo output. Quando true, il messaggio è una risposta in un thread di risposte. 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 in thread, questo campo è sempre false.
silent

bool

Solo output. Indica se si tratta di un messaggio silenzioso. I messaggi silenziosi sono messaggi per i quali Chat disattiva le notifiche push per i destinatari.
client_assigned_message_id

string

Facoltativo. Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio o per recuperarlo, eliminarlo o aggiornarlo. 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 dei riepiloghi delle reazioni con emoji nel messaggio.
private_message_viewer

User

Facoltativo. 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. Per includere questo campo nella richiesta, devi chiamare l'API Chat utilizzando l'autenticazione dell'app e omettere quanto segue:

Per maggiori dettagli, vedi Inviare un messaggio privato.
deletion_metadata

DeletionMetadata

Solo output. Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato delete_time.
quoted_message_metadata

QuotedMessageMetadata

Facoltativo. Informazioni su un messaggio citato da un altro messaggio.

Quando crei un messaggio, puoi citare i messaggi all'interno dello stesso thread o citare un messaggio principale per crearne uno nuovo. Tuttavia, non puoi citare una risposta a un messaggio di un altro thread.

Quando aggiorni un messaggio, non puoi aggiungere o sostituire il campo quotedMessageMetadata, ma puoi rimuoverlo.

Per un esempio di utilizzo, vedi Citare un altro messaggio.
attached_gifs[]

AttachedGif

Solo output. Immagini GIF allegate al messaggio.
accessory_widgets[]

AccessoryWidget

Facoltativo. Uno o più widget interattivi visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o entrambi. Non supportato 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 dell'app.
elements

Elements

Facoltativo. Gli elementi sono componenti aggiuntivi forniti durante la creazione del messaggio che possono essere associati o meno a parti specifiche del testo del messaggio. Questi si differenziano dalle annotazioni, che sono di solo output e offrono informazioni supplementari legate a frammenti di messaggio o all'intero testo del messaggio.

markup_syntax

MarkupSyntax

Facoltativo. Specifica il modo in cui il server interpreta i contenuti del campo text del messaggio.

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 dei messaggi eliminati.

MessageBatchUpdatedEventData

Payload evento per più messaggi aggiornati.

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

Campi
messages[]

MessageUpdatedEventData

Un elenco di messaggi aggiornati.

MessageCreatedEventData

Payload evento per un nuovo messaggio.

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

Campi
message

Message

Il nuovo messaggio.

MessageDeletedEventData

Payload 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 e deletionMetadata.

MessagePin

Un messaggio chat fissato. Per saperne di più, consulta Fissa un messaggio.

Campi
name

string

Identificatore. Il nome della risorsa del messaggio bloccato. Formato: spaces/{space}/messagePins/{message_pin} Il componente ID risorsa corrisponde al componente ID risorsa del messaggio. Ad esempio, un messaggio con spaces/AAA/messages/bbb.ccc corrisponde al pin del messaggio con il nome della risorsa spaces/AAA/messagePins/bbb.ccc.
message

string

Obbligatorio. Immutabile. Il nome della risorsa del messaggio bloccato. Formato: spaces/{space}/messages/{message}

MessageUpdatedEventData

Payload evento per un messaggio aggiornato.

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

Campi
message

Message

Il messaggio aggiornato.

MoveSectionItemRequest

Messaggio di richiesta per lo spostamento di un elemento di una sezione tra le sezioni.

Campi
name

string

Obbligatorio. Il nome della risorsa dell'elemento della sezione da spostare.

Formato: users/{user}/sections/{section}/items/{item}
target_section

string

Obbligatorio. Il nome della risorsa della sezione in cui spostare l'elemento della sezione.

Formato: users/{user}/sections/{section}

MoveSectionItemResponse

Messaggio di risposta per lo spostamento di un elemento della sezione.

Campi
section_item

SectionItem

L'elemento della sezione aggiornato.

PositionSectionRequest

Messaggio di richiesta per il posizionamento di una sezione.

Campi
name

string

Obbligatorio. Il nome della risorsa della sezione da posizionare.

Formato: users/{user}/sections/{section}
Campo unione position. Obbligatorio. La nuova posizione della sezione. position può essere solo uno dei seguenti tipi:
sort_order

int32

Facoltativo. La posizione assoluta della sezione nell'elenco delle sezioni. La posizione deve essere maggiore di 0. Se la posizione è maggiore del numero di sezioni, la sezione verrà aggiunta alla fine dell'elenco. Questa operazione inserisce la sezione nella posizione specificata e sposta la sezione originale in quella posizione e quelle sottostanti nella posizione successiva.
relative_position

Position

Facoltativo. La posizione relativa della sezione nell'elenco delle sezioni.

Posizione

La posizione della sezione.

Enum
POSITION_UNSPECIFIED Posizione non specificata.
START Inizio dell'elenco delle sezioni.
END Fine dell'elenco delle sezioni.

PositionSectionResponse

Messaggio di risposta per il posizionamento di una sezione.

Campi
section

Section

La sezione aggiornata.

QuotedMessageMetadata

Informazioni su un messaggio citato da un altro messaggio.

Quando aggiorni un messaggio, non puoi aggiungere o sostituire il campo quotedMessageMetadata, ma puoi rimuoverlo.

Per un esempio di utilizzo, vedi Citare un altro messaggio.

Campi
name

string

Obbligatorio. Nome della risorsa del messaggio citato.

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

Timestamp

Obbligatorio. Il timestamp di creazione o dell'ultimo aggiornamento del messaggio citato.

Se il messaggio è stato modificato, utilizza questo campo, last_update_time. Se il messaggio non è mai stato modificato, utilizza create_time.

Se last_update_time non corrisponde all'ultima versione del messaggio citato, la richiesta non va a buon fine.
quote_type

QuoteType

Facoltativo. Specifica il tipo di virgolette. Se non viene impostato, il valore predefinito è REPLY nel percorso di lettura/scrittura dei messaggi per la compatibilità con le versioni precedenti.
quoted_message_snapshot

QuotedMessageSnapshot

Solo output. Un'istantanea dei contenuti del messaggio citato.
forwarded_metadata

ForwardedMetadata

Solo output. Metadati relativi allo spazio di origine del messaggio citato. Compilato solo per il tipo di preventivo FORWARD.

QuoteType

Il tipo di citazione del messaggio citato.

Enum
QUOTE_TYPE_UNSPECIFIED Riservato. Questo valore non è utilizzato.
REPLY

Quando quote_type è REPLY, puoi:

  • Se rispondi in un thread, puoi citare un altro messaggio in quel thread.

  • Se stai creando un messaggio principale, puoi citare un altro messaggio principale in quello spazio.
FORWARD

Quando quote_type è FORWARD, puoi citare:

  • Messaggio proveniente da uno spazio diverso.

  • Risposta a un messaggio da un thread diverso nello stesso spazio.

QuotedMessageSnapshot

Fornisce un'istantanea dei contenuti del messaggio citato al momento della citazione o dell'inoltro

Campi
sender

string

Solo output. Il nome dell'autore del messaggio citato. Compilato per i tipi di citazione REPLY e FORWARD.
text

string

Solo output. Istantanea dei contenuti testuali del messaggio citato.
formatted_text

string

Solo output. Contiene il messaggio citato text con markup aggiunti per supportare la formattazione avanzata come link ipertestuali, emoji personalizzate, markup e così via. Compilato solo per il tipo di citazione FORWARD.
annotations[]

Annotation

Solo output. Annotazioni analizzate dal corpo del testo del messaggio citato. Compilato solo per il tipo di preventivo FORWARD.
attachments[]

Attachment

Solo output. Allegati che facevano parte del messaggio citato. Si tratta di copie dei metadati degli allegati del messaggio citato. Compilato solo per il tipo di preventivo FORWARD.

Reazione

Una reazione a un messaggio.

Campi
name

string

Identificatore. Il nome della risorsa della reazione.

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

User

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

Emoji

Obbligatorio. L'emoji utilizzata nella reazione.

ReactionBatchCreatedEventData

Payload dell'evento per più nuove reazioni.

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

Campi
reactions[]

ReactionCreatedEventData

Un elenco di nuove reazioni.

ReactionBatchDeletedEventData

Payload evento per più reazioni eliminate.

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

Campi
reactions[]

ReactionDeletedEventData

Un elenco di reazioni eliminate.

ReactionCreatedEventData

Payload evento per una nuova reazione.

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

Campi
reaction

Reaction

La nuova reazione.

ReactionDeletedEventData

Payload evento per una reazione eliminata.

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

Campi
reaction

Reaction

La reazione eliminata.

ReplaceMessageCardsRequest

Messaggio di richiesta per il metodo API ReplaceMessageCards.

Campi
name

string

Obbligatorio. Il nome della risorsa del messaggio.

Formato: spaces/{space}/messages/{message}
cards_v2[]

CardWithId

Facoltativo. Un array di schede da includere nel messaggio. Queste schede sostituiranno quelle esistenti del messaggio. Se vuoto, le schede originali incluse nel messaggio verranno cancellate.

ReplaceMessageCardsResponse

Questo tipo non ha campi.

Messaggio di risposta per l'API ReplaceMessageCards.

RichLinkMetadata

Un link avanzato a una risorsa. I link avanzati possono essere associati al corpo del messaggio in testo normale o rappresentare chip che rimandano a risorse di Google Workspace come Documenti Google o Fogli Google con start_index e length pari a 0.

Campi
uri

string

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

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 di uno spazio di Chat. Ad esempio, uno smart chip dello spazio.
GMAIL_MESSAGE Un tipo di link avanzato per i messaggi di Gmail. In particolare, un chip di Gmail da Condividi in Chat. L'API supporta solo la lettura di messaggi con link avanzati GMAIL_MESSAGE.
MEET_SPACE Un tipo di link avanzato per i messaggi di Meet. Ad esempio, un chip di Meet.
CALENDAR_EVENT Un tipo di link avanzato per i messaggi di Calendar. Ad esempio, un chip di Calendar.

SearchMessageResult

Un singolo elemento dei risultati di una ricerca di messaggi.

Campi
message

Message

Il messaggio corrispondente.
space_mute_setting

MuteSetting

L'impostazione di disattivazione dell'audio dell'utente chiamante per lo spazio in cui viene pubblicato il messaggio. L'app di chiamate può utilizzare queste informazioni per decidere come elaborare il messaggio a seconda che lo spazio sia disattivato o meno per l'utente.

Viene restituito solo se la visualizzazione della richiesta è SEARCH_MESSAGES_VIEW_FULL e le credenziali di chiamata includono il seguente ambito di autorizzazione:

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

bool

Indica se il messaggio corrispondente è stato letto dall'utente chiamante.

Viene restituito solo se la visualizzazione della richiesta è SEARCH_MESSAGES_VIEW_FULL e le credenziali di chiamata includono uno dei seguenti ambiti di autorizzazione:

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

SearchMessagesRequest

Messaggio di richiesta per la ricerca di messaggi.

Campi
parent

string

Obbligatorio. Il nome della risorsa dello spazio in cui eseguire la ricerca.

Per eseguire la ricerca in tutti gli spazi a cui l'utente ha accesso, imposta questo campo su spaces/-. L'utilizzo di qualsiasi altro valore per parent genera un errore INVALID_ARGUMENT.

Per limitare la ricerca a uno o più spazi, utilizza space.name o space.display_name in filter.
filter

string

Obbligatorio. Una query di ricerca.

La query può specificare una o più parole chiave per la rete di ricerca, che vengono utilizzate per filtrare i risultati,

Puoi anche filtrare i risultati utilizzando i seguenti campi dei messaggi:

  • create_time: accetta un timestamp in formato RFC-3339 e gli operatori di confronto supportati sono: < e >=.
  • sender.name: il nome della risorsa del mittente (users/{user}). Supporta solo =. Puoi utilizzare l'indirizzo email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.
  • space.name: il nome della risorsa dello spazio in cui viene pubblicato il messaggio. (spaces/{space}). Supporta solo =. Se questo filtro non è impostato, la ricerca viene eseguita in tutti i messaggi diretti e gli spazi a cui l'utente ha accesso come membro dello spazio.
  • space.display_name: supporta l'operatore : (contiene) e filtra gli spazi in base a una corrispondenza parziale del nome visualizzato. I risultati sono limitati alle prime cinque corrispondenze di spazi. Ad esempio, space.display_name:Project cerca i messaggi nei primi cinque spazi che contengono la parola "Progetto" nei loro nomi visualizzati.
  • space.space_type: il tipo di spazio. Supporta solo =. Ad esempio, space.space_type="DIRECT_MESSAGE" restituisce solo i messaggi diretti. I valori possibili sono DIRECT_MESSAGE, GROUP_CHAT e SPACE.
  • attachment: supporta l'operatore :* (contiene) per verificare la presenza di allegati. Se viene specificato attachment:*, vengono restituiti solo i messaggi che hanno almeno un allegato.
  • annotations.user_mentions.user.name: il nome della risorsa dell'utente menzionato (users/{user}). Supporta solo : (ha). Ad esempio: annotations.user_mentions.user.name:"users/1234567890" restituisce solo i messaggi che contengono una menzione dell'utente specificato. In alternativa, l'alias me può essere utilizzato per filtrare i messaggi che menzionano l'utente chiamante, ad esempio: annotations.user_mentions.user.name:users/me. Puoi anche utilizzare l'indirizzo email come alias per {user}, ad esempio users/example@gmail.com.

Per i filtri avanzati sono disponibili anche le seguenti funzioni:

  • has_link(): restituisce solo i messaggi che contengono almeno un link ipertestuale nel testo del messaggio.
  • is_unread(): filtra i messaggi che sono stati letti dall'utente chiamante.

L'utilizzo dei filtri space.display_name o space.space_type richiede che le credenziali di chiamata includano uno dei seguenti ambiti di autorizzazione:

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

Per utilizzare il filtro is_unread(), le credenziali di chiamata devono includere uno dei seguenti ambiti di autorizzazione:

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

Tra campi diversi, sono supportati solo gli operatori AND. Un esempio valido è sender.name = "users/1234567890" AND is_unread(). La parola AND è facoltativa ed è implicita se omessa. Ad esempio, sender.name = "users/1234567890" is_unread() è valido ed è equivalente all'esempio precedente. Un esempio non valido è sender.name = "users/1234567890" OR is_unread() perché OR non è supportato tra campi diversi.

Nello stesso campo:

  • create_time supporta solo AND e può essere utilizzato solo per rappresentare un intervallo, ad esempio create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00".
  • sender.name supporta solo l'operatore OR, ad esempio: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
  • space.name supporta solo l'operatore OR, ad esempio: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
  • space.display_name supporta gli operatori AND e OR, ma non una combinazione di entrambi. Ad esempio: space.display_name:Project AND space.display_name:Tasks restituisce i messaggi che si trovano negli spazi con nomi visualizzati contenenti sia Project sia Tasks, mentre space.display_name:Project OR space.display_name:Tasks restituisce i messaggi che si trovano negli spazi con nomi visualizzati contenenti Project o Tasks o entrambi.
  • space.space_type supporta solo l'operatore OR, ad esempio: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
  • annotations.user_mentions.user.name supporta gli operatori AND e OR, ma non una combinazione di entrambi. Ad esempio: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" restituisce solo i messaggi che menzionano entrambi gli utenti, mentre annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" restituisce i messaggi che menzionano uno o entrambi gli utenti.

Le parentesi sono necessarie per evitare ambiguità nella precedenza degli operatori quando si combinano gli operatori AND e OR nella stessa query. Ad esempio (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). In caso contrario, le parentesi sono facoltative.

Le seguenti query di esempio sono valide:

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

La lunghezza massima della query è di 1000 caratteri.

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

int32

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

Se non è specificato, vengono restituiti al massimo 25 elementi.

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

string

Facoltativo. Un token ricevuto dalla precedente chiamata di ricerca dei messaggi. Specifica questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di valori diversi agli altri parametri potrebbe portare a risultati imprevisti.
order_by

string

Facoltativo. Come viene ordinato l'elenco dei risultati.

Gli attributi supportati per l'ordinamento sono:

L'ordinamento predefinito è create_time desc. È supportato un solo ordine per query (create_time o relevance). È supportato solo l'ordine decrescente (desc), che deve essere specificato dopo l'attributo order.
markup_syntax

MarkupSyntax

Facoltativo. Specifica la sintassi di output desiderata per il campo formatted_text del messaggio chat.
view

SearchMessagesView

Facoltativo. Specifica il tipo di visualizzazione dei risultati di ricerca da restituire. Il valore predefinito è SEARCH_MESSAGES_VIEW_BASIC.

SearchMessagesView

I tipi di visualizzazione supportati per i risultati di ricerca parziali.

Enum
SEARCH_MESSAGES_VIEW_UNSPECIFIED Il valore predefinito / non impostato. Per impostazione predefinita, l'API utilizzerà la visualizzazione BASIC.
SEARCH_MESSAGES_VIEW_BASIC Include nei risultati solo i messaggi corrispondenti, ma nessun metadato aggiuntivo. Questo è il valore predefinito.
SEARCH_MESSAGES_VIEW_FULL Include tutto ciò che è presente nei risultati: i messaggi corrispondenti e i metadati aggiuntivi.

SearchMessagesResponse

Messaggio di risposta per la ricerca di messaggi.

Campi
results[]

SearchMessageResult

L'elenco dei risultati di ricerca corrispondenti alla query.
next_page_token

string

Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non verranno visualizzate altre pagine.

SearchSpacesRequest

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

Campi
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

int32

Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un numero inferiore di elementi.

Se non viene specificato, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000 quando useAdminAccess è impostato su true. In caso contrario, il valore massimo è 100. Se utilizzi un valore superiore al valore massimo, questo viene modificato automaticamente nel valore massimo.
page_token

string

Un token ricevuto dalla chiamata precedente di Search Spaces. Specifica questo parametro per recuperare la pagina successiva.

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

string

Obbligatorio. Una query di ricerca.

Puoi eseguire la ricerca utilizzando i seguenti parametri quando useAdminAccess è impostato su true:

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

Quando useAdminAccess è impostato su false:

  • display_name
  • external_user_allowed
  • space_type

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

customer è obbligatorio quando useAdminAccess è impostato su true e viene utilizzato per indicare il cliente da cui recuperare gli spazi. customers/my_customer è l'unico valore supportato.

display_name accetta solo l'operatore HAS (:). Il testo da trovare viene prima suddiviso in token e ogni token viene confrontato con il prefisso senza distinzione tra maiuscole e minuscole e in modo indipendente come sottostringa in qualsiasi punto del display_name dello spazio. Ad esempio, Fun Eve corrisponde a Fun event o The evening was fun, ma non a notFun event o even. Quando useAdminAccess è impostato su false, display_name è obbligatorio per recuperare risultati significativi. In caso contrario, il comportamento predefinito è restituire una risposta vuota.

external_user_allowed accetta true o false.

space_history_state accetta solo i valori del campo historyState di una risorsa space.

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

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

All'interno dello stesso campo, space_type non supporta gli operatori AND o OR. display_name, "space_history_state" ed "external_user_allowed" supportano solo gli operatori OR. last_active_time e create_time supportano entrambi gli operatori AND e 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".

Le seguenti query di esempio sono valide quando useAdminAccess è impostato su true:

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")

Le seguenti query di esempio sono valide quando useAdminAccess è impostato su false:

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

La lunghezza massima della query è di 1000 caratteri.

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.
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 umani che hanno partecipato direttamente a uno spazio.
  • last_active_time: indica l'ora in cui l'ultimo elemento idoneo è stato aggiunto a un argomento di questo spazio.
  • create_time: indica l'ora di creazione dello spazio.

Quando useAdminAccess è false, per l'ordinamento sono supportati solo create_time e relevance. Per questi campi nelle ricerche non di amministrazione è supportato solo DESC.

I valori validi per l'operazione di ordinamento sono:

  • ASC per l'ordine crescente. Valore predefinito.

  • DESC per l'ordine decrescente.

La sintassi supportata quando useAdminAccess è impostato su true è:

  • 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

Quando useAdminAccess è impostato su false:

SearchSpacesResponse

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

Campi
spaces[]
(deprecated)

Space

Deprecato: utilizza il nuovo campo results. Una pagina degli spazi richiesti. Questo campo verrà compilato solo quando useAdminAccess è impostato su true e verrà ritirato a favore del nuovo campo results.
next_page_token

string

Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non verranno visualizzate altre pagine.

Compilato solo quando useAdminAccess è impostato su true.
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.

Compilato solo quando useAdminAccess è impostato su true.
results[]

SearchSpaceResult

Solo output. L'elenco dei risultati di ricerca corrispondenti alla query.

SearchSpaceResult

Un singolo elemento dei risultati di una ricerca di spazi.

Campi
space

Space

Solo output. Lo spazio corrispondente.

Sezione

Rappresenta una sezione in Google Chat. Le sezioni aiutano gli utenti a organizzare i propri spazi. Esistono due tipi di sezioni:

  1. Sezioni di sistema:si tratta di sezioni predefinite gestite da Google Chat. I nomi delle risorse sono fissi e non possono essere creati, eliminati o modificati nel campo display_name. Ecco alcuni esempi:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. Sezioni personalizzate:si tratta di sezioni create e gestite dall'utente. La creazione di una sezione personalizzata utilizzando CreateSection richiede un display_name. Le sezioni personalizzate possono essere aggiornate utilizzando UpdateSection ed eliminate utilizzando DeleteSection.

Campi
name

string

Identificatore. Nome della risorsa della sezione.

Per le sezioni di sistema, l'ID sezione è una stringa costante:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

Formato: users/{user}/sections/{section}
display_name

string

Facoltativo. Il nome visualizzato della sezione. Compilato solo per le sezioni di tipo CUSTOM_SECTION. Supporta fino a 80 caratteri. Obbligatorio quando crei un CUSTOM_SECTION.
sort_order

int32

Solo output. L'ordine della sezione rispetto alle altre sezioni. Le sezioni con un valore sort_order inferiore vengono visualizzate prima di quelle con un valore superiore.
type

SectionType

Obbligatorio. Il tipo di sezione.

SectionType

Tipi di sezioni.

Enum
SECTION_TYPE_UNSPECIFIED Tipo di sezione non specificato.
CUSTOM_SECTION Sezione personalizzata.
DEFAULT_DIRECT_MESSAGES Sezione predefinita contenente spazi DIRECT_MESSAGE tra due utenti umani o GROUP_CHAT che non appartengono a nessuna sezione personalizzata.
DEFAULT_SPACES Spazi predefiniti che non appartengono a nessuna sezione personalizzata.
DEFAULT_APPS Sezione predefinita contenente le app installate di un utente.

SectionItem

Un elemento di una sezione definita dall'utente. Viene utilizzato per rappresentare gli elementi di una sezione, ad esempio gli spazi, raggruppati in una sezione.

Campi
name

string

Identificatore. Il nome della risorsa dell'elemento della sezione.

Formato: users/{user}/sections/{section}/items/{item}
Campo unione item. Obbligatorio. L'elemento della sezione. item può essere solo uno dei seguenti tipi:
space

string

Facoltativo. Il nome della risorsa dello spazio.

Formato: spaces/{space}

SetUpSpaceRequest

Richiedi la creazione di uno spazio e l'aggiunta di utenti specifici.

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 displayName diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

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 Space.singleUserBotDm su false. Non impostare Space.displayName o Space.spaceDetails.

Per creare una conversazione 1:1 tra una persona e l'app di Chat chiamante, 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 quello anziché crearne uno nuovo.
request_id

string

Facoltativo. Un ID univoco per questa richiesta. Si consiglia un UUID casuale. Se specifichi un ID richiesta, la richiesta diventa idempotente, il che garantisce che più richieste identiche con lo stesso ID richiesta comportino la creazione di un solo spazio. Le richieste successive con lo stesso ID richiesta restituiscono lo spazio esistente e non lo aggiornano, anche se i dettagli richiesti differiscono dallo stato attuale.

Per utilizzare questo campo in modo efficace:

  • Assicurati che le richieste successive siano identiche e utilizzino le stesse credenziali di autenticazione della richiesta originale.
  • Se è già stato creato uno spazio con l'ID richiesta fornito, la richiesta restituisce quello spazio. Tieni presente che lo spazio restituito potrebbe non essere completamente compilato. L'API restituisce lo spazio nella richiesta con il nome della risorsa assegnato dal sistema. Per recuperare i metadati più recenti dello spazio, chiama GetSpace.
  • Il riutilizzo di un ID richiesta esistente con un utente autenticato diverso genera 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.

Al momento, il set consente fino a 49 abbonamenti (oltre al chiamante).

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

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

Facoltativo se imposti Space.spaceType su SPACE.

Obbligatorio quando imposti Space.spaceType su GROUP_CHAT, insieme ad almeno due iscrizioni.

Obbligatorio quando imposti Space.spaceType su DIRECT_MESSAGE con un utente umano, insieme a esattamente un'iscrizione.

Deve essere vuoto quando si crea una conversazione 1:1 tra una persona e l'app di Chat chiamante (quando si imposta Space.spaceType su DIRECT_MESSAGE e Space.singleUserBotDm su true).

SlashCommand

Metadati relativi a un comando slash in Google Chat.

Campi
command_id

int64

L'ID del comando slash.

SlashCommandMetadata

Metadati di annotazione per i comandi slash (/).

Campi
bot

User

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

Type

Il tipo di comando slash.
command_name

string

Il nome del comando slash richiamato.
command_id

int64

L'ID comando del comando slash richiamato.
triggers_dialog

bool

Indica se il comando slash è per una finestra di dialogo.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
ADD Aggiungi l'app di Chat allo spazio.
INVOKE Richiamare 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

Identificatore. Nome risorsa dello spazio.

Formato: spaces/{space}

Dove {space} rappresenta l'ID assegnato dal sistema per lo spazio. Puoi ottenere l'ID spazio chiamando il metodo spaces.list() o dall'URL dello spazio. Ad esempio, se l'URL dello spazio è https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID spazio è AAAAAAAAA.
type
(deprecated)

Type

Solo output. Ritirato: utilizza invece space_type. Il tipo di spazio.
space_type

SpaceType

Facoltativo. Il tipo di spazio. Obbligatorio quando crei uno spazio o aggiorni il tipo di spazio. Solo output per altri utilizzi.
single_user_bot_dm

bool

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

bool

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

string

Facoltativo. Il nome visualizzato dello spazio. Obbligatorio quando crei uno spazio con un spaceType di SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio o aggiorni displayName, prova con un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Per i messaggi diretti, questo campo potrebbe essere vuoto.

Supporta fino a 128 caratteri.
external_user_allowed

bool

Facoltativo. 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 consente l'accesso a qualsiasi utente di Google Chat.

Per gli spazi esistenti, questo campo è di solo output.
space_threading_state

SpaceThreadingState

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

SpaceDetails

Facoltativo. Dettagli sullo spazio, tra cui descrizione e regole.
space_history_state

HistoryState

Facoltativo. 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 a Google Workspace. Durante l'importazione, gli spazi non sono visibili agli utenti fino al completamento dell'operazione.

La creazione di uno spazio in Import Mode richiede l'autenticazione utente.
create_time

Timestamp

Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato lo spazio. Questo campo è di solo output, 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 preservare 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 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 dell'amministratore, l'app di Chat deve disporre della funzionalità di messaggistica diretta.
membership_count

MembershipCount

Solo output. Il numero di abbonamenti sottoscritti raggruppati per tipo di abbonato. Viene 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 che un utente può utilizzare per accedere allo spazio.
import_mode_expire_time

Timestamp

Solo output. L'ora in cui lo spazio verrà eliminato automaticamente dal sistema se rimane in modalità di importazione.

Ogni spazio creato in modalità di importazione deve uscire da questa modalità prima della scadenza utilizzando spaces.completeImport.

Questo campo viene compilato solo per gli spazi creati con la modalità di importazione.
customer

string

Facoltativo. Immutabile. L'ID cliente del dominio dello spazio. Obbligatorio solo quando si crea uno spazio con autenticazione dell'app e SpaceType è SPACE, altrimenti non deve essere impostato.

Nel formato customers/{customer}, dove customer è il id della risorsa cliente dell'SDK Admin. Le app private possono anche utilizzare l'alias customers/my_customer per creare lo spazio nella stessa organizzazione Google Workspace dell'app.

Questo campo non viene compilato per i messaggi diretti o quando lo spazio viene creato da utenti non Google Workspace.
Campo unione space_permission_settings. Rappresenta il set di autorizzazioni di uno spazio. Compilato solo quando space_type è SPACE. space_permission_settings può essere solo uno dei seguenti tipi:
predefined_permission_settings

PredefinedPermissionSettings

Facoltativo. Solo input. Impostazioni dei set di autorizzazioni dello spazio predefinite, solo input durante la creazione di uno spazio. Se il campo non è impostato, viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono compilate nel campo PermissionSettings.

La configurazione di set di autorizzazioni predefiniti supporta:
permission_settings

PermissionSettings

Facoltativo. Impostazioni delle autorizzazioni per gli spazi esistenti. Input per l'aggiornamento delle impostazioni esatte dei set di autorizzazioni per lo spazio, in cui le impostazioni dei set di autorizzazioni esistenti vengono sostituite. L'output elenca le impostazioni di autorizzazione correnti.

La lettura e l'aggiornamento delle impostazioni delle autorizzazioni supportano:

AccessPermissionSetting

Un'impostazione delle autorizzazioni di accesso.

Campi
principals[]

Principal

Facoltativo. Elenco non ordinato. Entità consentite per questa autorizzazione.

AccessPermissionSettings

Accedi alle impostazioni dei set di autorizzazioni per uno spazio.

Campi
discover_space_setting

AccessPermissionSetting

Facoltativo. Impostazione del set di autorizzazioni per la scoperta dello spazio.
join_space_setting

AccessPermissionSetting

Facoltativo. Impostazione del set di autorizzazioni per partecipare allo spazio.
view_space_membership_setting

AccessPermissionSetting

Facoltativo. Impostazione dell'autorizzazione di accesso per la visualizzazione dell'iscrizione allo spazio. Deve essere specificato insieme a PermissionSettings.view_space_membership nella maschera di aggiornamento e nel corpo della richiesta quando si aggiorna chi può visualizzare l'iscrizione allo spazio. Quando concedi l'accesso in visualizzazione a un pubblico di destinazione, devi anche concedere PermissionSettings.view_space_membership a tutti i membri nella stessa richiesta. Per rimuovere un pubblico di destinazione esistente (ad esempio, per limitare l'accesso in visualizzazione solo ai gestori o ai gestori assistenti dello spazio), specifica un AccessPermissionSetting vuoto (senza principals).

AccessSettings

Rappresenta l'impostazione di accesso dello spazio.

Campi
access_state

AccessState

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

string

Facoltativo. Il nome della risorsa del pubblico di destinazione che può scoprire lo spazio, parteciparvi e visualizzare l'anteprima dei messaggi al suo interno. Se non viene impostato, solo gli utenti o i gruppi Google che sono stati invitati o aggiunti singolarmente allo spazio possono accedervi. Per maggiori dettagli, vedi Rendi uno spazio rilevabile per un pubblico di destinazione.

Formato: audiences/{audience}

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

La lettura del pubblico di destinazione supporta:

Questo campo non viene compilato quando si utilizza l'ambito chat.bot con l'autenticazione dell'app.

L'impostazione del pubblico di destinazione richiede l'autenticazione utente.
access_permission_settings

AccessPermissionSettings

Facoltativo. Accedi alle impostazioni dei set di autorizzazioni per lo spazio.

Per impostare il pubblico di destinazione durante la creazione di uno spazio, specifica il campo accessSettings.audience nella richiesta.

AccessState

Rappresenta lo stato di accesso dello spazio.

Enum
ACCESS_STATE_UNSPECIFIED Lo stato di 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 amministratori di Google Workspace possono scoprire 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 trovarlo e accedervi. Per saperne di più, vedi Rendi uno spazio rilevabile per utenti specifici.

La creazione di spazi rilevabili richiede l'autenticazione utente.

MembershipCount

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

Campi
joined_direct_human_user_count

int32

Solo output. Numero di utenti umani che hanno partecipato direttamente allo spazio, esclusi gli utenti che hanno partecipato perché membri di un gruppo che ha partecipato.
joined_group_count

int32

Solo output. Numero di tutti i gruppi che hanno partecipato direttamente allo spazio.

PermissionSetting

Rappresenta un set di autorizzazioni per uno spazio.

Campi
managers_allowed

bool

Facoltativo. Indica se i proprietari dello spazio (ROLE_MANAGER) dispongono di questa autorizzazione.
members_allowed

bool

Facoltativo. Indica se i membri di base dello spazio (ROLE_MEMBER) dispongono di questa autorizzazione.
assistant_managers_allowed

bool

Facoltativo. Se i gestori dello spazio ROLE_ASSISTANT_MANAGER) dispongono di questa autorizzazione.

PermissionSettings

Impostazioni delle autorizzazioni che puoi specificare quando aggiorni uno spazio con nome esistente.

Per impostare le autorizzazioni durante la creazione di uno spazio, specifica il campo PredefinedPermissionSettings nella richiesta.

Campi
manage_members_and_groups

PermissionSetting

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

PermissionSetting

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

PermissionSetting

Facoltativo. Impostazione per attivare e disattivare la cronologia dello spazio.
use_at_mention_all

PermissionSetting

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

PermissionSetting

Facoltativo. Impostazione per la gestione delle app in uno spazio.
manage_webhooks

PermissionSetting

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

Facoltativo. Impostazione per rispondere ai messaggi in uno spazio.
view_space_membership

PermissionSetting

Facoltativo. Impostazione per la visualizzazione dell'abbonamento a uno spazio. Deve essere specificato insieme a AccessPermissionSettings.view_space_membership_setting nella maschera di aggiornamento e nel corpo della richiesta quando si aggiorna chi può visualizzare l'iscrizione allo spazio. Quando limiti l'accesso in visualizzazione a ruoli specifici (ad esempio, solo gestori dello spazio o assistenti gestori), specifica qui le autorizzazioni del ruolo desiderate e fornisci un AccessPermissionSettings.view_space_membership_setting vuoto nella stessa richiesta. Se un pubblico di destinazione è configurato in AccessPermissionSettings.view_space_membership_setting, questa impostazione deve essere concessa a tutti i membri.

PredefinedPermissionSettings

Impostazioni di autorizzazione predefinite che puoi specificare solo durante la creazione di uno spazio con nome. In futuro è possibile che vengano aggiunte altre impostazioni. Per maggiori dettagli sulle impostazioni di autorizzazione per gli spazi con nome, consulta 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.

Entità

Un'entità che rappresenta un'entità a cui è stato concesso l'accesso.

Campi
Campo unione principal_type. Il tipo di entità. principal_type può essere solo uno dei seguenti tipi:
audience

Audience

Un segmento di pubblico.

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 4096 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 che supportano i thread di messaggi. Quando gli utenti rispondono a un messaggio, possono farlo all'interno del thread, mantenendo 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.
UNTHREADED_MESSAGES

Spazi che non supportano i thread di messaggi. Questo stato dei thread dello spazio viene utilizzato solo per casi speciali, tra cui:

  • Chat continua della riunione in cui i thread sono disattivati intenzionalmente.
  • Conversazioni di gruppo legacy create prima del 2022.

SpaceType

Il tipo di spazio. Obbligatorio quando crei o aggiorni uno spazio. Solo output 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 tra una persona e un'app di Chat.

Tipo

Ritirato: utilizza invece SpaceType.

Enum
TYPE_UNSPECIFIED Riservato.
ROOM Conversazioni tra due o più persone.
DM Messaggio diretto 1:1 tra un essere umano e un'app di Chat, in cui tutti i messaggi sono piatti. Tieni presente che questo non include 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 di spazi aggiornati.

SpaceEvent

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

Campi
name

string

Nome della risorsa dell'evento dello spazio.

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

Timestamp

Ora in cui si è verificato l'evento.
event_type

string

Tipo di evento dello 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 della query. Per impostazione predefinita, il server restituisce sia il tipo di evento sia la relativa 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
  • Membership eliminata: google.workspace.chat.membership.v1.deleted
  • Più nuovi abbonamenti: 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
  • Più nuove reazioni: google.workspace.chat.reaction.v1.batchCreated
  • Più reazioni eliminate: google.workspace.chat.reaction.v1.batchDeleted

Tipi di eventi supportati relativi allo spazio:

  • Spazio aggiornato: google.workspace.chat.space.v1.updated
  • Aggiornamenti di più spazi: google.workspace.chat.space.v1.batchUpdated

Campo unione payload.

payload può essere solo uno dei seguenti tipi:
message_created_event_data

MessageCreatedEventData

Payload evento per un nuovo messaggio.

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

MessageUpdatedEventData

Payload evento per un messaggio aggiornato.

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

MessageDeletedEventData

Payload 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 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 evento per l'aggiornamento di uno 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 evento per un nuovo abbonamento.

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

MembershipUpdatedEventData

Payload evento per un abbonamento aggiornato.

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

MembershipDeletedEventData

Payload dell'evento per un'iscrizione eliminata.

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

MembershipBatchCreatedEventData

Payload evento per più nuovi abbonamenti.

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

MembershipBatchUpdatedEventData

Payload evento per più abbonamenti aggiornati.

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

MembershipBatchDeletedEventData

Payload dell'evento per più abbonamenti eliminati.

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

ReactionCreatedEventData

Payload evento per una nuova reazione.

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

ReactionDeletedEventData

Payload evento per una reazione eliminata.

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

ReactionBatchCreatedEventData

Payload dell'evento per più nuove reazioni.

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

ReactionBatchDeletedEventData

Payload evento per più reazioni eliminate.

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

SpaceNotificationSetting

L'impostazione di notifica di un utente in uno spazio.

Campi
name

string

Identificatore. Il nome della risorsa dell'impostazione di notifica dello spazio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting.
notification_setting

NotificationSetting

L'impostazione di notifica.
mute_setting

MuteSetting

L'impostazione di disattivazione delle notifiche dello spazio.

MuteSetting

I tipi di impostazioni di disattivazione delle notifiche dello spazio.

Enum
MUTE_SETTING_UNSPECIFIED Riservato.
UNMUTED L'utente riceverà le notifiche per lo spazio in base alle impostazioni di notifica.
MUTED L'utente non riceverà alcuna notifica per lo spazio, indipendentemente dall'impostazione di notifica.

NotificationSetting

I tipi di impostazioni di notifica. In futuro potrebbero essere supportati altri tipi.

Enum
NOTIFICATION_SETTING_UNSPECIFIED Riservato.
ALL Le notifiche vengono attivate da @menzioni, thread seguiti e primo messaggio di nuovi thread. Tutti i nuovi thread vengono seguiti automaticamente, a meno che l'utente non li smetta di seguirli manualmente.
MAIN_CONVERSATIONS La notifica viene attivata da @menzioni, thread seguiti e primo messaggio di nuovi thread. Non disponibile per i messaggi diretti 1:1.
FOR_YOU La notifica viene attivata dalle @menzioni e dai thread seguiti. Non disponibile per i messaggi diretti 1:1.
OFF La notifica non è attiva.

SpaceReadState

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

Campi
name

string

Nome della risorsa dello stato di lettura dello spazio.

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

Timestamp

Facoltativo. L'ora in cui è stato aggiornato lo stato di lettura dello spazio dell'utente. In genere, 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 evento per uno spazio aggiornato.

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

Campi
space

Space

Lo spazio aggiornato.

SpaceView

Una visualizzazione che specifica quali campi devono essere compilati nella risorsa Space. Per garantire la compatibilità con le release future, ti consigliamo di tenere conto di valori aggiuntivi nel codice.

Enum
SPACE_VIEW_UNSPECIFIED Il valore predefinito / non impostato.
SPACE_VIEW_RESOURCE_NAME_ONLY Compila solo il nome della risorsa Spazio.
SPACE_VIEW_EXPANDED Compila i campi della risorsa Spazio. Nota: il campo permissionSettings non verrà compilato. Le richieste che specificano SPACE_VIEW_EXPANDED devono includere ambiti che consentono la lettura dei dati dello spazio, ad esempio https://www.googleapis.com/auth/chat.spaces o https://www.googleapis.com/auth/chat.spaces.readonly.

Thread

Un thread in uno spazio di Google Chat. Per un esempio di utilizzo, consulta 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

Identificatore. 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 di Chat che lo imposta. Ad esempio, se più app di Chat creano un messaggio utilizzando la stessa chiave 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 non letti.

Campi
name

string

Nome della 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. In genere, corrisponde al timestamp dell'ultimo messaggio letto in un thread.

UpdateAvailabilityRequest

Messaggio di richiesta per il metodo UpdateAvailability.

Campi
availability

Availability

Obbligatorio. La disponibilità da aggiornare.
update_mask

FieldMask

Obbligatorio. L'elenco dei campi da aggiornare. L'unico campo che può essere aggiornato è custom_status.

UpdateMembershipRequest

Messaggio di richiesta per l'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

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

UpdateMessageRequest

Richiedi 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 viene trovato, 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.

UpdateSectionRequest

Messaggio di richiesta per l'aggiornamento di una sezione.

Campi
section

Section

Obbligatorio. La sezione da aggiornare.
update_mask

FieldMask

Obbligatorio. La maschera per specificare i campi da aggiornare.

Percorsi dei campi attualmente supportati:

  • display_name

UpdateSpaceNotificationSettingRequest

Richiedere l'aggiornamento delle impostazioni di notifica dello spazio. Supporta solo l'aggiornamento dell'impostazione di notifica per l'utente che effettua la chiamata.

Campi
space_notification_setting

SpaceNotificationSetting

Obbligatorio. Il nome della risorsa per le impostazioni di notifica dello spazio deve essere compilato nel formato users/{user}/spaces/{space}/spaceNotificationSetting. Vengono aggiornati solo i campi specificati da update_mask.
update_mask

FieldMask

Obbligatorio. Percorsi dei campi supportati:

  • notification_setting

  • mute_setting

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.

  • Il suo indirizzo email Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

  • Il suo 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 viene visualizzato come da leggere nell'interfaccia utente.

Per contrassegnare lo spazio come letto, imposta last_read_time su un valore successivo (maggiore) rispetto all'ora di creazione dell'ultimo messaggio. last_read_time viene forzato in modo che corrisponda all'ora di creazione dell'ultimo messaggio. 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

Una 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 sono presenti più percorsi.

Puoi aggiornare i seguenti campi per uno spazio:

space_details: aggiorna la descrizione e le linee guida dello spazio. Nella richiesta di aggiornamento devi passare sia la descrizione sia le linee guida come SpaceDetails. Se vuoi aggiornare solo uno dei campi, passa il valore esistente per l'altro campo.

display_name: supporta solo l'aggiornamento del nome visualizzato per gli spazi in cui il campo spaceType è SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS, prova un valore diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

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 ha già il tipo SPACE. Se provi ad aggiornare il tipo di spazio in altri modi, viene generato un errore di argomento non valido. space_type non è supportato con useAdminAccess.

space_history_state: aggiorna le impostazioni della cronologia dello spazio attivando o disattivando la cronologia per lo spazio. Supportato solo se le impostazioni della cronologia sono attivate per l'organizzazione Google Workspace. Per aggiornare lo stato della cronologia dello spazio, devi omettere tutte le altre maschere di campo nella richiesta. space_history_state non è supportato con useAdminAccess.

access_settings.audience: aggiorna l'impostazione di accesso di chi può scoprire lo spazio, partecipare allo spazio e visualizzare l'anteprima dei messaggi nello spazio con nome 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 di uno spazio, l'utente che esegue l'autenticazione deve essere un gestore dello spazio e omettere tutte le altre maschere di campo nella richiesta. Non puoi aggiornare questo campo se lo spazio è in modalità di importazione. Per saperne di più, vedi Rendi uno spazio rilevabile per utenti specifici. access_settings.audience non è supportato con useAdminAccess.

access_settings.access_permission_settings: aggiorna le impostazioni dei set di autorizzazioni di chi può scoprire e partecipare allo spazio in cui il campo spaceType è SPACE. Le entità autorizzate a partecipare allo spazio devono anche essere autorizzate a scoprirlo. Per aggiornare le impostazioni delle autorizzazioni di accesso per uno spazio, l'utente autenticato deve essere un gestore o un assistente del gestore dello spazio e omettere tutte le altre maschere di campo nella richiesta. Non puoi aggiornare questo campo se lo spazio è in modalità di importazione. Per saperne di più, vedi Rendi uno spazio rilevabile per utenti specifici. access_settings.access_permission_settings non è supportato con useAdminAccess. Le maschere di campo supportate includono:

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

permission_settings: supporta la modifica delle impostazioni di autorizzazione di uno spazio. Quando aggiorni le impostazioni dei set di autorizzazioni, puoi specificare solo le maschere di campo permissionSettings; non puoi aggiornare altre maschere di campo contemporaneamente. Le maschere di campo supportate includono:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
  • permission_settings.viewSpaceMembership
use_admin_access

bool

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

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

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

Alcuni valori FieldMask non sono supportati con l'accesso amministrativo. Per maggiori dettagli, consulta la descrizione di update_mask.

Utente

Un utente in Google Chat.

Quando viene restituito come output di una richiesta, se l'app di Chat esegue l'autenticazione come utente, l'output di una risorsa User (ad esempio nelle API Messages e Memberships) compila solo i campi name e type per gli utenti interni ed esterni, a meno che non siano membri dello spazio o abbiano un'affinità precedente con l'utente chiamante.

Campi
name

string

Nome della risorsa per un user di Google Chat.

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

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

  • id per la Persona nell'API People. Ad esempio, users/123456789 nell'API Chat rappresenta la stessa persona dell'ID profilo personale 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 personale dell'API People per user@example.com è 123456789, puoi utilizzare users/user@example.com come alias per fare riferimento a users/123456789. L'API restituirà solo il nome della risorsa canonica (ad esempio users/123456789).
display_name

string

Solo output. Il nome visualizzato dell'utente.

Compilato sia per l'autenticazione dell'app sia per l'autenticazione dell'utente. Questo campo viene sempre compilato per le richieste effettuate con l'autenticazione dell'app. Quando chiami le API Messages e Memberships con l'autenticazione utente, questo campo viene compilato sia per gli utenti interni che per quelli esterni per il sender di un messaggio, per gli utenti all'interno di annotations (ad esempio le menzioni degli utenti) e all'interno delle risorse Membership, a condizione che l'utente sia un membro dello spazio o abbia un'affinità precedente con l'utente chiamante.
avatar_url

string

Solo output. L'URL dell'immagine dell'avatar dell'utente.

Quando chiami le API Messages e Memberships con l'autenticazione utente, questo campo viene compilato sia per gli utenti interni che per quelli esterni per il sender di un messaggio, per gli utenti all'interno di annotations (ad esempio le menzioni degli utenti) e all'interno delle risorse Membership, a condizione che l'utente sia un membro dello spazio o abbia un'affinità precedente con l'utente chiamante.
email

string

Solo output. L'indirizzo email dell'utente.

Quando chiami le API Messages e Memberships con l'autenticazione utente, questo campo viene compilato sia per gli utenti interni che per quelli esterni per il sender di un messaggio, per gli utenti all'interno di annotations (ad esempio le menzioni degli utenti) e all'interno delle risorse Membership, a condizione che l'utente sia un membro dello spazio o abbia un'affinità precedente con l'utente chiamante.
domain_id

string

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, ad esempio quando un utente viene menzionato in uno spazio senza essere un membro e senza affinità precedente con l'utente chiamante.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enum. DO NOT USE.
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'enum. Non utilizzare.
ADD Aggiungi un utente allo spazio.
MENTION Menzionare un utente nello spazio.

WidgetMarkup

Un widget è un elemento UI che presenta testo e immagini.

Campi
buttons[]

Button

Un elenco di pulsanti. Anche Buttons è oneof data e deve essere impostato solo uno di questi campi.
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 tipi:
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

Pulsante A. Può essere un pulsante di testo o un pulsante immagine.

Campi

Campo unione type.

type può essere solo uno dei seguenti tipi:
text_button

TextButton

Un pulsante con testo e l'azione onclick.
image_button

ImageButton

Un pulsante con un'immagine e l'azione onclick.

FormAction

Un'azione del modulo descrive il comportamento quando il modulo 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 la parte del modulo che ha attivato l'invio del modulo. Queste informazioni vengono restituite all'app di Chat nell'ambito dell'evento di clic sulla scheda. Puoi utilizzare lo stesso nome di metodo per più elementi che attivano un comportamento comune.
parameters[]

ActionParameter

Elenco dei parametri dell'azione.

ActionParameter

Elenco di parametri di stringa da fornire quando viene richiamato il metodo di azione. Ad esempio, considera tre pulsanti Posticipa: Posticipa ora, Posticipa di un giorno, Posticipa alla prossima settimana. Potresti utilizzare action method = snooze(), passando il tipo di posticipo e l'ora di posticipo nell'elenco dei parametri di stringa.

Campi
key

string

Il nome del parametro per lo script dell'azione.
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 specificata da un URL che può avere un'azione onclick.

Campi
image_url

string

L'URL dell'immagine.
on_click

OnClick

L'azione onclick.
aspect_ratio

double

Le proporzioni di questa immagine (larghezza e altezza). Questo campo ti consente di riservare l'altezza corretta per l'immagine in attesa del caricamento. Non è destinato a sostituire le proporzioni integrate dell'immagine. Se non è impostato, il server lo compila precaricando l'immagine.

ImageButton

Un pulsante immagine con un'azione onclick.

Campi
on_click

OnClick

L'azione onclick.
name

string

Il nome di questo image_button utilizzato per l'accessibilità. Se questo nome non viene 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 tipi:
icon

Icon

L'icona specificata da un enum che rimanda 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 (contenuto). Questo elemento può contenere anche alcune azioni, ad esempio il pulsante onclick.

Campi
top_label

string

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

string

Il testo dei contenuti. Il testo formattato è supportato e sempre obbligatorio. Per saperne di più sulla formattazione del testo, consulta 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 inferiore. Testo formattato supportato. Per saperne di più sulla formattazione del testo, consulta Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
on_click

OnClick

L'azione onclick. Solo l'etichetta superiore, l'etichetta inferiore e la regione dei contenuti sono cliccabili.
Campo unione icons. È necessario definire almeno una delle icone, top_label e bottom_label. icons può essere solo uno dei seguenti tipi:
icon

Icon

Un valore enum che viene 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 tipi:
button

Button

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

OnClick

Un'azione onclick (ad esempio, l'apertura di un link).

Campi

Campo unione data.

data può essere solo uno dei seguenti tipi:
action

FormAction

Se specificata, un'azione del modulo viene attivata da questa azione onclick.

TextButton

Un pulsante con testo e l'azione 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, consulta Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

Campi
text

string