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)CreateCustomEmojiRequest
(messaggio)CreateMembershipRequest
(messaggio)CreateMessageRequest
(messaggio)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(messaggio)CreateSpaceRequest
(messaggio)CustomEmoji
(messaggio)CustomEmoji.CustomEmojiPayload
(messaggio)DeleteCustomEmojiRequest
(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)GetCustomEmojiRequest
(messaggio)GetMembershipRequest
(messaggio)GetMessageRequest
(messaggio)GetSpaceEventRequest
(messaggio)GetSpaceNotificationSettingRequest
(messaggio)GetSpaceReadStateRequest
(messaggio)GetSpaceRequest
(messaggio)GetThreadReadStateRequest
(messaggio)Group
(messaggio)HistoryState
(enum)ListCustomEmojisRequest
(messaggio)ListCustomEmojisResponse
(messaggio)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)SpaceNotificationSetting
(messaggio)SpaceNotificationSetting.MuteSetting
(enum)SpaceNotificationSetting.NotificationSetting
(enum)SpaceReadState
(messaggio)SpaceUpdatedEventData
(messaggio)Thread
(messaggio)ThreadReadState
(messaggio)UpdateMembershipRequest
(messaggio)UpdateMessageRequest
(messaggio)UpdateSpaceNotificationSettingRequest
(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 la procedura di importazione per lo spazio specificato e lo rende visibile agli utenti. Richiede l'autenticazione dell'app e la delega a livello di dominio. Per saperne di più, vedi Autorizzare le app Google Chat a importare i dati.
|
CreateCustomEmoji |
---|
Richiede l'autenticazione utente.
|
CreateMembership |
---|
Crea un'appartenenza per l'app Chat che effettua la chiamata, un utente o un gruppo Google. La creazione di abbonamenti per altre app di chat non è supportata. Quando crei un abbonamento, se per il membro specificato è disattivata la norma di accettazione automatica, l'utente riceve l'invito e deve accettarlo prima di partecipare allo spazio. In caso contrario, la creazione di un abbonamento aggiunge il membro direttamente allo spazio specificato. Supporta i seguenti tipi di autenticazione:
Per esempi di utilizzo, consulta:
|
CreateMessage |
---|
Crea un messaggio in uno spazio di Google Chat. Per un esempio, vedi Inviare un messaggio. Il metodo L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione dell'app. Chat mostra l'app Chat come mittente del messaggio. I contenuti del messaggio possono includere testo ( L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione utente. Chat mostra l'utente come mittente del messaggio e attribuisce l'app Chat al messaggio mostrando il relativo nome. Il contenuto del messaggio può contenere solo testo ( Le dimensioni massime del messaggio, inclusi i contenuti, sono 32.000 byte.
|
CreateReaction |
---|
Crea una reazione e la aggiunge a un messaggio. Sono supportati solo gli emoji Unicode. Per un esempio, consulta Aggiungere una reazione a un messaggio. Richiede l'autenticazione utente.
|
CreateSpace |
---|
Crea uno spazio. Può essere utilizzato per creare uno spazio denominato o una chat di gruppo in Supporta i seguenti tipi di autenticazione: Quando esegui l'autenticazione come app, il campo L'appartenenza allo spazio al momento della creazione dipende dal fatto che lo spazio sia stato creato in
Se ricevi il messaggio di errore
|
DeleteCustomEmoji |
---|
Richiede l'autenticazione utente.
|
DeleteMembership |
---|
Consente di eliminare un abbonamento. Per un esempio, consulta Rimuovere un utente o un'app Google Chat da uno spazio. Supporta i seguenti tipi di autenticazione:
|
DeleteMessage |
---|
Elimina un messaggio. Per un esempio, vedi Eliminare un messaggio. Supporta i seguenti tipi di autenticazione: Quando utilizzi l'autenticazione dell'app, le richieste possono eliminare solo i messaggi creati dall'app Chat che effettua la chiamata.
|
DeleteReaction |
---|
Consente di eliminare una reazione a un messaggio. Sono supportati solo gli emoji Unicode. Per un esempio, vedi Eliminare una reazione. Richiede l'autenticazione utente.
|
DeleteSpace |
---|
Consente di eliminare uno spazio denominato. Esegue sempre un'eliminazione a cascata, il che significa che vengono eliminate anche le risorse secondarie dello spazio, come i messaggi pubblicati nello spazio e le iscrizioni allo spazio. Per un esempio, consulta Eliminare uno spazio. Supporta i seguenti tipi di autenticazione:
|
FindDirectMessage |
---|
Restituisce il messaggio diretto esistente con l'utente specificato. Se non viene trovato uno spazio per i messaggi diretti, viene restituito un errore Con l'autenticazione dell'app, restituisce lo spazio dei 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:
|
GetAttachment |
---|
Recupera i metadati di un allegato del messaggio. I dati degli allegati vengono recuperati utilizzando l'API media. Per un esempio, vedi Ottenere i metadati di un allegato di un messaggio. Richiede l'autenticazione dell'app.
|
GetCustomEmoji |
---|
Richiede l'autenticazione utente.
|
GetMembership |
---|
Restituisce i dettagli di un abbonamento. Per un esempio, vedi Ottenere i dettagli sull'abbonamento di un utente o dell'app Google Chat. Supporta i seguenti tipi di autenticazione:
|
GetMessage |
---|
Restituisce i dettagli di un messaggio. Per un esempio, vedi Ottenere i dettagli di un messaggio. Supporta i seguenti tipi di autenticazione: Nota: potrebbe essere restituito un messaggio da uno spazio o un membro bloccato.
|
GetSpace |
---|
Restituisce i dettagli di uno spazio. Per un esempio, vedi Visualizzare i dettagli di uno spazio. Supporta i seguenti tipi di autenticazione:
|
GetSpaceEvent |
---|
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 successivamente aggiornato, il server restituisce la risorsa Nota: il campo Richiede l'autenticazione utente. Per ricevere un evento, l'utente autenticato deve essere un membro dello spazio. Per un esempio, vedi Ottenere i dettagli di un evento da uno spazio di Google Chat.
|
GetSpaceNotificationSetting |
---|
Richiede l'autenticazione utente.
|
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 i dettagli sullo stato di lettura dello spazio di un utente. Richiede l'autenticazione utente.
|
GetThreadReadState |
---|
Restituisce i dettagli sullo stato di lettura di un utente all'interno di un thread, utilizzati per identificare i messaggi letti e non letti. Per un esempio, vedi Ottenere i dettagli sullo stato di lettura del thread di un utente. Richiede l'autenticazione utente.
|
ListCustomEmojis |
---|
Richiede l'autenticazione utente.
|
ListMemberships |
---|
Elenca le iscrizioni a uno spazio. Per un esempio, vedi Elenca gli utenti e le app Google Chat in uno spazio. L'elenco dei membri con autenticazione app elenca i membri degli spazi a cui ha accesso l'app Chat, ma esclude i membri dell'app Chat, inclusi i suoi. L'elenco delle iscrizioni con Autenticazione utente elenca le iscrizioni negli spazi a cui l'utente autenticato ha accesso. Supporta i seguenti tipi di autenticazione:
|
ListMessages |
---|
Elenca i messaggi di uno spazio di cui l'utente che ha effettuato la chiamata è membro, inclusi i messaggi di 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, Richiede l'autenticazione utente.
|
ListReactions |
---|
Elenca le reazioni a un messaggio. Per un esempio, vedi Elenca le reazioni per un messaggio. Richiede l'autenticazione utente.
|
ListSpaceEvents |
---|
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 eventi relativi ai nuovi membri dello spazio, il server restituisce risorse Richiede l'autenticazione utente. Per elencare gli eventi, l'utente autenticato deve essere un 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, consulta Elenca gli spazi. Supporta i seguenti tipi di autenticazione: Per elencare tutti gli spazi denominati per organizzazione Google Workspace, utilizza il metodo
|
SearchSpaces |
---|
Restituisce un elenco di spazi in un'organizzazione Google Workspace in base alla ricerca di un amministratore. È richiesta l'autenticazione utente con privilegi di amministratore. Nella richiesta, imposta
|
SetUpSpace |
---|
Crea uno spazio e aggiunge gli utenti specificati. L'utente che effettua la chiamata viene aggiunto automaticamente allo spazio e non deve essere specificato come appartenenza nella richiesta. Per un esempio, consulta Configurare uno spazio con i 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 l' Per uno spazio denominato o una chat di gruppo, se chi chiama blocca o viene bloccato da alcuni membri oppure non dispone dell'autorizzazione per aggiungerne alcuni, questi membri non vengono 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 effettua la chiamata e l'app di chiamata, imposta Se tra due utenti esiste già un messaggio diretto, 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 Richiede l'autenticazione utente.
|
UpdateMembership |
---|
Aggiorna un abbonamento. Per un esempio, vedi Aggiornare l'appartenenza di un utente a uno spazio. Supporta i seguenti tipi di autenticazione:
|
UpdateMessage |
---|
Aggiorna un messaggio. Esiste una differenza tra i metodi Supporta i seguenti tipi di autenticazione: Quando utilizzi l'autenticazione dell'app, le richieste possono aggiornare solo i messaggi creati dall'app Chat chiamante.
|
UpdateSpace |
---|
Aggiorna uno spazio. Per un esempio, vedi Aggiornare uno spazio. Se stai aggiornando il campo Supporta i seguenti tipi di autenticazione:
|
UpdateSpaceNotificationSetting |
---|
Richiede l'autenticazione utente.
|
UpdateSpaceReadState |
---|
Aggiorna lo stato di lettura di un utente all'interno di uno spazio, utilizzato per identificare i messaggi letti e da leggere. Per un esempio, vedi Aggiornare lo stato di lettura dello spazio di un utente. Richiede l'autenticazione utente.
|
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: |
|
button_ |
Un elenco di pulsanti. |
ActionResponse
Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la sua risposta.
Campi | |
---|---|
type |
Solo input. Il tipo di risposta dell'app Chat. |
url |
Solo input. URL per l'autenticazione o la configurazione degli utenti. (Solo per i tipi di risposta |
dialog_ |
Solo input. Una risposta a un evento di interazione relativo a una finestra di dialogo. Deve essere accompagnato da |
updated_ |
Solo input. La risposta del widget aggiornato. |
ResponseType
Il tipo di risposta dell'app Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Tipo predefinito gestito come NEW_MESSAGE . |
NEW_MESSAGE |
Pubblica un nuovo messaggio nell'argomento. |
UPDATE_MESSAGE |
Aggiorna il messaggio dell'app Chat. Questo è consentito solo in un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT . |
UPDATE_USER_MESSAGE_CARDS |
Aggiorna le schede del messaggio di un utente. Questo è consentito 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 all'utente di effettuare un'autenticazione o una configurazione aggiuntiva in privato. |
DIALOG |
Mostra una finestra di dialogo. |
UPDATE_WIDGET |
Query sulle 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 di chiamata o invio di una finestra di dialogo.
Campi | |
---|---|
status_ |
Il codice di stato. |
user_ |
Il messaggio da inviare agli utenti sullo stato della loro richiesta. Se non è impostato, viene inviato un messaggio generico basato su |
Annotazione
Solo output. Annotazioni associate al corpo in testo normale del messaggio. 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 |
Il tipo di annotazione. |
length |
Lunghezza della sottostringa nel corpo del messaggio in testo normale a cui corrisponde questa annotazione. |
start_ |
Indice iniziale (da 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_ |
I metadati della menzione dell'utente. |
slash_ |
I metadati di un comando slash. |
rich_ |
I metadati di 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 di link avanzata. |
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 |
Facoltativo. Nome della risorsa dell'allegato, nel formato |
content_ |
Solo output. Il nome file originale dei contenuti, non il percorso completo. |
content_ |
Solo output. Il tipo di contenuto (tipo MIME) del file. |
thumbnail_ |
Solo output. L'URL della miniatura da utilizzare per visualizzare l'anteprima dell'allegato a un utente. Le app di chat non devono utilizzare questo URL per scaricare i contenuti degli allegati. |
download_ |
Solo output. L'URL di download da utilizzare 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 ai dati dell'allegato. data_ref può essere solo uno dei seguenti: |
|
attachment_ |
Facoltativo. Un riferimento ai dati dell'allegato. Questo campo viene utilizzato per creare o aggiornare i messaggi con gli allegati o con l'API Media per scaricare i dati degli allegati. |
drive_ |
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 in Chat. |
AttachmentDataRef
Un riferimento ai dati dell'allegato.
Campi | |
---|---|
resource_ |
Facoltativo. Il nome della risorsa dei dati dell'allegato. Questo campo viene utilizzato con l'API Media per scaricare i dati degli allegati. |
attachment_ |
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 di Chat con allegati. |
CardWithId
Una scheda in un messaggio di Google Chat.
Solo le app di Chat possono creare schede. Se l'app Chat si autentica come utente, il messaggio non può contenere schede.
Progetta e visualizza l'anteprima delle schede con lo strumento per la creazione di schede.
Apri lo strumento per la creazione di schedeCampi | |
---|---|
card_ |
Obbligatorio se il messaggio contiene più schede. Un identificatore univoco per 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 collegato. Formato: |
thread |
Il thread della risorsa dello spazio di Chat collegata. Formato: |
message |
Il messaggio della risorsa dello spazio di Chat collegato. Formato: |
CompleteImportSpaceRequest
Messaggio di richiesta per completare la procedura 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 per consentire agli sviluppatori di specificare i contenuti di un componente aggiuntivo contestuale.
Scheda
Una scheda è un elemento dell'interfaccia utente che può contenere widget dell'interfaccia utente 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 divisore di riga. |
card_ |
Le azioni di questa scheda. |
name |
Nome della scheda. |
CardAction
Un'azione della scheda è l'azione associata alla scheda. Per una scheda di fattura, un'azione tipica potrebbe essere: elimina fattura, invia fattura via email o apri la fattura nel browser.
Non supportato dalle app Google Chat.
Campi | |
---|---|
action_ |
In precedenza, l'etichetta veniva visualizzata nell'elemento del menu Azione. |
on_ |
L'azione onclick per questo elemento dell'azione. |
CardHeader
Campi | |
---|---|
title |
Il titolo deve essere specificato. 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_ |
Il tipo di immagine (ad esempio, bordo quadrato o bordo circolare). |
image_ |
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 ristretta, pertanto al momento non sono necessarie proprietà di layout (ad esempio float).
Campi | |
---|---|
header |
L'intestazione della sezione. Il testo formattato è supportato. Per saperne di più sulla formattazione del testo, vedi Formattare il testo nelle app Google Chat e Formattare il testo nei componenti aggiuntivi di Google Workspace. |
widgets[] |
Una sezione deve contenere almeno un widget. |
CreateCustomEmojiRequest
Una richiesta di creazione di un'emoji personalizzata.
Campi | |
---|---|
custom_ |
Obbligatorio. L'emoji personalizzata da creare. |
CreateMembershipRequest
Messaggio di richiesta per la creazione di un abbonamento.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio per cui creare l'appartenenza. Formato: spaces/{space} |
membership |
Obbligatorio. La relazione di appartenenza da creare. Il campo Quando un'app di chat crea una relazione di appartenenza per un utente umano, deve utilizzare determinati ambiti di autorizzazione e impostare valori specifici per determinati campi:
L'invito di utenti esterni all'organizzazione Workspace proprietaria dello spazio richiede l'autenticazione utente. Quando un'app di chat crea una relazione di appartenenza per se stessa, deve autenticarsi come utente e utilizzare l'ambito |
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l' 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_ |
Facoltativo. Un ID richiesta univoco per questo messaggio. Se specifichi un ID richiesta esistente, viene restituito il messaggio creato con quell'ID anziché crearne uno nuovo. |
message_ |
Facoltativo. Specifica se un messaggio avvia un thread o risponde a uno. Supportato 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 nuovo thread. |
message_ |
Facoltativo. Un ID personalizzato per un messaggio. Consente alle app di Chat di recuperare, aggiornare o eliminare un messaggio senza dover memorizzare 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, vengono ignorati tutti i valori thread ID o inclusi. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Crea il messaggio come risposta al thread specificato da thread ID o . In caso di errore, 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 va a buon fine, 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 di creazione di uno spazio denominato senza membri.
Campi | |
---|---|
space |
Obbligatorio. I campi Se ricevi il messaggio di errore Lo spazio |
request_ |
Facoltativo. Un identificatore univoco per questa richiesta. È consigliabile utilizzare un UUID casuale. Se specifichi 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 Chat con un utente autenticato diverso, viene restituito un errore. |
CustomEmoji
Rappresenta un'emoji personalizzata.
Campi | |
---|---|
name |
Identificatore. Il nome della risorsa dell'emoji personalizzata, assegnato dal server. Formato: |
uid |
Solo output. Chiave univoca per la risorsa emoji personalizzata. |
emoji_ |
Facoltativo. Immutabile. Nome fornito dall'utente per l'emoji personalizzata, che deve essere univoco all'interno dell'organizzazione. Obbligatorio quando viene creata l'emoji personalizzata, altrimenti solo output. I nomi delle emoji devono iniziare e terminare con due punti, devono essere in lettere minuscole 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: |
temporary_ |
Solo output. L'URL dell'immagine 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 |
Facoltativo. Solo input. Dati del payload. Obbligatorio quando viene creata l'emoji personalizzata. |
CustomEmojiPayload
Dati del payload per l'emoji personalizzata.
Campi | |
---|---|
file_ |
Obbligatorio. Solo input. L'immagine utilizzata per l'emoji personalizzata. Il payload deve essere inferiore a 256 KB e le dimensioni dell'immagine devono essere comprese tra 64 e 500 pixel. Le limitazioni sono soggette a modifica. |
filename |
Obbligatorio. Solo input. Il nome del file immagine. Estensioni file supportate: |
DeleteCustomEmojiRequest
Richiesta di eliminazione di un'emoji personalizzata.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'emoji personalizzata da eliminare. Formato: Puoi utilizzare il nome dell'emoji come alias per |
DeleteMembershipRequest
Richiedere l'eliminazione di un abbonamento a uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'abbonamento da eliminare. Le app di chat possono eliminare i propri abbonamenti o quelli degli utenti umani. Le app di chat non possono eliminare gli abbonamenti di altre app. Quando elimini un abbonamento di una persona, sono richiesti l'ambito Quando elimini un abbonamento a un'app, sono richiesti l'ambito Formato: |
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l' L'eliminazione delle iscrizioni alle app in uno spazio non è supportata con l'accesso amministrativo. |
DeleteMessageRequest
Richiedi di eliminare un messaggio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa del messaggio. Formato: Se hai impostato un ID personalizzato per il messaggio, puoi utilizzare il valore del campo |
force |
Facoltativo. Quando è Si applica solo quando l'autenticazione avviene come utente. Non ha alcun effetto quando si esegue l'autenticazione come app di chat. |
DeleteReactionRequest
Consente di eliminare 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 della risorsa dello spazio da eliminare. Formato: |
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l' |
DeletionMetadata
Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato delete_time
.
Campi | |
---|---|
deletion_ |
Indica chi ha eliminato il messaggio. |
DeletionType
Chi ha eliminato il messaggio e come è stato eliminato. In futuro potrebbero essere aggiunti altri valori.
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 Chat ha eliminato il messaggio per conto dell'utente. |
SPACE_OWNER_VIA_APP |
Un'app Chat ha eliminato il messaggio per conto del proprietario dello spazio. |
Dialog
Contenitore del corpo della scheda della finestra di dialogo.
Campi | |
---|---|
body |
Solo input. Testo della finestra di dialogo, visualizzato in una finestra modale. Le app Google Chat non supportano le seguenti entità di schede: |
DialogAction
Contiene un dialogo e il codice di stato della richiesta.
Campi | |
---|---|
action_ |
Solo input. Stato di una richiesta di chiamata o invio di una finestra di dialogo. Mostra uno stato e un messaggio agli utenti, se necessario. Ad esempio, in caso di errore o esito positivo. |
Campo unione action . Azione da eseguire. action può essere solo uno dei seguenti: |
|
dialog |
Solo input. Dialogo per la richiesta. |
DriveDataRef
Un riferimento ai dati di un allegato di Drive.
Campi | |
---|---|
drive_ |
L'ID del file di Drive. Da utilizzare con l'API Drive. |
DriveLinkData
Dati per i link di Google Drive.
Campi | |
---|---|
drive_ |
Un DriveDataRef che fa riferimento a un file di Google Drive. |
mime_ |
Il tipo MIME della risorsa di Google Drive collegata. |
Emoji
Un'emoji usata come reazione a un messaggio.
Campi | |
---|---|
Campo unione content . Obbligatorio. Il contenuto dell'emoji. content può essere solo uno dei seguenti: |
|
unicode |
Facoltativo. Un'emoji di base rappresentata da una stringa Unicode. |
custom_ |
Solo output. Un'emoji personalizzata. |
EmojiReactionSummary
Il numero di persone che hanno reagito a un messaggio con un'emoji specifica.
Campi | |
---|---|
emoji |
Solo output. Emoji associate alle reazioni. |
reaction_ |
Solo output. Il numero totale di reazioni che utilizzano l'emoji associata. |
FindDirectMessageRequest
Una richiesta per ottenere spazio per i messaggi diretti in base alla risorsa utente.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'utente con cui trovare il messaggio diretto. Formato: |
GetAttachmentRequest
Richiedi di ricevere un allegato.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'allegato, nel formato |
GetCustomEmojiRequest
Una richiesta di restituzione di una singola emoji personalizzata.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'emoji personalizzata. Formato: Puoi utilizzare il nome dell'emoji come alias per |
GetMembershipRequest
Richiedere l'abbonamento a uno spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dell'abbonamento da recuperare. Per ottenere l'abbonamento dell'app utilizzando l'autenticazione utente, puoi eventualmente utilizzare Formato: Puoi utilizzare l'indirizzo email dell'utente come alias per |
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede gli ambiti OAuth 2.0 L'ottenimento degli abbonamenti alle app in uno spazio non è supportato quando 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 messaggio, puoi utilizzare il valore del campo |
GetSpaceEventRequest
Messaggio di richiesta per ricevere un evento dello spazio.
Campi | |
---|---|
name |
Obbligatorio. Il nome della risorsa dell'evento dello spazio. Formato: |
GetSpaceNotificationSettingRequest
Richiedi un messaggio per ricevere l'impostazione di notifica dello spazio. Supporta solo l'impostazione di notifica per l'utente che chiama.
Campi | |
---|---|
name |
Obbligatorio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Messaggio di richiesta per l'API GetSpaceReadState.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dello stato di lettura dello spazio da recuperare. Supporta solo l'ottenimento dello stato di lettura per l'utente che chiama. Per fare riferimento all'utente che chiama, imposta una delle seguenti opzioni:
Formato: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Una richiesta di restituzione di un singolo spazio.
Campi | |
---|---|
name |
Obbligatorio. Nome della risorsa dello spazio, nel formato Formato: |
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. 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 l'ottenimento dello stato di lettura per l'utente che chiama. Per fare riferimento all'utente che chiama, 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 messaggi e spazi. Specifica per quanto tempo conservare i messaggi e i thread di conversazione dopo la creazione.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
HISTORY_OFF |
Cronologia disattivata. Messaggi e 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 di restituzione di un elenco di emoji personalizzate.
Campi | |
---|---|
page_ |
Facoltativo. Il numero massimo di emoji personalizzate restituite. Il servizio può restituire meno emoji personalizzate di questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200; i valori superiori a 200 vengono modificati in 200. |
page_ |
Facoltativo. (Se riprendi da una query precedente). Un token di pagina ricevuto da una precedente chiamata dell'emoji personalizzata dell'elenco. Fornisci questo valore per recuperare la pagina successiva. Quando viene visualizzata la paginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token pagina. Se passi un valore diverso, potresti ottenere risultati imprevisti. |
filter |
Facoltativo. Un filtro per query. Supporta i filtri per creator. Per filtrare in base al creator, devi specificare un valore valido. Al momento, solo Ad esempio, la seguente query restituisce l'emoji personalizzata creata dall'utente che ha effettuato la chiamata:
Le query non valide vengono rifiutate dal server con un errore |
ListCustomEmojisResponse
Una risposta a un elenco di emoji personalizzate.
Campi | |
---|---|
custom_ |
Elenco non ordinato. Elenco di emoji personalizzate nella pagina richiesta (o prima). |
next_ |
Un token che puoi inviare come |
ListMembershipsRequest
Richiedi un messaggio per l'inserimento degli abbonamenti.
Campi | |
---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio per cui recuperare un elenco di membri. Formato: spaces/{space} |
page_ |
Facoltativo. Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire meno di questo valore. Se non specificato, vengono restituiti al massimo 100 abbonamenti. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000. I valori negativi restituiscono un errore |
page_ |
Facoltativo. Un token di pagina ricevuto da una chiamata precedente per elencare le iscrizioni. Specifica questo parametro per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token pagina. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti. |
filter |
Facoltativo. Un filtro per query. Puoi filtrare le iscrizioni in base al ruolo ( Per filtrare per ruolo, imposta Per filtrare per tipo, imposta Per filtrare in base a ruolo e tipo, 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 |
show_ |
Facoltativo. Se |
show_ |
Facoltativo. Quando Al momento è richiesta l'autenticazione dell'utente. |
use_ |
Facoltativo. Se 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 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[] |
Elenco non ordinato. Elenco degli abbonamenti nella pagina richiesta (o prima). |
next_ |
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_ |
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 |
page_ |
Facoltativo. Un token di pagina ricevuto da una precedente chiamata dell'elenco dei messaggi. Specifica questo parametro per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token pagina. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti. |
filter |
Facoltativo. Un filtro per query. Puoi filtrare i messaggi per data ( Per filtrare i messaggi in base alla data di creazione, specifica Per filtrare per thread, specifica Per filtrare in base sia 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_ |
Facoltativo. L'ordinamento dell'elenco dei messaggi. Specifica un valore da ordinare in base a un'operazione di ordinamento. I valori validi per l'operazione di ordinamento sono:
L'ordinamento predefinito è |
show_ |
Facoltativo. Se includere i messaggi eliminati. I messaggi eliminati includono l'ora di eliminazione e i metadati relativi all'eliminazione, ma i contenuti dei messaggi non sono disponibili. |
ListMessagesResponse
Messaggio di risposta per i messaggi della scheda.
Campi | |
---|---|
messages[] |
Elenco di messaggi. |
next_ |
Puoi inviare un token come |
ListReactionsRequest
Elenca le reazioni a un messaggio.
Campi | |
---|---|
parent |
Obbligatorio. Il messaggio a cui gli utenti hanno aggiunto una reazione. Formato: |
page_ |
Facoltativo. Il numero massimo di reazioni restituite. Il servizio può restituire meno reazioni rispetto a questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200; i valori superiori a 200 vengono modificati in 200. |
page_ |
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. Quando viene visualizzata la paginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token pagina. Se passi un valore diverso, potresti ottenere risultati imprevisti. |
filter |
Facoltativo. Un filtro per 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 elenco di reazioni.
Campi | |
---|---|
reactions[] |
Elenco delle reazioni nella pagina richiesta (o prima). |
next_ |
Token di continuazione per recuperare la pagina successiva dei risultati. È vuoto per l'ultima pagina dei risultati. |
ListSpaceEventsRequest
Richiedi un messaggio per elencare gli eventi dello spazio.
Campi | |
---|---|
parent |
Obbligatorio. Nome della risorsa dello spazio di Google Chat in cui si sono verificati gli eventi. Formato: |
page_ |
Facoltativo. Il numero massimo di eventi spazio restituiti. Il servizio potrebbe restituire meno di questo valore. I valori negativi restituiscono un errore |
page_ |
Facoltativo. Un token di pagina ricevuto da una precedente chiamata di eventi dello spazio elenco. Fornisci questo valore per recuperare la pagina successiva. Quando esegui la paginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token pagina. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti. |
filter |
Obbligatorio. Un filtro per query. Devi specificare almeno un tipo di evento ( Se vuoi, puoi anche filtrare per ora di inizio (
Per specificare un'ora di inizio o di fine, utilizza l'operatore è uguale a 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 per la visualizzazione degli eventi dello spazio.
Campi | |
---|---|
space_ |
I risultati vengono restituiti in ordine cronologico (primo evento meno recente). Nota: il campo |
next_ |
Token di continuazione utilizzato per recuperare altri eventi. Se questo campo viene omesso, non verranno visualizzate altre pagine. |
ListSpacesRequest
Una richiesta di elenco degli spazi di cui l'utente che chiama è membro.
Campi | |
---|---|
page_ |
Facoltativo. Il numero massimo di spazi da restituire. Il servizio potrebbe restituire meno di questo valore. Se non 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 |
page_ |
Facoltativo. Un token di pagina ricevuto da una precedente chiamata di elenco di spazi. Specifica questo parametro per recuperare la pagina successiva. Quando viene visualizzata la paginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token pagina. Se passi un valore diverso, potresti ottenere risultati imprevisti. |
filter |
Facoltativo. Un filtro per query. Puoi filtrare gli spazi in base al tipo di spazio ( Per filtrare in base al tipo di spazio, devi specificare un valore enumerato valido, ad esempio Ad esempio, le seguenti query sono valide:
Le query non valide vengono rifiutate dal server con un errore |
ListSpacesResponse
La risposta a una richiesta di elenco di spazi.
Campi | |
---|---|
spaces[] |
Elenco di spazi nella pagina richiesta (o prima). Nota: il campo |
next_ |
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 saperne di più, consulta Visualizzare l'anteprima dei link.
Campi | |
---|---|
url |
Solo output. L'URL a cui è stata trovata una corrispondenza. |
Abbonamento
Rappresenta una relazione di appartenenza in Google Chat, ad esempio se un utente o un'app di Chat è invitato a uno spazio, ne fa parte o è assente.
Campi | |
---|---|
name |
Identificatore. Nome della risorsa dell'abbonamento, 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 come input solo in |
create_ |
Facoltativo. Immutabile. La data e l'ora di creazione dell'abbonamento, ad esempio quando un membro si è unito o è stato invitato a partecipare a uno spazio. Questo campo è solo di output, tranne quando viene utilizzato per importare gli abbonamenti storici negli spazi in modalità di importazione. |
delete_ |
Facoltativo. Immutabile. La data e l'ora dell'eliminazione dell'abbonamento, ad esempio quando un membro è uscito o è stato rimosso da uno spazio. Questo campo è solo di output, tranne quando viene utilizzato per importare gli abbonamenti storici negli spazi in modalità di importazione. |
Campo unione memberType . Membro associato a questo abbonamento. In futuro potrebbero essere supportati altri tipi di abbonati. memberType può essere solo uno dei seguenti: |
|
member |
Facoltativo. L'utente o l'app Google Chat a cui corrisponde l'appartenenza. Se la tua app di chat si autentica come utente, l'output compila |
group_ |
Facoltativo. Il gruppo Google a cui corrisponde l'appartenenza. La lettura o la modifica delle iscrizioni per Google Gruppi richiede l'autenticazione dell'utente. |
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 è membro dello spazio, ma può essere invitato. Per Google Groups : a questo ruolo viene sempre assegnato questo ruolo (in futuro potrebbero essere utilizzati altri valori di enum). |
ROLE_MEMBER |
Un membro dello spazio. L'utente dispone di autorizzazioni di base, come l'invio di messaggi allo spazio. Nelle conversazioni 1:1 e di gruppo senza nome, tutti hanno questo ruolo. |
ROLE_MANAGER |
Un gestore dello spazio. L'utente dispone di tutte le autorizzazioni di base, oltre a quelle amministrative che gli consentono di gestire lo spazio, ad esempio aggiungere o rimuovere membri. Supportato solo in SpaceType.SPACE . |
MembershipState
Specifica la relazione del membro con uno spazio. In futuro potrebbero essere supportati altri stati dell'abbonamento.
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 lo ha ancora fatto. |
NOT_A_MEMBER |
L'utente non appartiene allo spazio e non ha un invito in attesa per partecipare. |
MembershipBatchCreatedEventData
Payload dell'evento per più nuovi abbonamenti.
Tipo di evento: google.workspace.chat.membership.v1.batchCreated
Campi | |
---|---|
memberships[] |
Un elenco di nuovi abbonamenti. |
MembershipBatchDeletedEventData
Payload dell'evento per più abbonamenti eliminati.
Tipo di evento: google.workspace.chat.membership.v1.batchDeleted
Campi | |
---|---|
memberships[] |
Un elenco di abbonamenti eliminati. |
MembershipBatchUpdatedEventData
Payload dell'evento per più abbonamenti aggiornati.
Tipo di evento: google.workspace.chat.membership.v1.batchUpdated
Campi | |
---|---|
memberships[] |
Un elenco di abbonamenti aggiornati. |
MembershipCreatedEventData
Payload evento per un nuovo abbonamento.
Tipo di evento: google.workspace.chat.membership.v1.created
.
Campi | |
---|---|
membership |
Il nuovo abbonamento. |
MembershipDeletedEventData
Payload evento per un abbonamento eliminato.
Tipo di evento: google.workspace.chat.membership.v1.deleted
Campi | |
---|---|
membership |
L'abbonamento eliminato. Vengono compilati solo i campi |
MembershipUpdatedEventData
Payload evento per un abbonamento aggiornato.
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 |
Identificatore. Nome della risorsa del messaggio. Formato: Dove Se imposti un ID personalizzato quando crei un messaggio, puoi utilizzarlo per specificare il messaggio in una richiesta sostituendo |
sender |
Solo output. L'utente che ha creato il messaggio. Se la tua app di chat si autentica come utente, l'output compila |
create_ |
Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo è solo di 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_ |
Solo output. L'ora in cui il messaggio è stato modificato per l'ultima volta da un utente. Se il messaggio non è mai stato modificato, questo campo è vuoto. |
delete_ |
Solo output. L'ora in cui il messaggio è stato eliminato in Google Chat. Se il messaggio non viene mai eliminato, questo campo è vuoto. |
text |
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 informazioni sulla creazione di messaggi, vedi Inviare un messaggio. |
formatted_ |
Solo output. Contiene il messaggio
Per ulteriori informazioni, vedi Visualizzare la formattazione del testo inviata in un messaggio |
cards[] |
Deprecato: utilizza Schede interattive, formattate e avanzate che puoi utilizzare per visualizzare elementi dell'interfaccia utente, come testi formattati, pulsanti e immagini cliccabili. Le schede vengono normalmente visualizzate sotto il corpo del messaggio in testo normale. |
cards_ |
Facoltativo. Un array di schede. Solo le app di Chat possono creare schede. Se l'app Chat si autentica come utente, i messaggi non possono contenere schede. Per scoprire come creare un messaggio contenente schede, consulta Inviare un messaggio. Progetta e visualizza l'anteprima delle schede con lo strumento per la creazione di schede. Apri lo strumento per la creazione di schede |
annotations[] |
Solo output. Annotazioni associate a |
thread |
Il thread a cui appartiene il messaggio. Per esempi di utilizzo, vedi Avvia o rispondi a un thread di messaggi. |
space |
Solo output. Se la tua app di Chat si autentica come utente, l'output compila solo lo spazio |
fallback_ |
Facoltativo. Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio le notifiche mobile. |
action_ |
Solo input. Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la sua risposta. |
argument_ |
Solo output. Testo normale del messaggio con tutte le menzioni dell'app Chat rimosse. |
slash_ |
Solo output. Informazioni sul comando slash, se applicabile. |
attachment[] |
Facoltativo. Allegato caricato dall'utente. |
matched_ |
Solo output. Un URL in |
thread_ |
Solo output. Se il valore è Se lo spazio non supporta le risposte nei thread, questo campo è sempre |
client_ |
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 |
emoji_ |
Solo output. L'elenco dei riepiloghi delle reazioni con emoji nel messaggio. |
private_ |
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 in privato. |
deletion_ |
Solo output. Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato |
quoted_ |
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_ |
Solo output. Immagini GIF allegate al messaggio. |
accessory_ |
Facoltativo. Uno o più widget interattivi visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o testo e schede. 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. |
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 di messaggi aggiornati. |
MessageCreatedEventData
Payload 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 evento per un messaggio aggiornato.
Tipo di evento: google.workspace.chat.message.v1.updated
Campi | |
---|---|
message |
Il messaggio aggiornato. |
QuotedMessageMetadata
Informazioni su un messaggio tra virgolette.
Campi | |
---|---|
name |
Solo output. Nome della risorsa del messaggio tra virgolette. Formato: |
last_ |
Solo output. Il timestamp della creazione o dell'ultimo aggiornamento del messaggio tra virgolette. |
Reazioni
Una reazione a un messaggio.
Campi | |
---|---|
name |
Identificatore. Il nome della risorsa della reazione. Formato: |
user |
Solo output. L'utente che ha creato la reazione. |
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[] |
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 delle 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 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_ |
Il tipo di link avanzato. |
Campo unione data . Dati per la risorsa collegata. data può essere solo uno dei seguenti: |
|
drive_ |
Dati per un link di Drive. |
chat_ |
Dati per un 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'enum. Non utilizzare. |
DRIVE_FILE |
Un tipo di link avanzato di Google Drive. |
CHAT_SPACE |
Un tipo di link avanzato per gli spazi di Chat. Ad esempio, uno smart chip per lo spazio. |
SearchSpacesRequest
Richiesta di ricerca di un elenco di spazi in base a una query.
Campi | |
---|---|
use_ |
Se 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 Al momento, questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo |
page_ |
Il numero massimo di spazi da restituire. Il servizio potrebbe restituire meno di questo valore. Se non specificato, vengono restituiti al massimo 100 spazi. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000. |
page_ |
Un token ricevuto dalla chiamata dello spazio di ricerca precedente. Specifica questo parametro per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token pagina. Se passi valori diversi agli altri parametri, potresti ottenere 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, Le seguenti query di esempio sono valide:
|
order_ |
Facoltativo. L'ordinamento dell'elenco di spazi. Gli attributi supportati per l'ordinamento sono:
I valori validi per l'operazione di ordinamento sono:
Le sintassi supportate sono:
|
SearchSpacesResponse
Rispondi con un elenco di spazi corrispondenti alla richiesta di spazi di ricerca.
Campi | |
---|---|
spaces[] |
Una pagina degli spazi richiesti. |
next_ |
Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci sono pagine successive. |
total_ |
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 e aggiungi utenti specifici.
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 di Chat che effettua la chiamata, imposta Se esiste già uno spazio |
request_ |
Facoltativo. Un identificatore univoco per questa richiesta. È consigliabile utilizzare un UUID casuale. Se specifichi 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 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 che chiama, poiché viene aggiunto automaticamente. Attualmente, il set consente fino a 20 abbonamenti (oltre a quello del chiamante). Per l'appartenenza umana, il campo Per l'appartenenza al gruppo Google, il campo Facoltativo quando imposti Obbligatorio quando Obbligatorio quando imposti Deve essere vuoto quando viene creata una conversazione 1:1 tra una persona e l'app Chat che effettua la chiamata (quando |
SlashCommand
Un comando con barra in Google Chat.
Campi | |
---|---|
command_ |
L'ID del comando slash invocato. |
SlashCommandMetadata
Metadati di annotazione per i comandi slash (/).
Campi | |
---|---|
bot |
L'app Chat di cui è stato invocato il comando. |
type |
Il tipo di comando slash. |
command_ |
Il nome del comando slash invocato. |
command_ |
L'ID del comando slash invocato. |
triggers_ |
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 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 |
Identificatore. Nome della risorsa dello spazio. Formato: Dove |
type |
Solo output. Deprecato: utilizza |
space_ |
Facoltativo. Il tipo di spazio. Obbligatorio per la creazione o l'aggiornamento del tipo di uno spazio. Output solo per altri utilizzi. |
single_ |
Facoltativo. Indica se lo spazio è un messaggio diretto tra un'app Chat e una singola persona. |
threaded |
Solo output. Deprecato: utilizza |
display_ |
Facoltativo. Il nome visualizzato dello spazio. Obbligatorio quando crei uno spazio con un Per i messaggi diretti, questo campo potrebbe essere vuoto. Supporta fino a 128 caratteri. |
external_ |
Facoltativo. Immutabile. Indica se questo spazio consente a qualsiasi utente di Google Chat di essere membro. Input da inserire durante la creazione di uno spazio in un'organizzazione Google Workspace. Ometti questo campo quando crei spazi nelle seguenti condizioni:
Per gli spazi esistenti, questo campo è solo di output. |
space_ |
Solo output. Lo stato della conversazione in thread nello spazio di Chat. |
space_ |
Facoltativo. Dettagli sullo spazio, tra cui descrizione e regole. |
space_ |
Facoltativo. Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio. |
import_ |
Facoltativo. Indica se questo spazio è stato creato in La creazione di uno spazio in |
create_ |
Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato lo spazio. Questo campo è solo di 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. Viene compilato nell'output solo quando |
last_ |
Solo output. Timestamp dell'ultimo messaggio nello spazio. |
admin_ |
Solo output. Per gli spazi con messaggi diretti (DM) con un'app di Chat, indica 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 amministratore, l'app Chat deve includere la messaggistica diretta. |
membership_ |
Solo output. Il numero di abbonamenti uniti raggruppati per tipo di abbonamento. Viene compilato quando |
access_ |
Facoltativo. Specifica l'impostazione di accesso dello spazio. Viene compilato solo quando |
space_ |
Solo output. L'URI per consentire a un utente di accedere allo spazio. |
import_ |
Solo output. La data e 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 Questo campo viene compilato solo per gli spazi creati con la modalità di importazione. |
customer |
Facoltativo. Immutabile. L'ID cliente del dominio dello spazio. Obbligatorio solo quando si crea uno spazio con autenticazione app e Nel formato Per i messaggi diretti, questo campo non viene compilato. |
Campo unione Richiede l'autenticazione utente. |
|
predefined_ |
Facoltativo. Solo input. Impostazioni predefinite per le autorizzazioni dello spazio, da inserire solo al momento della creazione di uno spazio. Se il campo non è impostato, viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono inserite nel campo |
permission_ |
Facoltativo. Impostazioni delle autorizzazioni per gli spazi esistenti. Input per aggiornare le impostazioni di autorizzazione dello spazio esatta, in cui le impostazioni di autorizzazione esistenti vengono sostituite. L'output elenca le impostazioni di autorizzazione correnti. |
AccessSettings
Rappresenta l'impostazione di accesso dello spazio.
Campi | |
---|---|
access_ |
Solo output. Indica lo stato di accesso dello spazio. |
audience |
Facoltativo. Il nome della risorsa del pubblico di destinazione che può trovare lo spazio, partecipare e visualizzare l'anteprima dei messaggi. 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 da un pubblico di destinazione. Formato: Per utilizzare il pubblico di destinazione predefinito per l'organizzazione Google Workspace, imposta il valore La lettura del pubblico di destinazione supporta:
Questo campo non viene compilato quando si utilizza l'ambito L'impostazione del pubblico di destinazione richiede l'autenticazione utente. |
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 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 aggiunti o invitati singolarmente allo spazio possono trovarlo e accedervi. Per scoprire di più, vedi Rendere uno spazio rilevabile per utenti specifici. La creazione di spazi rilevabili richiede l'autenticazione dell'utente. |
MembershipCount
Rappresenta il numero di adesioni a uno spazio, raggruppate in categorie.
Campi | |
---|---|
joined_ |
Solo output. Numero di utenti che si sono uniti direttamente allo spazio, esclusi gli utenti che si sono uniti tramite l'iscrizione a un gruppo unito. |
joined_ |
Solo output. Conteggio di tutti i gruppi che hanno aderito direttamente allo spazio. |
PermissionSetting
Rappresenta un'impostazione di autorizzazione per lo spazio.
Campi | |
---|---|
managers_ |
Facoltativo. Indica se i gestori degli spazi dispongono di questa autorizzazione. |
members_ |
Facoltativo. Indica se i membri non gestori dispongono di questa autorizzazione. |
PermissionSettings
Impostazioni di autorizzazione che puoi specificare quando aggiorni uno spazio denominato esistente.
Per impostare le impostazioni di autorizzazione durante la creazione di uno spazio, specifica il campo PredefinedPermissionSettings
nella richiesta.
Campi | |
---|---|
manage_ |
Facoltativo. Impostazione per la gestione di membri e gruppi in uno spazio. |
modify_ |
Facoltativo. Impostazione per aggiornare il nome, l'avatar, la descrizione e le linee guida dello spazio. |
toggle_ |
Facoltativo. Impostazione per attivare e disattivare la cronologia dello spazio. |
use_ |
Facoltativo. Impostazione per l'utilizzo di @tutti in uno spazio. |
manage_ |
Facoltativo. Impostazione per la gestione delle app in uno spazio. |
manage_ |
Facoltativo. Impostazione per la gestione degli webhook in uno spazio. |
post_ |
Solo output. Impostazione per la pubblicazione di messaggi in uno spazio. |
reply_ |
Facoltativo. Impostazione per rispondere ai messaggi in uno spazio. |
PredefinedPermissionSettings
Impostazioni di autorizzazione predefinite che puoi specificare solo quando crei uno spazio denominato. In futuro potrebbero essere aggiunte altre impostazioni. Per informazioni dettagliate sulle impostazioni delle autorizzazioni per gli spazi con nome, vedi Informazioni 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 della discussione, lo scopo funzionale o i partecipanti dello spazio. Supporta fino a 150 caratteri. |
guidelines |
Facoltativo. Le regole, le aspettative e il galateo dello spazio. Supporta fino a 5000 caratteri. |
SpaceThreadingState
Specifica il tipo di stato di threading 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 farlo all'interno del thread, in modo che la risposta rimanga 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 |
Messaggi diretti tra due persone e conversazioni di gruppo tra 3 o più persone. |
SpaceType
Il tipo di spazio. Obbligatorio quando si crea o aggiorna 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 tra una persona e un'app di chat. |
Tipo
Deprecato: utilizza SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Riservato. |
ROOM |
Conversazioni tra due o più persone. |
DM |
Messaggio diretto 1:1 tra una persona e un'app di chat, in cui tutti i messaggi sono invariati. Tieni presente che non sono inclusi i messaggi diretti tra due persone. |
SpaceBatchUpdatedEventData
Payload evento per più aggiornamenti di uno spazio.
Tipo di evento: google.workspace.chat.space.v1.batchUpdated
Campi | |
---|---|
spaces[] |
Un elenco di spazi aggiornati. |
SpaceEvent
Un evento che rappresenta una modifica o un'attività in uno spazio di Google Chat. Per scoprire di più, consulta Lavorare con gli eventi di Google Chat.
Campi | |
---|---|
name |
Nome della risorsa dell'evento dello spazio. Formato: |
event_ |
Ora in cui si è verificato l'evento. |
event_ |
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 relativi allo spazio:
|
Campo unione
|
|
message_ |
Payload evento per un nuovo messaggio. Tipo di evento: |
message_ |
Payload evento per un messaggio aggiornato. Tipo di evento: |
message_ |
Payload dell'evento per un messaggio eliminato. Tipo di evento: |
message_ |
Payload dell'evento per più nuovi messaggi. Tipo di evento: |
message_ |
Payload dell'evento per più messaggi aggiornati. Tipo di evento: |
message_ |
Payload dell'evento per più messaggi eliminati. Tipo di evento: |
space_ |
Payload evento per un aggiornamento dello spazio. Tipo di evento: |
space_ |
Payload evento per più aggiornamenti di uno spazio. Tipo di evento: |
membership_ |
Payload evento per un nuovo abbonamento. Tipo di evento: |
membership_ |
Payload evento per un abbonamento aggiornato. Tipo di evento: |
membership_ |
Payload evento per un abbonamento eliminato. Tipo di evento: |
membership_ |
Payload dell'evento per più nuovi abbonamenti. Tipo di evento: |
membership_ |
Payload dell'evento per più abbonamenti aggiornati. Tipo di evento: |
membership_ |
Payload dell'evento per più abbonamenti eliminati. Tipo di evento: |
reaction_ |
Payload dell'evento per una nuova reazione. Tipo di evento: |
reaction_ |
Payload evento per una reazione eliminata. Tipo di evento: |
reaction_ |
Payload dell'evento per più nuove reazioni. Tipo di evento: |
reaction_ |
Payload dell'evento per più reazioni eliminate. Tipo di evento: |
SpaceNotificationSetting
Le impostazioni di notifica di un utente in uno spazio.
Campi | |
---|---|
name |
Identificatore. Il nome della risorsa dell'impostazione di notifica dello spazio. Formato: |
notification_ |
L'impostazione di notifica. |
mute_ |
L'impostazione di disattivazione audio delle notifiche dello spazio. |
MuteSetting
I tipi di impostazioni di disattivazione delle notifiche dello spazio.
Enum | |
---|---|
MUTE_SETTING_UNSPECIFIED |
Riservato. |
UNMUTED |
L'utente riceverà notifiche per lo spazio in base all'impostazione delle notifiche. |
MUTED |
L'utente non riceverà alcuna notifica per lo spazio, indipendentemente dall'impostazione della notifica. |
NotificationSetting
I tipi di impostazioni di notifica.
Enum | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Riservato. |
ALL |
Le notifiche vengono attivate da @menzioni, thread seguiti, primo messaggio di nuovi thread. Tutti i nuovi thread vengono seguiti automaticamente, a meno che l'utente non li rimuovi manualmente. |
MAIN_CONVERSATIONS |
La notifica viene attivata dalle @menzioni, dai thread seguiti e dal primo messaggio dei 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 è disattivata. |
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 della risorsa dello stato di lettura dello spazio. Formato: |
last_ |
Facoltativo. L'ora in cui è stato aggiornato lo stato di lettura dello spazio dell'utente. 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. Per esempi di utilizzo, vedi Avvia o rispondi 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 |
Identificatore. Nome della risorsa del thread. Esempio: |
thread_ |
Facoltativo. Input per la creazione o l'aggiornamento di un thread. In caso contrario, viene visualizzato solo l'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 del 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 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_ |
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. |
UpdateMembershipRequest
Messaggio di richiesta per l'aggiornamento di un abbonamento.
Campi | |
---|---|
membership |
Obbligatorio. L'abbonamento da aggiornare. Vengono aggiornati solo i campi specificati da |
update_ |
Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza Percorsi dei campi attualmente supportati:
|
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l' |
UpdateMessageRequest
Richiedere l'aggiornamento di un messaggio.
Campi | |
---|---|
message |
Obbligatorio. Messaggio con i campi aggiornati. |
update_ |
Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza Percorsi dei campi attualmente supportati:
|
allow_ |
Facoltativo. Se |
UpdateSpaceNotificationSettingRequest
Richiedi l'aggiornamento delle impostazioni di notifica dello spazio. Supporta solo l'aggiornamento dell'impostazione di notifica per l'utente che chiama.
Campi | |
---|---|
space_ |
Obbligatorio. Il nome della risorsa per le impostazioni di notifica dello spazio deve essere inserito nel formato |
update_ |
Obbligatorio. Percorsi dei campi supportati: - |
UpdateSpaceReadStateRequest
Messaggio di richiesta per l'API UpdateSpaceReadState.
Campi | |
---|---|
space_ |
Obbligatorio. Lo stato di lettura dello spazio e i campi da aggiornare. Supporta solo l'aggiornamento dello stato di lettura per l'utente che chiama. Per fare riferimento all'utente che chiama, imposta una delle seguenti opzioni:
Formato: users/{user}/spaces/{space}/spaceReadState |
update_ |
Obbligatorio. I percorsi dei campi da aggiornare. Percorsi dei campi attualmente supportati:
Quando Per contrassegnare lo spazio come letto, imposta |
UpdateSpaceRequest
Una richiesta di aggiornamento di un singolo spazio.
Campi | |
---|---|
space |
Obbligatorio. Spazio con i campi da aggiornare. |
update_ |
Obbligatorio. I percorsi dei campi aggiornati, separati da virgole se sono presenti più campi. Puoi aggiornare i seguenti campi per uno spazio:
|
use_ |
Facoltativo. Se L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat. Richiede l' Alcuni valori |
Utente
Un utente in Google Chat. Se l'app Chat si autentica come utente, l'output restituito da una richiesta per una risorsa User
compila solo name
e type
dell'utente.
Campi | |
---|---|
name |
Nome della risorsa per un Formato: Per
|
display_ |
Solo output. Il nome visualizzato dell'utente. |
domain_ |
Identificatore univoco del dominio Google Workspace dell'utente. |
type |
Tipo di utente. |
is_ |
Solo output. Se il valore è |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enum. 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'enum. Non utilizzare. |
ADD |
Aggiungi l'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_ |
Mostra un paragrafo di testo in questo widget. |
image |
Mostra un'immagine in questo widget. |
key_ |
Mostra un elemento chiave-valore in questo widget. |
Pulsante
Un pulsante. Può essere un pulsante di testo o un pulsante immagine.
Campi | |
---|---|
Campo unione
|
|
text_ |
Un pulsante con testo e azione |
image_ |
Un pulsante con immagine e azione |
FormAction
Un'azione del modulo descrive il comportamento quando il modulo viene inviato. Ad esempio, puoi chiamare Apps Script per gestire il modulo.
Campi | |
---|---|
action_ |
Il nome del metodo viene utilizzato per identificare la parte del modulo che ha attivato l'invio del modulo. Queste informazioni vengono riportate nell'app 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[] |
Elenco dei parametri di azione. |
ActionParameter
Elenco di parametri di stringa da fornire quando viene invocato il metodo di azione. Ad esempio, considera tre pulsanti Posticipa: Posticipa ora, Posticipa di un giorno, Posticipa la prossima settimana. Puoi utilizzare action method = snooze()
, passando il tipo di posticipazione e la relativa ora nell'elenco dei parametri di stringa.
Campi | |
---|---|
key |
Il nome del parametro per lo script dell'azione. |
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 specificata da un URL e che può avere un'azione onclick
.
Campi | |
---|---|
image_ |
L'URL dell'immagine. |
on_ |
L'azione |
aspect_ |
Le proporzioni di questa immagine (larghezza e altezza). Questo campo ti consente di riservare l'altezza giusta per l'immagine in attesa del caricamento. Non ha lo scopo di sostituire le proporzioni predefinite dell'immagine. Se non è impostato, il server lo completa prelevando l'immagine. |
ImageButton
Un pulsante immagine con un'azione onclick
.
Campi | |
---|---|
on_ |
L'azione |
name |
Il nome di questo |
Campo unione icons . L'icona può essere specificata tramite un Icon enum o un URL. icons può essere solo uno dei seguenti: |
|
icon |
L'icona specificata da un |
icon_ |
L'icona specificata da un URL. |
KeyValue
Un elemento dell'interfaccia utente contiene una chiave (etichetta) e un valore (contenuti). Questo elemento può contenere anche alcune azioni, ad esempio il pulsante onclick
.
Campi | |
---|---|
top_ |
Il testo dell'etichetta superiore. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattare il testo nelle app Google Chat e Formattare il 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 Formattare il testo nelle app Google Chat e Formattare il testo nei componenti aggiuntivi di Google Workspace. |
content_ |
Se i contenuti devono essere su più righe. |
bottom_ |
Il testo dell'etichetta in basso. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattare il testo nelle app Google Chat e Formattare il testo nei componenti aggiuntivi di Google Workspace. |
on_ |
L'azione |
Campo unione icons . È necessario definire almeno uno degli elementi icone, top_label e bottom_label . icons può essere solo uno dei seguenti: |
|
icon |
Un valore enumerato sostituito dall'API Chat con l'immagine dell'icona corrispondente. |
icon_ |
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 |
Se specificata, questa azione |
open_ |
Questa azione |
OpenLink
Un link che apre una nuova finestra.
Campi | |
---|---|
url |
L'URL da aprire. |
TextButton
Un pulsante con testo e azione onclick
.
Campi | |
---|---|
text |
Il testo del pulsante. |
on_ |
L'azione |
TextParagraph
Un paragrafo di testo. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattare il testo nelle app Google Chat e Formattare il testo nei componenti aggiuntivi di Google Workspace.
Campi | |
---|---|
text |
|