Indice
ChatService
(interfaccia)AccessoryWidget
(messaggio)ActionResponse
(messaggio)ActionResponse.ResponseType
(enum)ActionResponse.SelectionItems
(messaggio)ActionResponse.UpdatedWidget
(messaggio)ActionStatus
(messaggio)Annotation
(messaggio)AnnotationType
(enum)AttachedGif
(messaggio)Attachment
(messaggio)Attachment.Source
(enum)AttachmentDataRef
(messaggio)CardWithId
(messaggio)ChatSpaceLinkData
(messaggio)CompleteImportSpaceRequest
(messaggio)CompleteImportSpaceResponse
(messaggio)ContextualAddOnMarkup
(messaggio)ContextualAddOnMarkup.Card
(messaggio)ContextualAddOnMarkup.Card.CardAction
(messaggio)ContextualAddOnMarkup.Card.CardHeader
(messaggio)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum)ContextualAddOnMarkup.Card.Section
(messaggio)CreateMembershipRequest
(messaggio)CreateMessageRequest
(messaggio)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(messaggio)CreateSpaceRequest
(messaggio)CustomEmoji
(messaggio)DeleteMembershipRequest
(messaggio)DeleteMessageRequest
(messaggio)DeleteReactionRequest
(messaggio)DeleteSpaceRequest
(messaggio)DeletionMetadata
(messaggio)DeletionMetadata.DeletionType
(enum)Dialog
(messaggio)DialogAction
(messaggio)DriveDataRef
(messaggio)DriveLinkData
(messaggio)Emoji
(messaggio)EmojiReactionSummary
(messaggio)FindDirectMessageRequest
(messaggio)GetAttachmentRequest
(messaggio)GetMembershipRequest
(messaggio)GetMessageRequest
(messaggio)GetSpaceEventRequest
(messaggio)GetSpaceReadStateRequest
(messaggio)GetSpaceRequest
(messaggio)GetThreadReadStateRequest
(messaggio)Group
(messaggio)HistoryState
(enum)ListMembershipsRequest
(messaggio)ListMembershipsResponse
(messaggio)ListMessagesRequest
(messaggio)ListMessagesResponse
(messaggio)ListReactionsRequest
(messaggio)ListReactionsResponse
(messaggio)ListSpaceEventsRequest
(messaggio)ListSpaceEventsResponse
(messaggio)ListSpacesRequest
(messaggio)ListSpacesResponse
(messaggio)MatchedUrl
(messaggio)Membership
(messaggio)Membership.MembershipRole
(enum)Membership.MembershipState
(enum)MembershipBatchCreatedEventData
(messaggio)MembershipBatchDeletedEventData
(messaggio)MembershipBatchUpdatedEventData
(messaggio)MembershipCreatedEventData
(messaggio)MembershipDeletedEventData
(messaggio)MembershipUpdatedEventData
(messaggio)Message
(messaggio)MessageBatchCreatedEventData
(messaggio)MessageBatchDeletedEventData
(messaggio)MessageBatchUpdatedEventData
(messaggio)MessageCreatedEventData
(messaggio)MessageDeletedEventData
(messaggio)MessageUpdatedEventData
(messaggio)QuotedMessageMetadata
(messaggio)Reaction
(messaggio)ReactionBatchCreatedEventData
(messaggio)ReactionBatchDeletedEventData
(messaggio)ReactionCreatedEventData
(messaggio)ReactionDeletedEventData
(messaggio)RichLinkMetadata
(messaggio)RichLinkMetadata.RichLinkType
(enum)SearchSpacesRequest
(messaggio)SearchSpacesResponse
(messaggio)SetUpSpaceRequest
(messaggio)SlashCommand
(messaggio)SlashCommandMetadata
(messaggio)SlashCommandMetadata.Type
(enum)Space
(messaggio)Space.AccessSettings
(messaggio)Space.AccessSettings.AccessState
(enum)Space.MembershipCount
(messaggio)Space.PermissionSetting
(messaggio)Space.PermissionSettings
(messaggio)Space.PredefinedPermissionSettings
(enum)Space.SpaceDetails
(messaggio)Space.SpaceThreadingState
(enum)Space.SpaceType
(enum)Space.Type
(enum)SpaceBatchUpdatedEventData
(messaggio)SpaceEvent
(messaggio)SpaceReadState
(messaggio)SpaceUpdatedEventData
(messaggio)Thread
(messaggio)ThreadReadState
(messaggio)UpdateMembershipRequest
(messaggio)UpdateMessageRequest
(messaggio)UpdateSpaceReadStateRequest
(messaggio)UpdateSpaceRequest
(messaggio)User
(messaggio)User.Type
(enum)UserMentionMetadata
(messaggio)UserMentionMetadata.Type
(enum)WidgetMarkup
(messaggio)WidgetMarkup.Button
(messaggio)WidgetMarkup.FormAction
(messaggio)WidgetMarkup.FormAction.ActionParameter
(messaggio)WidgetMarkup.Icon
(enum)WidgetMarkup.Image
(messaggio)WidgetMarkup.ImageButton
(messaggio)WidgetMarkup.KeyValue
(messaggio)WidgetMarkup.OnClick
(messaggio)WidgetMarkup.OpenLink
(messaggio)WidgetMarkup.TextButton
(messaggio)WidgetMarkup.TextParagraph
(messaggio)
ChatService
Consente agli sviluppatori di creare app e integrazioni di chat sulla piattaforma Google Chat.
CompleteImportSpace |
---|
Completa il processo di importazione per lo spazio specificato e lo rende visibile agli utenti. Richiede l'autenticazione delle app e la delega a livello di dominio. Per saperne di più, vedi Autorizzare le app Google Chat a importare dati.
|
CreateMembership |
---|
Crea un'iscrizione per l'app Chat per le chiamate, un utente o un gruppo Google. La creazione di abbonamenti per altre app di chat non è supportata. Durante la creazione di un abbonamento, se il membro specificato ha disattivato le norme di accettazione automatica, riceverà un invito e dovrà accettare l'invito allo spazio prima di partecipare. Altrimenti, se crei un'iscrizione, il membro verrà aggiunto direttamente allo spazio specificato. Richiede l'autenticazione dell'utente. Ad esempio, consulta:
|
CreateMessage |
---|
Crea un messaggio in uno spazio di Google Chat. Per un esempio, vedi Inviare un messaggio. Il metodo L'immagine seguente mostra in che modo Chat attribuisce un messaggio quando utilizzi l'autenticazione app. Chat mostra l'app Chat come mittente del messaggio. I contenuti del messaggio possono includere testo ( L'immagine seguente mostra in che modo Chat attribuisce un messaggio quando utilizzi l'autenticazione utente. Chat mostra l'utente come mittente del messaggio e attribuisce l'app Chat al messaggio visualizzandone il nome. I contenuti del messaggio possono contenere solo testo ( La dimensione massima del messaggio, inclusi i contenuti, è di 32.000 byte.
|
CreateReaction |
---|
Crea una reazione e la aggiunge a un messaggio. Sono supportate solo le emoji Unicode. Ad esempio, vedi Aggiungere una reazione a un messaggio. Richiede l'autenticazione dell'utente.
|
CreateSpace |
---|
Crea uno spazio senza membri. Può essere utilizzato per creare uno spazio denominato. Gli spazi raggruppati per argomento non sono supportati. Ad esempio, vedi Creare uno spazio. Se ricevi il messaggio di errore Se hai aderito al programma Anteprima per gli sviluppatori, puoi creare una chat di gruppo in modalità di importazione utilizzando Richiede l'autenticazione dell'utente.
|
DeleteMembership |
---|
Elimina un abbonamento. Ad esempio, vedi Rimuovere un utente o un'app Google Chat da uno spazio. Richiede l'autenticazione dell'utente.
|
DeleteMessage |
---|
Elimina un messaggio. Ad esempio, vedi Eliminare un messaggio. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti. Quando utilizzi l'autenticazione delle app, le richieste possono eliminare solo i messaggi creati dall'app Chat che chiama.
|
DeleteReaction |
---|
Elimina una reazione a un messaggio. Sono supportate solo le emoji Unicode. Ad esempio, vedi Eliminare una reazione. Richiede l'autenticazione dell'utente.
|
DeleteSpace |
---|
Elimina uno spazio denominato. Esegue sempre un'eliminazione a cascata, il che significa che vengono eliminate anche le risorse secondarie dello spazio, come i messaggi pubblicati e le iscrizioni allo spazio. Ad esempio, vedi Eliminare uno spazio. Richiede l'autenticazione dell'utente da parte di un utente che dispone dell'autorizzazione per eliminare lo spazio.
|
FindDirectMessage |
---|
Restituisce il messaggio diretto esistente con l'utente specificato. Se non viene trovato nessuno spazio per i messaggi diretti, restituisce un errore Con l'autenticazione dell'utente, restituisce lo spazio di messaggi diretti tra l'utente specificato e l'utente autenticato. Con l'autenticazione app, restituisce lo spazio di messaggi diretti tra l'utente specificato e l'app Chat che chiama. Richiede l'autenticazione utente o l'autenticazione dell'app.
|
GetAttachment |
---|
Recupera i metadati dell'allegato di un messaggio. I dati degli allegati vengono recuperati utilizzando l'API Media. Ad esempio, vedi Recuperare i metadati relativi all'allegato di un messaggio. Richiede l'autenticazione delle app.
|
GetMembership |
---|
Restituisce i dettagli di un abbonamento. Per un esempio, consulta Ottenere dettagli sull'abbonamento di un utente o di un'app Google Chat. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.
|
GetMessage |
---|
Restituisce i dettagli di un messaggio. Per un esempio, vedi Ottenere dettagli su un messaggio. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti. Nota: potrebbe restituire un messaggio proveniente da un membro o da uno spazio bloccati.
|
GetSpace |
---|
Restituisce i dettagli di uno spazio. Per un esempio, consulta Ottenere i dettagli su uno spazio. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.
|
GetSpaceEvent |
---|
Restituisce un evento da uno spazio di Google Chat. Il payload evento contiene la versione più recente della risorsa che è stata modificata. Ad esempio, se richiedi un evento per un nuovo messaggio, ma quest'ultimo è stato successivamente aggiornato, il server restituisce la risorsa Richiede l'autenticazione dell'utente. Per ricevere un evento, l'utente autenticato deve essere membro dello spazio. Per un esempio, vedi Ricevere dettagli su un evento da uno spazio di Google Chat.
|
GetSpaceReadState |
---|
Restituisce i dettagli sullo stato di lettura di un utente all'interno di uno spazio, utilizzati per identificare i messaggi letti e da leggere. Per un esempio, vedi Ottenere dettagli sullo stato di lettura dello spazio di un utente. Richiede l'autenticazione dell'utente.
|
GetThreadReadState |
---|
Restituisce i dettagli sullo stato di lettura di un utente all'interno di un thread, utilizzati per identificare i messaggi letti e da leggere. Per un esempio, vedi Ottenere dettagli sullo stato di lettura dei thread di un utente. Richiede l'autenticazione dell'utente.
|
ListMemberships |
---|
Elenca le iscrizioni in uno spazio. Per un esempio, vedi Elencare gli utenti e le app Google Chat in uno spazio. L'elenco degli abbonamenti con autenticazione app elenca le iscrizioni agli spazi a cui l'app Chat ha accesso, ma esclude le iscrizioni all'app Chat, incluse le sue. L'elenco delle iscrizioni con Autenticazione utente elenca le iscrizioni negli spazi a cui l'utente autenticato ha accesso. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.
|
ListMessages |
---|
Elenca i messaggi presenti in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da spazi e membri bloccati. 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,
|
ListReactions |
---|
Elenca le reazioni a un messaggio. Per un esempio, vedi Elencare le reazioni a un messaggio. Richiede l'autenticazione dell'utente.
|
ListSpaceEvents |
---|
Elenca gli eventi da uno spazio di Google Chat. Per ogni evento, il payload contiene la versione più recente della risorsa di Chat. Ad esempio, se elenchi eventi relativi a nuovi membri dello spazio, il server restituisce Richiede l'autenticazione utente. Per elencare gli eventi, l'utente autenticato deve essere membro dello spazio. Per un esempio, consulta Elenco di eventi da uno spazio di Google Chat.
|
ListSpaces |
---|
Elenca gli spazi di cui l'utente che chiama è membro. Le chat di gruppo e i messaggi diretti non vengono elencati finché non viene inviato il primo messaggio. Per un esempio, vedi Elencare gli spazi. Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione utente. Elenca gli spazi visibili al chiamante o all'utente autenticato. Le chat di gruppo e i messaggi diretti non vengono elencati finché non viene inviato il primo messaggio. Per elencare tutti gli spazi denominati per organizzazione Google Workspace, utilizza il metodo
|
SearchSpaces |
---|
use_admin_access su true .
|
SetUpSpace |
---|
Crea uno spazio e vi aggiunge utenti specificati. L'utente che chiama viene aggiunto automaticamente allo spazio e non deve essere specificato come iscrizione nella richiesta. Per un esempio, vedi Configurare uno spazio con membri iniziali. Per specificare i membri umani da aggiungere, aggiungi le adesioni con l' Per specificare i gruppi Google da aggiungere, aggiungi le iscrizioni con il Per uno spazio denominato o una chat di gruppo, se il chiamante blocca, è bloccato da alcuni membri o non dispone dell'autorizzazione per aggiungere alcuni membri, questi membri non verranno aggiunti allo spazio creato. Per creare un messaggio diretto (DM) tra l'utente che chiama e un altro utente, specifica esattamente un'appartenenza per rappresentare l'utente. Se un utente blocca l'altro, la richiesta non va a buon fine e il messaggio diretto non viene creato. Per creare un messaggio diretto tra l'utente che chiama e l'app per la chiamata, imposta Se esiste già un messaggio diretto tra due utenti, anche quando un utente blocca l'altro quando viene effettuata una richiesta, viene restituito il messaggio diretto esistente. Gli spazi con risposte in thread non sono supportati. Se ricevi il messaggio di errore Richiede l'autenticazione dell'utente.
|
UpdateMembership |
---|
Aggiorna un abbonamento. Per un esempio, vedi Aggiornare le iscrizioni di un utente a uno spazio. Richiede l'autenticazione dell'utente.
|
UpdateMessage |
---|
Aggiorna un messaggio. C'è una differenza tra i metodi Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione utente. Quando utilizzi l'autenticazione delle app, le richieste possono aggiornare solo i messaggi creati dall'app Chat che chiama.
|
UpdateSpace |
---|
Aggiorna uno spazio. Ad esempio, vedi Aggiornare uno spazio. Se aggiorni il campo Richiede l'autenticazione dell'utente.
|
UpdateSpaceReadState |
---|
Aggiorna lo stato di lettura di un utente all'interno di uno spazio, utilizzato per identificare i messaggi letti e da leggere. Ad esempio, vedi Aggiornare lo stato di lettura dello spazio di un utente. Richiede l'autenticazione dell'utente.
|
AccessoryWidget
Uno o più widget interattivi che vengono visualizzati nella parte inferiore di un messaggio. Per maggiori dettagli, vedi Aggiungere widget interattivi nella parte inferiore di un messaggio.
Campi | |
---|---|
Campo unione action . Il tipo di azione. action può essere solo uno dei seguenti: |
|
button_list |
Un elenco di pulsanti. |
ActionResponse
Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta.
Campi | |
---|---|
type |
Solo input. Il tipo di risposta dell'app di Chat. |
url |
Solo input. URL per l'autenticazione o la configurazione da parte degli utenti. (Solo per i tipi di risposta |
dialog_action |
Solo input. Una risposta a un evento di interazione relativo a una finestra di dialogo. Deve essere accompagnato da |
updated_widget |
Solo input. La risposta del widget aggiornato. |
ResponseType
Il tipo di risposta dell'app di Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Tipo predefinito gestito come NEW_MESSAGE . |
NEW_MESSAGE |
Pubblica come nuovo messaggio nell'argomento. |
UPDATE_MESSAGE |
Aggiorna il messaggio dell'app Chat. Questa operazione è consentita solo in un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT . |
UPDATE_USER_MESSAGE_CARDS |
Aggiornare le schede nel messaggio di un utente. Ciò è consentito solo in risposta a un evento MESSAGE con un URL corrispondente o a un evento CARD_CLICKED in cui il tipo di mittente del messaggio è HUMAN . Il testo viene ignorato. |
REQUEST_CONFIG |
Chiedi privatamente all'utente un'ulteriore autenticazione o configurazione. |
DIALOG |
Apre una finestra di dialogo. |
UPDATE_WIDGET |
Query delle opzioni di completamento automatico del testo del widget. |
SelectionItems
Elenco dei risultati del completamento automatico del widget.
Campi | |
---|---|
items[] |
Un array di oggetti SelectionItem. |
UpdatedWidget
La risposta del widget aggiornato. Utilizzato per fornire opzioni di completamento automatico per un widget.
Campi | |
---|---|
widget |
L'ID del widget aggiornato. L'ID deve corrispondere a quello del widget che ha attivato la richiesta di aggiornamento. |
Campo unione updated_widget . Il widget è stato aggiornato in risposta a un'azione dell'utente. updated_widget può essere solo uno dei seguenti: |
|
suggestions |
Elenco dei risultati di completamento automatico del widget |
ActionStatus
Rappresenta lo stato di una richiesta per richiamare o inviare una finestra di dialogo.
Campi | |
---|---|
status_code |
Il codice di stato. |
user_facing_message |
Il messaggio per inviare agli utenti lo stato della loro richiesta. Se il criterio non viene configurato, viene inviato un messaggio generico basato sul valore |
Annotazione
Solo output. Annotazioni associate al corpo in testo normale del messaggio. Per aggiungere la formattazione di base a un messaggio di testo, vedi Formattare i messaggi di testo.
Esempio di corpo del messaggio di testo normale:
Hello @FooBot how are you!"
I metadati delle annotazioni corrispondenti:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Campi | |
---|---|
type |
Il tipo di questa annotazione. |
length |
Lunghezza della sottostringa nel corpo del messaggio in testo normale a cui corrisponde questa annotazione. |
start_index |
Indice iniziale (in base 0, incluso) nel corpo del messaggio in testo normale a cui corrisponde questa annotazione. |
Campo unione metadata . Metadati aggiuntivi sull'annotazione. metadata può essere solo uno dei seguenti: |
|
user_mention |
I metadati della menzione dell'utente. |
slash_command |
I metadati per un comando slash. |
rich_link_metadata |
I metadati per un link avanzato. |
AnnotationType
Tipo di annotazione.
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valore predefinito per l'enum. Non utilizzare. |
USER_MENTION |
Viene menzionato un utente. |
SLASH_COMMAND |
Viene richiamato un comando slash. |
RICH_LINK |
Un'annotazione con rich link. |
AttachedGif
Un'immagine GIF specificata da un URL.
Campi | |
---|---|
uri |
Solo output. L'URL che ospita l'immagine GIF. |
Allegato
Un allegato in Google Chat.
Campi | |
---|---|
name |
Nome risorsa dell'allegato, nel formato |
content_name |
Solo output. Il nome file originale per i contenuti, non il percorso completo. |
content_type |
Solo output. Il tipo di contenuti (tipo MIME) del file. |
thumbnail_uri |
Solo output. L'URL della miniatura che deve essere utilizzato per visualizzare l'anteprima dell'allegato a un utente umano. Le app di chat non devono utilizzare questo URL per scaricare i contenuti degli allegati. |
download_uri |
Solo output. L'URL di download che deve essere utilizzato per consentire a un utente di scaricare l'allegato. Le app di chat non devono utilizzare questo URL per scaricare i contenuti degli allegati. |
source |
Solo output. L'origine dell'allegato. |
Campo unione data_ref . Il riferimento dati all'allegato. data_ref può essere solo uno dei seguenti: |
|
attachment_data_ref |
Un riferimento ai dati degli allegati. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati. |
drive_data_ref |
Solo output. Un riferimento all'allegato di Google Drive. Questo campo viene utilizzato con l'API Google Drive. |
Origine
L'origine dell'allegato.
Enum | |
---|---|
SOURCE_UNSPECIFIED |
Riservato. |
DRIVE_FILE |
Il file è un file di Google Drive. |
UPLOADED_CONTENT |
Il file viene caricato su Chat. |
AttachmentDataRef
Un riferimento ai dati degli allegati.
Campi | |
---|---|
resource_name |
Il nome risorsa dei dati degli allegati. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati. |
attachment_upload_token |
Token opaco contenente un riferimento a un allegato caricato. Trattati dai client come una stringa opaca e utilizzata per creare o aggiornare i messaggi di Chat con allegati. |
CardWithId
Una scheda in un messaggio di Google Chat.
Solo le app di chat possono creare schede. Se la tua app Chat si autentica come utente, il messaggio non può contenere schede.
Progettare e visualizzare l'anteprima delle schede con il generatore di schede.
Apri il generatore di schedeCampi | |
---|---|
card_id |
Obbligatorio se il messaggio contiene più schede. Identificatore univoco di una scheda in un messaggio. |
card |
Una scheda. La dimensione massima è 32 kB. |
ChatSpaceLinkData
Dati per i link agli spazi di Chat.
Campi | |
---|---|
space |
Lo spazio della risorsa dello spazio di Chat collegata. Formato: |
thread |
Il thread della risorsa dello spazio di Chat collegata. Formato: |
message |
Il messaggio della risorsa dello spazio di Chat collegata. Formato: |
CompleteImportSpaceRequest
Messaggio di richiesta per il completamento del processo di importazione di uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dello spazio in modalità di importazione. Formato: |
CompleteImportSpaceResponse
Messaggio di risposta per il completamento del processo di importazione di uno spazio.
Campi | |
---|---|
space |
Lo spazio in modalità di importazione. |
ContextualAddOnMarkup
Questo tipo non contiene campi.
Il markup che consente agli sviluppatori di specificare i contenuti di un componente aggiuntivo contestuale.
Scheda
Una scheda è un elemento UI che può contenere widget UI come testo e immagini.
Campi | |
---|---|
header |
L'intestazione della scheda. Un'intestazione di solito contiene un titolo e un'immagine. |
sections[] |
Le sezioni sono separate da un separatore di linea. |
card_actions[] |
Le azioni di questa scheda. |
name |
Nome della carta. |
CardAction
Un'azione della scheda è l'azione associata alla scheda. Per una scheda fattura, un'azione tipica è: elimina la fattura, invia una fattura via email o apri la fattura nel browser.
Non supportata dalle app Google Chat.
Campi | |
---|---|
action_label |
L'etichetta che veniva visualizzata nella voce del menu azione. |
on_click |
L'azione YAML per questa attività. |
CardHeader
Campi | |
---|---|
title |
È necessario specificare il titolo. L'intestazione ha un'altezza fissa: se sono specificati sia un titolo che un sottotitolo, ciascuno occupa una riga. Se viene specificato solo il titolo, questo occupa entrambe le righe. |
subtitle |
Il sottotitolo dell'intestazione della scheda. |
image_style |
Il tipo di immagine (ad esempio bordo quadrato o bordo circolare). |
image_url |
L'URL dell'immagine nell'intestazione della scheda. |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Bordo quadrato. |
AVATAR |
Bordo circolare. |
Sezione
Una sezione contiene una raccolta di widget che vengono visualizzati (verticalmente) nell'ordine in cui sono specificati. Su tutte le piattaforme, le schede hanno una larghezza fissa fissa, quindi al momento non sono necessarie le proprietà di layout (ad esempio, mobile).
Campi | |
---|---|
header |
L'intestazione della sezione. Il testo formattato è supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace. |
widgets[] |
Una sezione deve contenere almeno un widget. |
CreateMembershipRequest
Messaggio di richiesta per la creazione di un'iscrizione.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio per il quale creare l'appartenenza. Formato: workspace/{space} |
membership |
Obbligatorio. La relazione di appartenenza da creare. Il campo |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 La creazione di abbonamenti alle app o di abbonamenti per utenti esterni all'organizzazione Google Workspace dell'amministratore non è supportata con l'accesso amministrativo. |
CreateMessageRequest
Crea un messaggio.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio in cui creare un messaggio. Formato: |
message |
Obbligatorio. Corpo del messaggio. |
thread_key |
(Facoltativo) Deprecato: utilizza |
request_id |
(Facoltativo) Un ID richiesta univoco per questo messaggio. Se viene specificato un ID richiesta esistente, viene restituito il messaggio creato con quell'ID anziché crearne uno nuovo. |
message_reply_option |
(Facoltativo) Specifica se un messaggio avvia un thread o risponde a un thread. Supportato solo negli spazi con un nome. |
message_id |
(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 Il valore di questo campo deve soddisfare i seguenti requisiti:
Per maggiori dettagli, vedi Assegnare un nome a un messaggio. |
MessageReplyOption
Specifica come rispondere a un messaggio. In futuro potrebbero essere aggiunti altri stati.
Enum | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Predefinita. Avvia un nuovo thread. Se utilizzi questa opzione, i valori thread ID o inclusi vengono ignorati. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Crea il messaggio come risposta al thread specificato da thread ID o . Se non riesce, il messaggio avvia un nuovo thread. |
REPLY_MESSAGE_OR_FAIL |
Crea il messaggio come risposta al thread specificato da thread ID o . Se viene utilizzato un nuovo thread_key , viene creato un nuovo thread. Se la creazione del messaggio non riesce, viene restituito un errore NOT_FOUND . |
CreateReactionRequest
Crea una reazione a un messaggio.
Campi | |
---|---|
parent |
Obbligatorio. Il messaggio in cui viene creata la reazione. Formato: |
reaction |
Obbligatorio. La reazione da creare. |
CreateSpaceRequest
Una richiesta per creare uno spazio senza membri.
Campi | |
---|---|
space |
Obbligatorio. I campi Se viene visualizzato il messaggio di errore Se fai parte del programma Anteprima per gli sviluppatori, è possibile utilizzare Lo spazio |
request_id |
(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app di Chat con un utente autenticato diverso, viene restituito un errore. |
CustomEmoji
Rappresenta un'emoji personalizzata.
Campi | |
---|---|
uid |
Solo output. Chiave univoca per la risorsa di emoji personalizzate. |
DeleteMembershipRequest
Richiedere l'eliminazione di un'appartenenza a uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'appartenenza da eliminare. Le app di chat possono eliminare i propri abbonamenti o quelli degli utenti umani. Le app di chat non possono eliminare altre app di abbonamento. Quando elimini un abbonamento di una persona, sono richiesti l'ambito Quando elimini un abbonamento a un'app, sono necessari l'ambito Formato: |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 L'eliminazione delle iscrizioni alle app in uno spazio non è supportata con l'accesso amministrativo. |
DeleteMessageRequest
Richiesta di eliminazione di un messaggio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa del messaggio. Formato: Se hai impostato un ID personalizzato per il tuo messaggio, puoi utilizzare il valore del campo |
force |
Quando Si applica solo in caso di autenticazione come utente. Non ha effetto durante l'autenticazione come app di Chat. |
DeleteReactionRequest
Elimina una reazione a un messaggio.
Campi | |
---|---|
name |
Obbligatorio. Nome della reazione da eliminare. Formato: |
DeleteSpaceRequest
Richiesta di eliminazione di uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome risorsa dello spazio da eliminare. Formato: |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 |
DeletionMetadata
Informazioni su un messaggio eliminato. Viene eliminato un messaggio impostando delete_time
.
Campi | |
---|---|
deletion_type |
Indica chi ha eliminato il messaggio. |
DeletionType
Chi ha eliminato il messaggio e come.
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Questo valore non è utilizzato. |
CREATOR |
L'utente ha eliminato il proprio messaggio. |
SPACE_OWNER |
Il proprietario dello spazio ha eliminato il messaggio. |
ADMIN |
Un amministratore di Google Workspace ha eliminato il messaggio. |
APP_MESSAGE_EXPIRY |
Un'app di Chat ha eliminato il proprio messaggio alla scadenza. |
CREATOR_VIA_APP |
Un'app di Chat ha eliminato il messaggio per conto dell'utente. |
SPACE_OWNER_VIA_APP |
Un'app di Chat ha eliminato il messaggio per conto del proprietario dello spazio. |
Dialog
Wrapper intorno al corpo della scheda della finestra di dialogo.
Campi | |
---|---|
body |
Solo input. Corpo della finestra di dialogo, visualizzato in modalità modale. Le app Google Chat non supportano le seguenti entità delle carte: |
DialogAction
Contiene una finestra di dialogo e un codice di stato della richiesta.
Campi | |
---|---|
action_status |
Solo input. Stato di una richiesta per richiamare o inviare una finestra di dialogo. Se necessario, mostra uno stato e un messaggio agli utenti. Ad esempio, in caso di errore o riuscita. |
Campo unione action . Azione da eseguire. action può essere solo uno dei seguenti: |
|
dialog |
Solo input. Finestra di dialogo per la richiesta. |
DriveDataRef
Un riferimento ai dati di un collegamento di Drive.
Campi | |
---|---|
drive_file_id |
L'ID del file di Drive. Da utilizzare con l'API Drive. |
DriveLinkData
Dati per i link di Google Drive.
Campi | |
---|---|
drive_data_ref |
Un DriveDataRef che fa riferimento a un file di Google Drive. |
mime_type |
Il tipo MIME della risorsa di Google Drive collegata. |
Emoji
Un'emoji utilizzata come reazione a un messaggio.
Campi | |
---|---|
Campo unione content . I contenuti dell'emoji. content può essere solo uno dei seguenti: |
|
unicode |
Un'emoji di base rappresentata da una stringa Unicode. |
custom_emoji |
Solo output. Un'emoji personalizzata. |
EmojiReactionSummary
Il numero di persone che hanno reagito a un messaggio con un'emoji specifica.
Campi | |
---|---|
emoji |
Emoji associate alle reazioni. |
reaction_count |
Il numero totale di reazioni utilizzando l'emoji associata. |
FindDirectMessageRequest
Una richiesta per ottenere uno spazio di messaggi diretti basata sulla risorsa utente.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'utente con cui trovare il messaggio diretto. Formato: |
GetAttachmentRequest
Richiedi un allegato.
Campi | |
---|---|
name |
Obbligatorio. Nome risorsa dell'allegato, nel formato |
GetMembershipRequest
Richiedi l'iscrizione a uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'appartenenza da recuperare. Per usufruire dell'abbonamento all'app utilizzando l'autenticazione utente, puoi facoltativamente utilizzare Formato: Dopo aver eseguito l'autenticazione come utente, puoi utilizzare l'email dell'utente come alias per |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede gli ambiti OAuth 2.0 L'acquisto di abbonamenti a un'app in uno spazio non è supportato se si utilizza l'accesso amministrativo. |
GetMessageRequest
Richiedi di ricevere un messaggio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa del messaggio. Formato: Se hai impostato un ID personalizzato per il tuo messaggio, puoi utilizzare il valore del campo |
GetSpaceEventRequest
Richiedi un messaggio per ricevere un evento dello spazio.
Campi | |
---|---|
name |
Obbligatorio. Il nome della risorsa dell'evento dello spazio. Formato: |
GetSpaceReadStateRequest
Messaggio di richiesta per l'API GetSpaceReadState.
Campi | |
---|---|
name |
Obbligatorio. Nome risorsa dello stato di lettura dello spazio da recuperare. Supporta solo il recupero dello stato di lettura per l'utente chiamante. Per fare riferimento all'utente chiamante, imposta una delle seguenti opzioni:
Formato: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Richiesta per restituire un singolo spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome risorsa dello spazio, nel formato Formato: |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede gli ambiti OAuth 2.0 |
GetThreadReadStateRequest
Messaggio di richiesta per l'API GetThreadReadStateRequest.
Campi | |
---|---|
name |
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:
Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Gruppo
Un gruppo Google in Google Chat.
Campi | |
---|---|
name |
Nome della risorsa per un gruppo Google. Rappresenta un gruppo nell'API Cloud Identity Groups. Formato: groups/{group} |
HistoryState
Lo stato della cronologia per i messaggi e gli spazi. Specifica per quanto tempo vengono conservati i messaggi e i thread di conversazione dopo la creazione.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
HISTORY_OFF |
Cronologia disattivata. I messaggi e i thread vengono conservati per 24 ore. |
HISTORY_ON |
Cronologia attivata. Le regole di conservazione di Vault dell'organizzazione specificano la durata di conservazione dei messaggi e dei thread. |
ListMembershipsRequest
Messaggio di richiesta relativo alla scheda degli abbonamenti.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio per il quale recuperare un elenco di membri. Formato: spaces/{space} |
page_size |
(Facoltativo) Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non specificato, vengono restituite al massimo 100 abbonamenti. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000. I valori negativi restituiscono un errore |
page_token |
(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata per elencare le appartenenze. Fornisci questo parametro per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti. |
filter |
(Facoltativo) Un filtro delle query. Puoi filtrare le iscrizioni in base al ruolo ( Per filtrare in base al ruolo, imposta Per filtrare per tipo, imposta Per filtrare sia in base al ruolo che al tipo, utilizza l'operatore Se Ad esempio, le seguenti query sono valide:
Le seguenti query non sono valide:
Le query non valide vengono rifiutate dal server con un errore |
show_groups |
(Facoltativo) Quando |
show_invited |
(Facoltativo) Quando Attualmente richiede l'autenticazione dell'utente. |
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 Se si utilizza l'accesso amministrativo, non è possibile elencare gli abbonamenti all'app in uno spazio. |
ListMembershipsResponse
Risposta all'elenco dei membri dello spazio.
Campi | |
---|---|
memberships[] |
Elenco non ordinato. Elenco degli abbonamenti nella pagina richiesta (o nella prima). |
next_page_token |
Un token che puoi inviare come |
ListMessagesRequest
Elenca i messaggi nello spazio specificato di cui l'utente è membro.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio da cui elencare i messaggi. Formato: |
page_size |
Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire meno messaggi di questo valore. Se non specificato, vengono restituiti al massimo 25. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000. I valori negativi restituiscono un errore |
page_token |
Facoltativo, se riprendi da una query precedente. Un token di pagina ricevuto da una precedente chiamata di messaggi dell'elenco. Fornisci questo parametro per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti. |
filter |
Un filtro di query. Puoi filtrare i messaggi per data ( Per filtrare i messaggi in base alla data di creazione, specifica Per filtrare in base al thread, specifica il valore Per filtrare sia in base al thread che alla data, utilizza l'operatore Ad esempio, le seguenti query sono valide:
Le query non valide vengono rifiutate dal server con un errore |
order_by |
Facoltativo, se riprendi da una query precedente. Ordinamento dell'elenco dei messaggi. Specifica un valore da ordinare tramite un'operazione di ordinamento. I valori validi per le operazioni di ordinamento sono i seguenti:
L'ordine predefinito è |
show_deleted |
Se includere i messaggi eliminati. I messaggi eliminati includono l'ora e i metadati relativi alla loro eliminazione, ma i contenuti dei messaggi non sono disponibili. |
ListMessagesResponse
Messaggio di risposta relativo ai messaggi dell'elenco.
Campi | |
---|---|
messages[] |
Elenco dei messaggi. |
next_page_token |
Puoi inviare un token come |
ListReactionsRequest
Elenca le reazioni a un messaggio.
Campi | |
---|---|
parent |
Obbligatorio. Il messaggio a cui gli utenti hanno reagito. Formato: |
page_size |
(Facoltativo) Il numero massimo di reazioni restituite. Il servizio può restituire meno reazioni di questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200. superiori a 200 vengono modificati in 200. |
page_token |
(Facoltativo) (se riprendi da una query precedente). Un token di pagina ricevuto da una precedente chiamata di reazioni dell'elenco. Forniscilo per recuperare la pagina successiva. Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti. |
filter |
(Facoltativo) Un filtro di query. Puoi filtrare le reazioni per emoji ( Per filtrare le reazioni per più emoji o utenti, unisci campi simili con l'operatore Per filtrare le reazioni per emoji e utente, utilizza l'operatore Se la query utilizza sia Ad esempio, le seguenti query sono valide:
Le seguenti query non sono valide:
Le query non valide vengono rifiutate dal server con un errore |
ListReactionsResponse
Risposta a una richiesta di reazioni in elenco.
Campi | |
---|---|
reactions[] |
Elenco delle reazioni nella pagina richiesta (o nella prima). |
next_page_token |
Token di continuazione per recuperare la pagina dei risultati successiva. È vuota per l'ultima pagina dei risultati. |
ListSpaceEventsRequest
Messaggio di richiesta per la scheda degli eventi dello spazio.
Campi | |
---|---|
parent |
Obbligatorio. Nome della risorsa dello spazio di Google Chat in cui si sono verificati gli eventi. Formato: |
page_size |
(Facoltativo) Il numero massimo di eventi dello spazio restituiti. Il servizio potrebbe restituire un valore inferiore a questo valore. I valori negativi restituiscono un errore |
page_token |
Un token di pagina, ricevuto da una precedente chiamata di eventi dello spazio elenco. Forniscilo per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti. |
filter |
Obbligatorio. Un filtro di query. Devi specificare almeno un tipo di evento ( Se vuoi, puoi anche filtrare in base all'ora di inizio (
Per specificare un'ora di inizio o di fine, utilizza l'operatore Ad esempio, le seguenti query sono valide:
Le seguenti query non sono valide:
Le query non valide vengono rifiutate dal server con un errore |
ListSpaceEventsResponse
Messaggio di risposta relativo alla creazione di una scheda per gli eventi dello spazio.
Campi | |
---|---|
space_events[] |
I risultati vengono restituiti in ordine cronologico (dall'evento meno recente). |
next_page_token |
Token di continuazione utilizzato per recuperare più eventi. Se questo campo viene omesso, non verranno visualizzate altre pagine. |
ListSpacesRequest
Una richiesta per elencare gli spazi di cui il chiamante è membro.
Campi | |
---|---|
page_size |
(Facoltativo) Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non specificati, vengono restituiti al massimo 100 spazi. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000. I valori negativi restituiscono un errore |
page_token |
(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata agli spazi di elenco. Fornisci questo parametro per recuperare la pagina successiva. Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso può portare a risultati imprevisti. |
filter |
(Facoltativo) Un filtro delle query. Puoi filtrare gli spazi in base al tipo ( Per filtrare in base al tipo di spazio, devi specificare un valore enum valido, come Ad esempio, le seguenti query sono valide:
Le query non valide vengono rifiutate dal server con un errore |
ListSpacesResponse
La risposta per una richiesta di elenchi spazi.
Campi | |
---|---|
spaces[] |
Elenco degli spazi nella pagina richiesta (o nella prima). |
next_page_token |
Puoi inviare un token come |
MatchedUrl
Un URL corrispondente in un messaggio di Chat. Le app di chat possono visualizzare l'anteprima degli URL corrispondenti. Per ulteriori informazioni, consulta la sezione Link di anteprima.
Campi | |
---|---|
url |
Solo output. L'URL corrispondente. |
Abbonamento
Rappresenta una relazione di adesione in Google Chat, ad esempio se un utente o un'app di Chat è invitato a uno spazio, se ne fa parte o se è assente.
Campi | |
---|---|
name |
Nome risorsa dell'appartenenza, assegnato dal server. Formato: |
state |
Solo output. Stato dell'abbonamento. |
role |
(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 |
create_time |
(Facoltativo) Immutabile. L'ora di creazione dell'abbonamento, ad esempio quando un membro si è unito o è stato invitato a partecipare a uno spazio. Questo campo viene solo generato, tranne quando viene utilizzato per importare le appartenenze storiche negli spazi in modalità di importazione. |
delete_time |
(Facoltativo) Immutabile. La data e l'ora di eliminazione dell'abbonamento, ad esempio quando un membro ha abbandonato uno spazio o è stato rimosso. Questo campo viene solo generato, tranne quando viene utilizzato per importare le appartenenze storiche negli spazi in modalità di importazione. |
Campo unione memberType . Membro associato a questo abbonamento. In futuro potrebbero essere supportati altri tipi di membri. memberType può essere solo uno dei seguenti: |
|
member |
L'utente o l'app di Google Chat a cui corrisponde l'abbonamento. Se l'app Chat si autentica come utente, l'output compila i campi utente |
group_member |
Il gruppo Google a cui corrisponde l'iscrizione. |
MembershipRole
Rappresenta le azioni consentite di un utente in uno spazio di Chat. In futuro potrebbero essere aggiunti altri valori enum.
Enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Valore predefinito. users : non è membro dello spazio, ma può essere invitato. Per Google Groups : viene sempre assegnato questo ruolo (in futuro potrebbero essere utilizzati altri valori enum). |
ROLE_MEMBER |
Un membro dello spazio. L'utente dispone delle autorizzazioni di base, come l'invio di messaggi allo spazio. Nelle conversazioni 1:1 e senza nome, tutti hanno questo ruolo. |
ROLE_MANAGER |
Un gestore dello spazio. L'utente dispone di tutte le autorizzazioni di base, oltre alle autorizzazioni amministrative che gli consentono di gestire lo spazio, come l'aggiunta o la rimozione di membri. Supportata solo nel seguente paese: SpaceType.SPACE . |
MembershipState
Specifica la relazione del membro con uno spazio. In futuro potrebbero essere supportati altri stati di appartenenza.
Enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
JOINED |
L'utente viene aggiunto allo spazio e può partecipare allo spazio. |
INVITED |
L'utente è stato invitato a partecipare allo spazio, ma non l'ha ancora fatto. |
NOT_A_MEMBER |
L'utente non appartiene allo spazio e non ha un invito in attesa per partecipare allo spazio. |
MembershipBatchCreatedEventData
Payload dell'evento per più nuove iscrizioni.
Tipo di evento: google.workspace.chat.membership.v1.batchCreated
Campi | |
---|---|
memberships[] |
Un elenco dei nuovi abbonamenti. |
MembershipBatchDeletedEventData
Payload dell'evento per più appartenenze eliminate.
Tipo di evento: google.workspace.chat.membership.v1.batchDeleted
Campi | |
---|---|
memberships[] |
Un elenco delle iscrizioni eliminate. |
MembershipBatchUpdatedEventData
Payload dell'evento per più appartenenze aggiornate.
Tipo di evento: google.workspace.chat.membership.v1.batchUpdated
Campi | |
---|---|
memberships[] |
Un elenco degli abbonamenti aggiornati. |
MembershipCreatedEventData
Payload dell'evento per una nuova appartenenza.
Tipo di evento: google.workspace.chat.membership.v1.created
.
Campi | |
---|---|
membership |
Il nuovo abbonamento. |
MembershipDeletedEventData
Payload dell'evento per un'appartenenza eliminata.
Tipo di evento: google.workspace.chat.membership.v1.deleted
Campi | |
---|---|
membership |
L'abbonamento eliminato. Vengono compilati solo i campi |
MembershipUpdatedEventData
Payload dell'evento per un'appartenenza aggiornata.
Tipo di evento: google.workspace.chat.membership.v1.updated
Campi | |
---|---|
membership |
L'abbonamento aggiornato. |
Messaggio
Un messaggio in uno spazio di Google Chat.
Campi | |
---|---|
name |
Nome della risorsa del messaggio. Formato: dove Se imposti un ID personalizzato durante la creazione di un messaggio, puoi utilizzarlo per specificarlo in una richiesta sostituendo |
sender |
Solo output. L'utente che ha creato il messaggio. Se l'app Chat si autentica come utente, l'output compila i campi utente |
create_time |
(Facoltativo) Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo viene solo generato, tranne quando viene utilizzato negli spazi in modalità di importazione. Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui è stato creato il messaggio nell'origine per conservare l'ora di creazione originale. |
last_update_time |
Solo output. L'ultima modifica del messaggio da parte di un utente. Se il messaggio non è mai stato modificato, questo campo è vuoto. |
delete_time |
Solo output. L'ora in cui il messaggio è stato eliminato in Google Chat. Se il messaggio non viene mai eliminato, questo campo è vuoto. |
text |
Corpo del messaggio in testo normale. Il primo link a un'immagine, un video o una pagina web genera un chip di anteprima. Puoi anche @menzionare un utente di Google Chat o tutte le persone presenti nello spazio. Per ulteriori informazioni sulla creazione di messaggi di testo, vedi Inviare un messaggio. |
formatted_text |
Solo output. Contiene il messaggio
Per ulteriori informazioni, vedi Visualizzare la formattazione del testo inviata in un messaggio. |
cards[] |
Deprecato: usa invece Schede complete, formattate e interattive che puoi utilizzare per visualizzare elementi dell'interfaccia utente come testi formattati, pulsanti e immagini cliccabili. In genere le schede vengono visualizzate sotto il corpo in testo normale del messaggio. |
cards_v2[] |
Un array di schede. Solo le app di chat possono creare schede. Se la tua app Chat si autentica come utente, i messaggi non possono contenere schede. Per scoprire come creare un messaggio che contiene schede, vedi Inviare un messaggio. Progettare e visualizzare l'anteprima delle schede con il generatore di schede. Apri il generatore di schede |
annotations[] |
Solo output. Annotazioni associate all'elemento |
thread |
Il thread a cui appartiene il messaggio. Ad esempio, vedi Avviare o rispondere a un thread di messaggi. |
space |
Se l'app Chat si autentica come utente, l'output compila lo spazio |
fallback_text |
Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio per le notifiche su dispositivi mobili. |
action_response |
Solo input. Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta. |
argument_text |
Solo output. Corpo in testo normale del messaggio con tutte le menzioni dell'app Chat eliminate. |
slash_command |
Solo output. Informazioni sul comando slash, se applicabili. |
attachment[] |
Allegato caricato dall'utente. |
matched_url |
Solo output. Un URL in |
thread_reply |
Solo output. Quando Se lo spazio non supporta le risposte nei thread, questo campo è sempre |
client_assigned_message_id |
(Facoltativo) Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio o per ricevere, eliminare o aggiornare un messaggio. Per impostare un ID personalizzato, specifica il campo |
emoji_reaction_summaries[] |
Solo output. L'elenco di riepiloghi di reazioni emoji sul messaggio. |
private_message_viewer |
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 delle app e omettere quanto segue: Per maggiori dettagli, vedi Inviare un messaggio privato. |
deletion_metadata |
Solo output. Informazioni su un messaggio eliminato. Viene eliminato un messaggio impostando |
quoted_message_metadata |
Solo output. Informazioni su un messaggio citato da un utente di Google Chat in uno spazio. Gli utenti di Google Chat possono citare un messaggio per rispondere. |
attached_gifs[] |
Solo output. GIF allegate al messaggio. |
accessory_widgets[] |
Uno o più widget interattivi che vengono visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o testo e schede. Non supportata per i messaggi che contengono finestre di dialogo. Per maggiori dettagli, vedi Aggiungere widget interattivi nella parte inferiore di un messaggio. La creazione di un messaggio con widget accessori richiede l'autenticazione delle app. |
MessageBatchCreatedEventData
Payload dell'evento per più nuovi messaggi.
Tipo di evento: google.workspace.chat.message.v1.batchCreated
Campi | |
---|---|
messages[] |
Un elenco di nuovi messaggi. |
MessageBatchDeletedEventData
Payload dell'evento per più messaggi eliminati.
Tipo di evento: google.workspace.chat.message.v1.batchDeleted
Campi | |
---|---|
messages[] |
Un elenco di messaggi eliminati. |
MessageBatchUpdatedEventData
Payload dell'evento per più messaggi aggiornati.
Tipo di evento: google.workspace.chat.message.v1.batchUpdated
Campi | |
---|---|
messages[] |
Un elenco dei messaggi aggiornati. |
MessageCreatedEventData
Payload dell'evento per un nuovo messaggio.
Tipo di evento: google.workspace.chat.message.v1.created
Campi | |
---|---|
message |
Il nuovo messaggio. |
MessageDeletedEventData
Payload dell'evento per un messaggio eliminato.
Tipo di evento: google.workspace.chat.message.v1.deleted
Campi | |
---|---|
message |
Il messaggio eliminato. Vengono compilati solo i campi |
MessageUpdatedEventData
Payload dell'evento per un messaggio aggiornato.
Tipo di evento: google.workspace.chat.message.v1.updated
Campi | |
---|---|
message |
Il messaggio aggiornato. |
QuotedMessageMetadata
Informazioni su un messaggio citato.
Campi | |
---|---|
name |
Solo output. Nome della risorsa del messaggio tra virgolette. Formato: |
last_update_time |
Solo output. Timestamp di creazione del messaggio tra virgolette o ultimo aggiornamento del messaggio tra virgolette. |
Reazioni
Una reazione a un messaggio.
Campi | |
---|---|
name |
Il nome risorsa della reazione. Formato: |
user |
Solo output. L'utente che ha creato la reazione. |
emoji |
L'emoji utilizzata nella reazione. |
ReactionBatchCreatedEventData
Payload dell’evento per diverse nuove reazioni.
Tipo di evento: google.workspace.chat.reaction.v1.batchCreated
Campi | |
---|---|
reactions[] |
Un elenco di nuove reazioni. |
ReactionBatchDeletedEventData
Payload dell'evento per più reazioni eliminate.
Tipo di evento: google.workspace.chat.reaction.v1.batchDeleted
Campi | |
---|---|
reactions[] |
Un elenco di reazioni eliminate. |
ReactionCreatedEventData
Payload dell'evento per una nuova reazione.
Tipo di evento: google.workspace.chat.reaction.v1.created
Campi | |
---|---|
reaction |
La nuova reazione. |
ReactionDeletedEventData
Payload dell'evento per una reazione eliminata.
Tipo: google.workspace.chat.reaction.v1.deleted
Campi | |
---|---|
reaction |
La reazione eliminata. |
RichLinkMetadata
Un link avanzato a una risorsa.
Campi | |
---|---|
uri |
L'URI di questo link. |
rich_link_type |
Il tipo di link avanzato. |
Campo unione data . Dati relativi alla risorsa collegata. data può essere solo uno dei seguenti: |
|
drive_link_data |
Dati per un link di Drive. |
chat_space_link_data |
Dati per il link a uno spazio di Chat. |
RichLinkType
Il tipo di link avanzato. In futuro potrebbero essere aggiunti altri tipi.
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
DRIVE_FILE |
Un tipo di link avanzato di Google Drive. |
CHAT_SPACE |
Un tipo di link avanzato a uno spazio di Chat. Ad esempio, uno smart chip di spazio. |
SearchSpacesRequest
Richiesta di ricerca di un elenco di spazi in base a una query.
Campi | |
---|---|
use_admin_access |
Quando L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 Al momento questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo |
page_size |
Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non specificati, vengono restituiti al massimo 100 spazi. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000. |
page_token |
Un token, ricevuto dalla chiamata precedente agli spazi di ricerca. Fornisci questo parametro per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti. |
query |
Obbligatorio. Una query di ricerca. Puoi eseguire ricerche utilizzando i seguenti parametri:
In diversi campi sono supportati solo gli operatori Nello stesso campo, I seguenti esempi di query sono validi:
|
order_by |
(Facoltativo) Come viene ordinato l'elenco degli spazi. Gli attributi supportati per l'ordinamento sono:
I valori validi per le operazioni di ordinamento sono:
La sintassi supportata è:
|
SearchSpacesResponse
Risposta con un elenco di spazi corrispondenti alla richiesta di spazi di ricerca.
Campi | |
---|---|
spaces[] |
Una pagina degli spazi richiesti. |
next_page_token |
Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci saranno pagine successive. |
total_size |
Il numero totale di spazi che corrispondono alla query, in tutte le pagine. Se il risultato è superiore a 10.000 spazi, questo valore è una stima. |
SetUpSpaceRequest
Richiedi di creare uno spazio a cui aggiungere utenti specificati.
Campi | |
---|---|
space |
Obbligatorio. Il campo Per creare uno spazio, imposta Per creare una chat di gruppo, imposta Per creare una conversazione 1:1 tra persone, imposta Per creare una conversazione 1:1 tra una persona e l'app Chat per le chiamate, imposta Se esiste già uno spazio |
request_id |
(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app di Chat con un utente autenticato diverso, viene restituito un errore. |
memberships[] |
(Facoltativo) Gli utenti o i gruppi di Google Chat da invitare a partecipare allo spazio. Ometti l'utente chiamante poiché viene aggiunto automaticamente. L'impostazione attualmente consente fino a 20 abbonamenti (oltre al chiamante). Per l'appartenenza umana, il campo Per l'appartenenza a gruppi Google, il campo Facoltativo se imposti Obbligatorio quando si imposta Richiesto quando si imposta Deve essere vuoto durante la creazione di una conversazione 1:1 tra una persona e l'app Chat per le chiamate (se |
SlashCommand
Un comando con barra in Google Chat.
Campi | |
---|---|
command_id |
L'ID del comando slash richiamato. |
SlashCommandMetadata
Metadati di annotazione per i comandi slash (/).
Campi | |
---|---|
bot |
L'app Chat di cui è stato richiamato il comando. |
type |
Il tipo di comando slash. |
command_name |
Il nome del comando slash richiamato. |
command_id |
L'ID del comando slash richiamato. |
triggers_dialog |
Indica se il comando slash è riferito a una finestra di dialogo. |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
ADD |
Aggiungi l'app Chat allo spazio. |
INVOKE |
Richiama il comando slash nello spazio. |
Spazio
Uno spazio in Google Chat. Gli spazi sono conversazioni tra due o più utenti o messaggi 1:1 tra un utente e un'app di Chat.
Campi | |
---|---|
name |
Nome risorsa dello spazio. Formato: dove |
type |
Solo output. Deprecato: usa invece |
space_type |
Il tipo di spazio. Obbligatorio quando crei uno spazio o aggiorni il tipo di spazio di uno spazio. Output solo per altri utilizzi. |
single_user_bot_dm |
(Facoltativo) Indica se lo spazio è un messaggio diretto tra un'app di Chat e un singolo essere umano. |
threaded |
Solo output. Deprecato: usa invece |
display_name |
Il nome visualizzato dello spazio. Obbligatorio durante la creazione di uno spazio con Per i messaggi diretti, questo campo potrebbe essere vuoto. Supporta fino a 128 caratteri. |
external_user_allowed |
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:
Questo campo viene restituito solo per gli spazi esistenti. |
space_threading_state |
Solo output. Lo stato dei thread nello spazio di Chat. |
space_details |
Dettagli sullo spazio, tra cui descrizione e regole. |
space_history_state |
Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio. |
import_mode |
(Facoltativo) Indica se questo spazio è stato creato in |
create_time |
(Facoltativo) Immutabile. Per gli spazi creati in Chat, la data e l'ora di creazione dello spazio. Questo campo viene solo generato, tranne quando viene utilizzato negli spazi in modalità di importazione. Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui lo spazio è stato creato nell'origine per conservare l'ora di creazione originale. Compilato nell'output solo quando |
last_active_time |
Solo output. Timestamp dell'ultimo messaggio nello spazio. |
admin_installed |
Solo output. Per gli spazi di messaggi diretti (DM) con un'app di Chat, se lo spazio è stato creato da un amministratore di Google Workspace. Gli amministratori possono installare e configurare un messaggio diretto con un'app di Chat per conto degli utenti della loro organizzazione. Per supportare l'installazione da parte degli amministratori, l'app Chat deve includere la messaggistica diretta. |
membership_count |
Solo output. Il numero di abbonamenti uniti raggruppati per tipo di abbonamento. Compilato quando |
access_settings |
(Facoltativo) Specifica l'impostazione di accesso dello spazio. Compilato solo quando |
space_uri |
Solo output. L'URI di un utente per accedere allo spazio. |
Campo unione space_permission_settings . Rappresenta le impostazioni dell'autorizzazione di uno spazio. Compilato solo quando space_type è SPACE . space_permission_settings può essere solo uno dei seguenti: |
|
predefined_permission_settings |
(Facoltativo) Solo input. Impostazioni di autorizzazione dello spazio. Input per la creazione di uno spazio, se questo campo non viene impostato viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono compilate nel campo |
permission_settings |
(Facoltativo) Impostazioni di autorizzazione esatte che possono essere impostate per aggiornare lo spazio. Input per l'aggiornamento di uno spazio. In caso contrario, solo output. Per la creazione dello spazio, usa invece |
AccessSettings
Rappresenta l'impostazione di accesso dello spazio.
Campi | |
---|---|
access_state |
Solo output. Indica lo stato di accesso allo spazio. |
audience |
(Facoltativo) Il nome della risorsa del pubblico di destinazione che può scoprire lo spazio, partecipare allo spazio e visualizzare l'anteprima dei messaggi nello spazio. Se non è impostato, solo gli utenti o i gruppi Google che sono stati invitati o aggiunti singolarmente allo spazio possono accedervi. Per maggiori dettagli, vedi Rendere uno spazio rilevabile per un pubblico di destinazione. Formato: Per utilizzare il pubblico di destinazione predefinito per l'organizzazione Google Workspace, imposta |
AccessState
Rappresenta lo stato di accesso allo 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 da amministratori di Google Workspace possono rilevare e accedere allo spazio. |
DISCOVERABLE |
Un gestore dello spazio ha concesso l'accesso allo spazio a un pubblico di destinazione. Anche gli utenti o i gruppi Google che sono stati aggiunti o invitati singolarmente allo spazio possono scoprire lo spazio e accedervi. Per scoprire di più, vedi Rendere uno spazio rilevabile per utenti specifici. |
MembershipCount
Campi | |
---|---|
joined_direct_human_user_count |
Numero di utenti umani che sono entrati direttamente nello spazio, senza contare gli utenti che si sono uniti a un gruppo iscritto. |
joined_group_count |
Numero di tutti i gruppi che sono entrati direttamente nello spazio. |
PermissionSetting
Rappresenta un'impostazione di autorizzazione dello spazio.
Campi | |
---|---|
managers_allowed |
Indica se i gestori degli spazi hanno questa autorizzazione. |
members_allowed |
Indica se i membri non amministratori dispongono di questa autorizzazione. |
PermissionSettings
Impostazioni delle autorizzazioni per uno spazio denominato. Per configurare le impostazioni di autorizzazione quando crei uno spazio, specifica il campo PredefinedPermissionSettings
nella richiesta.
Campi | |
---|---|
manage_members_and_groups |
Impostazione per la gestione di membri e gruppi in uno spazio. |
modify_space_details |
Impostazione per l'aggiornamento del nome dello spazio, dell'avatar, della descrizione e delle linee guida. |
toggle_history |
Impostazione per attivare e disattivare la cronologia degli spazi. |
use_at_mention_all |
Impostazione per l'utilizzo di @tutti in uno spazio. |
manage_apps |
Impostazione per la gestione delle app in uno spazio. |
manage_webhooks |
Impostazione per la gestione dei webhook in uno spazio. |
post_messages |
Solo output. Impostazione per la pubblicazione di messaggi in uno spazio. |
reply_messages |
Impostazione per rispondere ai messaggi in uno spazio. |
PredefinedPermissionSettings
Le impostazioni delle autorizzazioni per lo spazio che puoi specificare quando crei uno spazio denominato. In futuro potrebbero essere aggiunte altre impostazioni. Per maggiori dettagli sulle impostazioni delle autorizzazioni per gli spazi denominati, vedi Scopri di più sugli spazi.
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Non specificato. Non utilizzare. |
COLLABORATION_SPACE |
Impostazione per rendere lo spazio uno spazio di collaborazione in cui tutti i membri possono pubblicare messaggi. |
ANNOUNCEMENT_SPACE |
Impostazione per rendere lo spazio uno spazio per gli annunci in cui solo i gestori dello spazio possono pubblicare messaggi. |
SpaceDetails
Dettagli sullo spazio, tra cui descrizione e regole.
Campi | |
---|---|
description |
(Facoltativo) Una descrizione dello spazio. Ad esempio, descrivi l'argomento di discussione, lo scopo funzionale o i partecipanti dello spazio. Supporta fino a 150 caratteri. |
guidelines |
(Facoltativo) Le regole, le aspettative e l'etichetta dello spazio. Supporta fino a 5000 caratteri. |
SpaceThreadingState
Specifica il tipo di stato dei thread nello spazio di Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Riservato. |
THREADED_MESSAGES |
Spazi con nome che supportano i thread di messaggi. Quando gli utenti rispondono a un messaggio, possono rispondere in thread, conservando la risposta nel contesto del messaggio originale. |
GROUPED_MESSAGES |
Spazi con nome in cui la conversazione è organizzata per argomento. Gli argomenti e le relative risposte vengono raggruppati insieme. |
UNTHREADED_MESSAGES |
Messaggi diretti tra due persone e conversazioni di gruppo tra tre o più persone. |
SpaceType
Il tipo di spazio. Obbligatorio quando crei o aggiorni uno spazio. Output solo per altri utilizzi.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Riservato. |
SPACE |
Un luogo in cui le persone inviano messaggi, condividono file e collaborano. Un SPACE può includere app di Chat. |
GROUP_CHAT |
Conversazioni di gruppo tra 3 o più persone. Un GROUP_CHAT può includere app di chat. |
DIRECT_MESSAGE |
Messaggi 1:1 tra due persone o una persona e un'app di Chat. |
Tipo
Deprecato: usa invece SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Riservato. |
ROOM |
Conversazioni tra due o più persone. |
DM |
Messaggio diretto 1:1 tra un utente e un'app di Chat, in cui tutti i messaggi sono piatti. Tieni presente che non sono inclusi i messaggi diretti tra due persone. |
SpaceBatchUpdatedEventData
Payload dell’evento per più aggiornamenti di uno spazio.
Tipo di evento: google.workspace.chat.space.v1.batchUpdated
Campi | |
---|---|
spaces[] |
Un elenco degli spazi aggiornati. |
SpaceEvent
Un evento che rappresenta una modifica o un'attività in uno spazio di Google Chat. Per scoprire di più, vedi Utilizzare gli eventi di Google Chat.
Campi | |
---|---|
name |
Nome risorsa dell'evento dello spazio. Formato: |
event_time |
L'ora in cui si è verificato l'evento. |
event_type |
Tipo di evento nello spazio. Ogni tipo di evento ha una versione batch, che rappresenta più istanze del tipo di evento che si verificano in un breve periodo di tempo. Per le richieste Tipi di eventi supportati per i messaggi:
Tipi di eventi supportati per gli abbonamenti:
Tipi di eventi supportati per le reazioni:
Tipi di eventi supportati per lo spazio:
|
Campo unione
|
|
message_created_event_data |
Payload dell'evento per un nuovo messaggio. Tipo di evento: |
message_updated_event_data |
Payload dell'evento per un messaggio aggiornato. Tipo di evento: |
message_deleted_event_data |
Payload dell'evento per un messaggio eliminato. Tipo di evento: |
message_batch_created_event_data |
Payload dell'evento per più nuovi messaggi. Tipo di evento: |
message_batch_updated_event_data |
Payload dell'evento per più messaggi aggiornati. Tipo di evento: |
message_batch_deleted_event_data |
Payload dell'evento per più messaggi eliminati. Tipo di evento: |
space_updated_event_data |
Payload dell'evento per un aggiornamento dello spazio. Tipo di evento: |
space_batch_updated_event_data |
Payload dell’evento per più aggiornamenti di uno spazio. Tipo di evento: |
membership_created_event_data |
Payload dell'evento per una nuova appartenenza. Tipo di evento: |
membership_updated_event_data |
Payload dell'evento per un'appartenenza aggiornata. Tipo di evento: |
membership_deleted_event_data |
Payload dell'evento per un'appartenenza eliminata. Tipo di evento: |
membership_batch_created_event_data |
Payload dell'evento per più nuove iscrizioni. Tipo di evento: |
membership_batch_updated_event_data |
Payload dell'evento per più appartenenze aggiornate. Tipo di evento: |
membership_batch_deleted_event_data |
Payload dell'evento per più appartenenze eliminate. Tipo di evento: |
reaction_created_event_data |
Payload dell'evento per una nuova reazione. Tipo di evento: |
reaction_deleted_event_data |
Payload evento per una reazione eliminata. Tipo di evento: |
reaction_batch_created_event_data |
Payload dell’evento per diverse nuove reazioni. Tipo di evento: |
reaction_batch_deleted_event_data |
Payload dell'evento per più reazioni eliminate. Tipo di evento: |
SpaceReadState
Lo stato di lettura di un utente all'interno di uno spazio, utilizzato per identificare i messaggi letti e da leggere.
Campi | |
---|---|
name |
Nome risorsa dello stato di lettura dello spazio. Formato: |
last_read_time |
(Facoltativo) L'ora in cui lo stato di lettura dello spazio dell'utente è stato aggiornato. Di solito corrisponde al timestamp dell'ultimo messaggio letto o a un timestamp specificato dall'utente per contrassegnare l'ultima posizione di lettura in uno spazio. |
SpaceUpdatedEventData
Payload evento per uno spazio aggiornato.
Tipo di evento: google.workspace.chat.space.v1.updated
Campi | |
---|---|
space |
Lo spazio aggiornato. |
Thread
Un thread in uno spazio di Google Chat. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.
Se specifichi un thread durante la creazione di un messaggio, puoi impostare il campo messageReplyOption
per determinare cosa succede se non viene trovato alcun thread corrispondente.
Campi | |
---|---|
name |
Nome risorsa del thread. Esempio: |
thread_key |
(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 dell'app Chat che lo imposta. Ad esempio, se più app di Chat creano un messaggio utilizzando la stessa chiave di thread, i messaggi vengono pubblicati in thread diversi. Per rispondere in un thread creato da una persona o da un'altra app di Chat, specifica invece il campo |
ThreadReadState
Lo stato di lettura di un utente all'interno di un thread, utilizzato per identificare i messaggi letti e da leggere.
Campi | |
---|---|
name |
Nome della risorsa dello stato di lettura del thread. Formato: |
last_read_time |
L'ora in cui è stato aggiornato lo stato di lettura del thread dell'utente. Di solito corrisponde al timestamp dell'ultimo messaggio letto in un thread. |
UpdateMembershipRequest
Messaggio di richiesta di aggiornamento di un abbonamento.
Campi | |
---|---|
membership |
Obbligatorio. L'abbonamento da aggiornare. Vengono aggiornati solo i campi specificati da |
update_mask |
Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza Percorsi dei campi attualmente supportati:
|
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l'ambito OAuth 2.0 |
UpdateMessageRequest
Richiedere l'aggiornamento di un messaggio.
Campi | |
---|---|
message |
Obbligatorio. Messaggio con campi aggiornati. |
update_mask |
Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza Percorsi dei campi attualmente supportati:
|
allow_missing |
(Facoltativo) Se |
UpdateSpaceReadStateRequest
Messaggio di richiesta per l'API UpdateSpaceReadState.
Campi | |
---|---|
space_read_state |
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:
Formato: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Obbligatorio. I percorsi dei campi da aggiornare. Percorsi dei campi attualmente supportati:
Quando Per contrassegnare lo spazio come letto, imposta |
UpdateSpaceRequest
Richiesta di aggiornamento di un singolo spazio.
Campi | |
---|---|
space |
Obbligatorio. Spazio con campi da aggiornare. |
update_mask |
Obbligatorio. I percorsi dei campi aggiornati, separati da virgole, se presenti. Puoi aggiornare i seguenti campi per uno spazio:
|
use_admin_access |
true , il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 Alcuni valori di |
Utente
Un utente di Google Chat. Quando viene restituito come output da una richiesta, se la tua app Chat si autentica come utente, l'output per una risorsa User
completa solo i valori name
e type
dell'utente.
Campi | |
---|---|
name |
Nome risorsa per Formato: Per
|
display_name |
Solo output. Il nome visualizzato dell'utente. |
domain_id |
L'identificatore univoco del dominio Google Workspace dell'utente. |
type |
Tipo di utente. |
is_anonymous |
Solo output. Quando |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. NON UTILIZZARE. |
HUMAN |
Utente umano. |
BOT |
Utente dell'app di chat. |
UserMentionMetadata
Metadati delle annotazioni per le menzioni degli utenti (@).
Campi | |
---|---|
user |
L'utente menzionato. |
type |
Il tipo di menzione dell'utente. |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
ADD |
Aggiungi utente allo spazio. |
MENTION |
Menziona l'utente nello spazio. |
WidgetMarkup
Un widget è un elemento dell'interfaccia utente che presenta testo e immagini.
Campi | |
---|---|
buttons[] |
Un elenco di pulsanti. Anche i pulsanti sono |
Campo unione data . Un WidgetMarkup può avere solo uno dei seguenti elementi. Puoi utilizzare più campi WidgetMarkup per visualizzare più elementi. data può essere solo uno dei seguenti: |
|
text_paragraph |
Visualizza un paragrafo di testo in questo widget. |
image |
Visualizza un'immagine in questo widget. |
key_value |
Visualizza un elemento chiave-valore in questo widget. |
Pulsante
Un pulsante. Può essere un pulsante di testo o un pulsante immagine.
Campi | |
---|---|
Campo unione
|
|
text_button |
Un pulsante con testo e azione di |
image_button |
Un pulsante con immagine e azione di |
FormAction
Un'azione del modulo descrive il comportamento quando viene inviato. Ad esempio, puoi chiamare Apps Script per gestire il modulo.
Campi | |
---|---|
action_method_name |
Il nome del metodo viene utilizzato per identificare quale parte del modulo ha attivato l'invio del modulo. Queste informazioni vengono riportate nell'app Chat come parte dell'evento di clic sulla scheda. Puoi utilizzare lo stesso nome di metodo per diversi elementi che attivano un comportamento comune. |
parameters[] |
Elenco dei parametri di azione. |
ActionParameter
Elenco di parametri stringa da fornire quando viene richiamato il metodo di azione. Ad esempio, considera tre pulsanti per posticiparla: Posticipa ora, Posticipa un giorno e Posticipa la prossima settimana. Puoi utilizzare action method = snooze()
, per trasmettere il tipo e il tempo di posticipazione nell'elenco dei parametri stringa.
Campi | |
---|---|
key |
Il nome del parametro per l'action script. |
value |
Il valore del parametro. |
Icona
L'insieme di icone supportate.
Enum | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
Immagine
Un'immagine che è specificata da un URL e può avere un'azione onclick
.
Campi | |
---|---|
image_url |
L'URL dell'immagine. |
on_click |
L'azione |
aspect_ratio |
Le proporzioni dell'immagine (larghezza e altezza). Questo campo ti consente di riservare l'altezza giusta per l'immagine in attesa del suo caricamento. Questa funzione non intende sostituire le proporzioni integrate dell'immagine. Se il criterio non viene configurato, il server lo riempie precaricando l'immagine. |
ImageButton
Un pulsante immagine con un'azione onclick
.
Campi | |
---|---|
on_click |
L'azione |
name |
Il nome di questo elemento |
Campo unione icons . L'icona può essere specificata da un Icon enum o da un URL. icons può essere solo uno dei seguenti: |
|
icon |
L'icona specificata da un |
icon_url |
L'icona specificata da un URL. |
KeyValue
Un elemento UI contiene una chiave (etichetta) e un valore (contenuti). Questo elemento può anche contenere alcune azioni, come il pulsante onclick
.
Campi | |
---|---|
top_label |
Il testo dell'etichetta in alto. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace. |
content |
Il testo dei contenuti. Testo formattato supportato e sempre obbligatorio. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace. |
content_multiline |
Se i contenuti devono essere su più righe. |
bottom_label |
Il testo dell'etichetta in basso. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace. |
on_click |
L'azione |
Campo unione icons . È necessario definire almeno una delle icone, top_label e bottom_label . icons può essere solo uno dei seguenti: |
|
icon |
Un valore enum sostituito dall'API Chat con l'immagine dell'icona corrispondente. |
icon_url |
L'icona specificata da un URL. |
Campo unione control . Un widget di controllo. Puoi impostare button o switch_widget , ma non entrambi. control può essere solo uno dei seguenti: |
|
button |
Un pulsante su cui è possibile fare clic per attivare un'azione. |
OnClick
Un'azione onclick
(ad esempio, aprire un link).
Campi | |
---|---|
Campo unione
|
|
action |
Un'azione del modulo viene attivata da questa azione |
open_link |
Questa azione |
OpenLink
Un link che apre una nuova finestra.
Campi | |
---|---|
url |
L'URL da aprire. |
TextButton
Un pulsante con testo e azione di onclick
.
Campi | |
---|---|
text |
Il testo del pulsante. |
on_click |
L'azione |
TextParagraph
Un paragrafo di testo. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.
Campi | |
---|---|
text |
|