- Risorsa: messaggio
- Rappresentazione JSON
- Carta
- CardHeader
- ImageStyle
- Sezione
- WidgetMarkup
- TextParagraph
- Immagine
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Icona
- Pulsante
- TextButton
- ImageButton
- CardAction
- CardWithId
- Carta
- CardHeader
- ImageType
- Sezione
- Widget
- TextParagraph
- Immagine
- OnClick
- Azione
- ActionParameter
- LoadIndicator
- Interazione
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Icona
- MaterialIcon
- DecoratedText
- Pulsante
- Colore
- Tipo
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Tipo
- Suggerimenti
- SuggestionItem
- Convalida
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Separatore
- Griglia
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Colonne
- Colonna
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widget
- ChipList
- Layout
- Chip
- Carosello
- CarouselCard
- NestedWidget
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Annotazione
- AnnotationType
- UserMentionMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- Metodi
Risorsa: messaggio
Un messaggio in uno spazio di Google Chat.
Rappresentazione JSON |
---|
{ "name": string, "sender": { object ( |
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 che viene 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. |
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 schedeRappresentazione JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campi | |
---|---|
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. |
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"
}
}]
Rappresentazione JSON |
---|
{ "type": enum ( |
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 invocato un comando slash. |
RICH_LINK |
Un'annotazione di link avanzata. |
UserMentionMetadata
Metadati delle annotazioni per le menzioni degli utenti (@).
Rappresentazione JSON |
---|
{ "user": { object ( |
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. |
SlashCommandMetadata
Metadati delle annotazioni per i comandi slash (/).
Rappresentazione JSON |
---|
{ "bot": { object ( |
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. |
RichLinkMetadata
Un link avanzato a una risorsa.
Rappresentazione JSON |
---|
{ "uri": string, "richLinkType": enum ( |
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. |
DriveLinkData
Dati per i link di Google Drive.
Rappresentazione JSON |
---|
{
"driveDataRef": {
object ( |
Campi | |
---|---|
drive |
Un DriveDataRef che fa riferimento a un file di Google Drive. |
mime |
Il tipo MIME della risorsa di Google Drive collegata. |
ChatSpaceLinkData
Dati per i link agli spazi di Chat.
Rappresentazione JSON |
---|
{ "space": string, "thread": string, "message": string } |
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: |
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.
Rappresentazione JSON |
---|
{ "name": string, "threadKey": string } |
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 |
ActionResponse
Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la sua risposta.
Rappresentazione JSON |
---|
{ "type": enum ( |
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 fornire 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. |
DialogAction
Contiene un dialogo e il codice di stato della richiesta.
Rappresentazione JSON |
---|
{ "actionStatus": { object ( |
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. |
Dialog
Contenitore del corpo della scheda della finestra di dialogo.
Rappresentazione JSON |
---|
{
"body": {
object ( |
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: |
ActionStatus
Rappresenta lo stato di una richiesta di chiamata o invio di una finestra di dialogo.
Rappresentazione JSON |
---|
{
"statusCode": enum ( |
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 |
Codice
I codici di errore canonici per le API gRPC.
A volte possono essere applicati più codici di errore. I servizi devono restituire il codice di errore più specifico applicabile. Ad esempio, preferisci OUT_OF_RANGE
a FAILED_PRECONDITION
se si applicano entrambi i codici. Analogamente, preferisci NOT_FOUND
o ALREADY_EXISTS
rispetto a FAILED_PRECONDITION
.
Enum | |
---|---|
OK |
Non è un errore; viene restituito in caso di esito positivo. Mappatura HTTP: 200 OK |
CANCELLED |
L'operazione è stata annullata, in genere dal chiamante. Mappatura HTTP: 499 Client Closed Request |
UNKNOWN |
Errore sconosciuto. Ad esempio, questo errore può essere restituito quando un valore Mappatura HTTP: 500 Internal Server Error (Errore interno del server) |
INVALID_ARGUMENT |
Il client ha specificato un argomento non valido. Tieni presente che questo valore è diverso da Mappatura HTTP: 400 Bad Request (Richiesta non valida) |
DEADLINE_EXCEEDED |
La scadenza è scaduta prima del completamento dell'operazione. Per le operazioni che modificano lo stato del sistema, questo errore può essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta positiva da un server potrebbe aver subito un ritardo sufficientemente lungo da far scadere la scadenza. Mappatura HTTP: timeout del gateway (504) |
NOT_FOUND |
Impossibile trovare alcune entità richieste (ad es. file o directory). Nota per gli sviluppatori di server: se una richiesta viene rifiutata per un'intera classe di utenti, ad esempio per l'implementazione graduale di funzionalità o per le liste consentite non documentate, può essere utilizzato Mappatura HTTP: 404 Not Found |
ALREADY_EXISTS |
L'entità che un client ha tentato di creare (ad es. file o directory) esiste già. Mappatura HTTP: conflitto (409) |
PERMISSION_DENIED |
Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. Mappatura HTTP: 403 accesso negato |
UNAUTHENTICATED |
La richiesta non ha credenziali di autenticazione valide per l'operazione. Mappatura HTTP: 401 Non autorizzato |
RESOURCE_EXHAUSTED |
Una risorsa è stata esaurita, ad esempio una quota per utente, oppure l'intero file system non dispone di spazio. Mappatura HTTP: 429 Too Many Requests |
FAILED_PRECONDITION |
L'operazione è stata rifiutata perché il sistema non è nello stato richiesto per l'esecuzione dell'operazione. Ad esempio, la directory da eliminare non è vuota, un'operazione rmdir viene applicata a una non directory e così via. Gli implementatori di servizi possono utilizzare le seguenti linee guida per scegliere tra Mappatura HTTP: 400 Bad Request (Richiesta non valida) |
ABORTED |
L'operazione è stata interrotta, in genere a causa di un problema di concorrenza, ad esempio un errore di controllo del sequenziatore o l'interruzione della transazione. Consulta le linee guida sopra per decidere tra Mappatura HTTP: conflitto (409) |
OUT_OF_RANGE |
L'operazione è stata tentata oltre l'intervallo valido. Ad esempio, ricerca o lettura oltre il fine file. A differenza di Esiste una discreta sovrapposizione tra Mappatura HTTP: 400 Bad Request (Richiesta non valida) |
UNIMPLEMENTED |
L'operazione non è implementata o non è supportata/attivata in questo servizio. Mappatura HTTP: 501 Not Implemented |
INTERNAL |
Errori interni. Ciò significa che alcune invarianti previste dal sistema sottostante sono state violate. Questo codice di errore è riservato agli errori gravi. Mappatura HTTP: 500 Internal Server Error (Errore interno del server) |
UNAVAILABLE |
Il servizio non è al momento disponibile. Molto probabilmente si tratta di una condizione temporanea, che può essere corretta riprovando con un backoff. Tieni presente che non è sempre sicuro riprovare le operazioni non idempotenti. Consulta le linee guida sopra per decidere tra Mappatura HTTP: 503 Servizio non disponibile |
DATA_LOSS |
Perdita di dati non recuperabili o danneggiamento dei dati. Mappatura HTTP: 500 Internal Server Error (Errore interno del server) |
UpdatedWidget
Per i widget selectionInput
, restituisce i suggerimenti di completamento automatico per un menu a scelta multipla.
Rappresentazione JSON |
---|
{ "widget": string, // Union field |
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 |
SelectionItems
Elenco dei risultati del completamento automatico del widget.
Rappresentazione JSON |
---|
{
"items": [
{
object ( |
Campi | |
---|---|
items[] |
Un array di oggetti SelectionItem. |
SlashCommand
Un comando con barra in Google Chat.
Rappresentazione JSON |
---|
{ "commandId": string } |
Campi | |
---|---|
command |
L'ID del comando slash invocato. |
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.
Rappresentazione JSON |
---|
{ "url": string } |
Campi | |
---|---|
url |
Solo output. L'URL con corrispondenza. |
EmojiReactionSummary
Il numero di persone che hanno reagito a un messaggio con un'emoji specifica.
Rappresentazione JSON |
---|
{
"emoji": {
object ( |
Campi | |
---|---|
emoji |
Solo output. Emoji associate alle reazioni. |
reaction |
Solo output. Il numero totale di reazioni che utilizzano l'emoji associata. |
DeletionMetadata
Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato deleteTime
.
Rappresentazione JSON |
---|
{
"deletionType": enum ( |
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. |
QuotedMessageMetadata
Informazioni su un messaggio tra virgolette.
Rappresentazione JSON |
---|
{ "name": string, "lastUpdateTime": string } |
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. |
AttachedGif
Un'immagine GIF specificata da un URL.
Rappresentazione JSON |
---|
{ "uri": string } |
Campi | |
---|---|
uri |
Solo output. L'URL che ospita l'immagine GIF. |
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.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione action . Il tipo di azione. action può essere solo uno dei seguenti: |
|
button |
Un elenco di pulsanti. |
Metodi |
|
---|---|
|
Crea un messaggio in uno spazio di Google Chat. |
|
Elimina un messaggio. |
|
Restituisce i dettagli di un messaggio. |
|
Elenca i messaggi di uno spazio di cui l'utente che ha effettuato la chiamata è membro, inclusi i messaggi di spazi e membri bloccati. |
|
Aggiorna un messaggio. |
|
Aggiorna un messaggio. |