- 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
- DecoratedText
- Icona
- MaterialIcon
- Pulsante
- Colore
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Tipo
- Suggerimenti
- SuggestionItem
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Spartitraffico
- Griglia
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Colonne
- Colonna
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widget
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Annotazione
- AnnotationType
- UserMentionMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Finestra di dialogo
- 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 |
Nome 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 i campi utente |
createTime |
Campo facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo è solo di output, tranne quando è utilizzato negli spazi in modalità di importazione. Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui è stato creato il messaggio nell'origine per preservare la data e l'ora di creazione originale. |
lastUpdateTime |
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. |
deleteTime |
Solo output. L'ora in cui il messaggio è stato eliminato in Google Chat. Se il messaggio non viene mai eliminato, questo campo è vuoto. |
text |
Corpo del messaggio in testo normale. Il primo link a un'immagine, a un video o a una pagina web genera un chip di anteprima. Puoi anche menzionare un utente di Google Chat o tutte le persone nello spazio. Per ulteriori informazioni sulla creazione di SMS, vedi Inviare un SMS. |
formattedText |
Solo output. Contiene il messaggio
Per ulteriori informazioni, vedi Visualizzare la formattazione del testo inviata in un messaggio. |
cards[] |
Deprecato: utilizza Schede accattivanti, formattate e interattive che puoi utilizzare per visualizzare elementi dell'interfaccia utente come testi formattati, pulsanti e immagini cliccabili. Le schede sono solitamente visualizzate sotto il corpo in testo normale del messaggio. |
cardsV2[] |
Un array di schede. Solo le app di chat possono creare schede. Se la tua app di chat si autentica come utente, i messaggi non possono contenere schede. Per scoprire di più sulle schede e su come crearle, vedi Inviare messaggi alle schede. Progetta e visualizza l'anteprima delle schede con Card Builder. Apri Card Builder |
annotations[] |
Solo output. Annotazioni associate a |
thread |
Il thread a cui appartiene il messaggio. Ad esempio, vedi Avviare o rispondere a un thread di messaggi. |
space |
Se la tua app di Chat si autentica come utente, l'output popola lo spazio |
fallbackText |
Una descrizione in testo normale delle schede del messaggio, utilizzata quando le schede effettive non possono essere visualizzate, ad esempio le notifiche sui dispositivi mobili. |
actionResponse |
Solo input. Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la risposta. |
argumentText |
Solo output. Corpo del messaggio in testo normale con tutte le menzioni dell'app di chat rimosse. |
slashCommand |
Solo output. Informazioni sul comando slash, se applicabile. |
attachment[] |
Allegato caricato dall'utente. |
matchedUrl |
Solo output. Un URL in |
threadReply |
Solo output. Quando Se lo spazio non supporta le risposte nei thread, il campo sarà sempre |
clientAssignedMessageId |
Campo facoltativo. Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio oppure per ricevere, eliminare o aggiornare un messaggio. Per impostare un ID personalizzato, specifica il campo |
emojiReactionSummaries[] |
Solo output. L'elenco di riepiloghi delle reazioni con emoji nel messaggio. |
privateMessageViewer |
Immutabile. Input per la creazione di un messaggio, altrimenti solo di output. L'utente che può visualizzare il messaggio. Se impostato, il messaggio è privato e visibile solo all'utente specificato e all'app Chat. Le anteprime dei link e gli allegati non sono supportati per i messaggi privati. Solo le app di chat possono inviare messaggi privati. Se la tua app di chat si autentica come utente per inviare un messaggio, il messaggio non può essere privato e questo campo deve essere omesso. Per maggiori dettagli, vedi Inviare messaggi privati agli utenti di Google Chat. |
deletionMetadata |
Solo output. Informazioni su un messaggio eliminato. Viene eliminato un messaggio se viene impostato |
quotedMessageMetadata |
Solo output. Informazioni su un messaggio citato da un utente di Google Chat in uno spazio. Gli utenti di Google Chat possono citare un messaggio per rispondere. |
attachedGifs[] |
Solo output. Immagini GIF allegate al messaggio. |
accessoryWidgets[] |
Uno o più widget interattivi visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori a messaggi che contengono testo, schede o sia testo che schede. Non supportato per i messaggi che contengono finestre di dialogo. Per maggiori dettagli, vedi Aggiungere widget interattivi in fondo a un messaggio. La creazione di un messaggio con widget accessori richiede l'autenticazione delle app. |
CardWithId
Una scheda in un messaggio di Google Chat.
Solo le app di chat possono creare schede. Se la tua app di chat si autentica come utente, il messaggio non può contenere schede.
Progetta e visualizza l'anteprima delle schede con Card Builder.
Apri Card BuilderRappresentazione JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campi | |
---|---|
cardId |
Obbligatorio se il messaggio contiene più schede. L'identificatore univoco di una carta 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, vedi Formattare gli SMS.
Esempio di corpo del messaggio di testo normale:
Hello @FooBot how are you!"
I metadati delle annotazioni corrispondenti:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Rappresentazione JSON |
---|
{ "type": enum ( |
Campi | |
---|---|
type |
Il tipo di questa annotazione. |
length |
Lunghezza della sottostringa nel corpo del messaggio di testo normale a cui corrisponde questa annotazione. |
startIndex |
Indice iniziale (su base 0, inclusivo) nel corpo del messaggio di testo normale a cui corrisponde questa annotazione. |
Campo di unione metadata . Metadati aggiuntivi sull'annotazione. metadata può essere solo uno dei seguenti: |
|
userMention |
I metadati della menzione dell'utente. |
slashCommand |
I metadati di un comando slash. |
richLinkMetadata |
I metadati per un link avanzato. |
AnnotationType
Tipo dell'annotazione.
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
USER_MENTION |
Viene menzionato un utente. |
SLASH_COMMAND |
Viene richiamato un comando slash. |
RICH_LINK |
Un'annotazione link dettagliata. |
UserMentionMetadata
Metadati delle annotazioni per le menzioni dell'utente (@).
Rappresentazione JSON |
---|
{ "user": { object ( |
Campi | |
---|---|
user |
L'utente menzionato. |
type |
Il tipo di menzione dell'utente. |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
ADD |
Aggiungi utente allo spazio. |
MENTION |
Menziona l'utente nello spazio. |
SlashCommandMetadata
Metadati di annotazione per i comandi slash (/).
Rappresentazione JSON |
---|
{ "bot": { object ( |
Campi | |
---|---|
bot |
L'app Chat di cui è stato richiamato il comando. |
type |
Il tipo di comando slash. |
commandName |
Il nome del comando slash richiamato. |
commandId |
L'ID del comando slash richiamato. |
triggersDialog |
Indica se il comando slash è per una finestra di dialogo. |
Tipo
Enum | |
---|---|
TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
ADD |
Aggiungi l'app Chat allo spazio. |
INVOKE |
Richiama il comando slash nello spazio. |
RichLinkMetadata
Un link completo a una risorsa.
Rappresentazione JSON |
---|
{ "uri": string, "richLinkType": enum ( |
Campi | |
---|---|
uri |
L'URI di questo link. |
richLinkType |
Il tipo di link avanzato. |
Campo di unione data . Dati per la risorsa collegata. data può essere solo uno dei seguenti: |
|
driveLinkData |
Dati relativi a un link di Drive. |
RichLinkType
Il tipo di link avanzato. In futuro potrebbero essere aggiunti altri tipi.
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valore predefinito per l'enumerazione. Non utilizzare. |
DRIVE_FILE |
Un tipo di link RTF di Google Drive. |
DriveLinkData
Dati relativi ai link di Google Drive.
Rappresentazione JSON |
---|
{
"driveDataRef": {
object ( |
Campi | |
---|---|
driveDataRef |
Un elemento DriveDataRef che fa riferimento a un file di Google Drive. |
mimeType |
Il tipo MIME della risorsa di Google Drive collegata. |
Thread
Un thread in uno spazio di Google Chat. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.
Se specifichi un thread durante la creazione di un messaggio, puoi impostare il campo messageReplyOption
per determinare cosa succede se non viene trovato alcun thread corrispondente.
Rappresentazione JSON |
---|
{ "name": string, "threadKey": string } |
Campi | |
---|---|
name |
Solo output. Nome della risorsa del thread. Esempio: |
threadKey |
Campo facoltativo. Input per la creazione o l'aggiornamento di un thread. In caso contrario, solo output. ID del thread. Supporta fino a 4000 caratteri. Questo ID è univoco per l'app di Chat che lo imposta. Ad esempio, se più app di chat creano un messaggio utilizzando la stessa chiave thread, i messaggi vengono pubblicati in thread diversi. Per rispondere in un thread creato da una persona o da un'altra app di Chat, specifica invece il campo |
ActionResponse
Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la risposta.
Rappresentazione JSON |
---|
{ "type": enum ( |
Campi | |
---|---|
type |
Solo input. Il tipo di risposta dell'app di Chat. |
url |
Solo input. URL che gli utenti possono autenticare o configurare. (Solo per i tipi di risposta |
dialogAction |
Solo input. Una risposta a un evento di interazione relativo a una dialogo. Deve essere accompagnato da |
updatedWidget |
Solo input. La risposta del widget aggiornato. |
ResponseType
Il tipo di risposta dell'app di Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Tipo predefinito gestito come NEW_MESSAGE . |
NEW_MESSAGE |
Pubblica come nuovo messaggio nell'argomento. |
UPDATE_MESSAGE |
Aggiorna il messaggio dell'app Chat. Ciò è consentito solo per un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT . |
UPDATE_USER_MESSAGE_CARDS |
Aggiornare le schede nel messaggio di un utente. Ciò è consentito solo in risposta a un evento MESSAGE con un URL corrispondente o a un evento CARD_CLICKED in cui il tipo di mittente del messaggio è HUMAN . Il testo viene ignorato. |
REQUEST_CONFIG |
Chiedi privatamente all'utente ulteriori autenticazioni o configurazioni. |
DIALOG |
Presenta una finestra di dialogo. |
UPDATE_WIDGET |
Query sulle opzioni di completamento automatico del testo del widget. |
DialogAction
Contiene una finestra di dialogo e un codice di stato della richiesta.
Rappresentazione JSON |
---|
{ "actionStatus": { object ( |
Campi | |
---|---|
actionStatus |
Solo input. Stato di una richiesta di richiamare o inviare una finestra di dialogo. Se necessario, mostra uno stato e un messaggio agli utenti. Ad esempio, in caso di errore o di esito positivo. |
Campo di unione action . Azione da eseguire. action può essere solo uno dei seguenti: |
|
dialog |
Solo input. Finestra di dialogo per la richiesta. |
Dialog
Scorri il dito intorno al corpo della scheda della finestra di dialogo.
Rappresentazione JSON |
---|
{
"body": {
object ( |
Campi | |
---|---|
body |
Solo input. Corpo 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 richiamare o inviare una dialogo.
Rappresentazione JSON |
---|
{
"statusCode": enum ( |
Campi | |
---|---|
statusCode |
Il codice di stato. |
userFacingMessage |
Il messaggio per inviare agli utenti lo stato della loro richiesta. Se il criterio non viene configurato, viene inviato un messaggio generico basato su |
Codice
I codici di errore canonici per le API gRPC.
A volte potrebbero essere applicati più codici di errore. I servizi dovrebbero restituire il codice di errore più specifico applicabile. Ad esempio, preferisci OUT_OF_RANGE
rispetto 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 se l'operazione è andata a buon fine. Mappatura HTTP: 200 OK |
CANCELLED |
L'operazione è stata annullata, in genere dal chiamante. Mappatura HTTP: richiesta chiusa client 499 |
UNKNOWN |
Errore sconosciuto. Ad esempio, questo errore può essere restituito quando un valore Mappatura HTTP: errore interno del server 500 |
INVALID_ARGUMENT |
Il client ha specificato un argomento non valido. Tieni presente che è diverso da Mappatura HTTP: 400 richiesta non valida |
DEADLINE_EXCEEDED |
Il termine è scaduto prima del completamento dell'operazione. Per le operazioni che cambiano lo stato del sistema, questo errore potrebbe essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta corretta da un server potrebbe essere ritardata abbastanza a lungo da far scadere la scadenza. Mappatura HTTP: timeout del gateway 504 |
NOT_FOUND |
Impossibile trovare un'entità richiesta (ad es. un file o una directory). Nota per gli sviluppatori di server: se una richiesta viene rifiutata per un'intera classe di utenti, ad esempio mediante implementazione graduale di funzionalità o lista consentita non documentata, è possibile che venga utilizzato Mappatura HTTP: 404 non trovato |
ALREADY_EXISTS |
L'entità che un client ha tentato di creare (ad es. un file o una directory) esiste già. Mappatura HTTP: conflitto 409 |
PERMISSION_DENIED |
Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. Non utilizzare Mappatura HTTP: 403 accesso negato |
UNAUTHENTICATED |
La richiesta non ha credenziali di autenticazione valide per l'operazione. Mappatura HTTP: 401 Autorizzazione non autorizzata |
RESOURCE_EXHAUSTED |
Alcune risorse sono esaurite, forse una quota per utente o forse l'intero file system ha esaurito lo spazio. Mappatura HTTP: 429 Troppe richieste |
FAILED_PRECONDITION |
L'operazione è stata rifiutata perché il sistema non è nello stato necessario per l'esecuzione. Ad esempio, la directory da eliminare non è vuota, viene applicata un'operazione rmdir a una non directory e così via. Gli implementatori del servizio possono utilizzare le seguenti linee guida per scegliere tra Mappatura HTTP: 400 richiesta non valida |
ABORTED |
L'operazione è stata interrotta, generalmente a causa di un problema di contemporaneità, come un errore del controllo del sequenziatore o l'interruzione della transazione. Consulta le linee guida precedenti per decidere tra Mappatura HTTP: conflitto 409 |
OUT_OF_RANGE |
Si è tentato di eseguire l'operazione oltre l'intervallo valido. Ad esempio, cercare o leggere la fine del file. A differenza di Esiste una leggera sovrapposizione tra Mappatura HTTP: 400 richiesta non valida |
UNIMPLEMENTED |
L'operazione non è implementata o non è supportata/abilitata in questo servizio. Mappatura HTTP: 501 non implementata |
INTERNAL |
Errori interni. Ciò significa che alcuni elementi invarianti previsti dal sistema sottostante sono stati danneggiati. Questo codice di errore è riservato a errori gravi. Mappatura HTTP: errore interno del server 500 |
UNAVAILABLE |
Il servizio non è al momento disponibile. Molto probabilmente si tratta di una condizione transitoria, che può essere corretta riprovando con un backoff. Tieni presente che non è sempre sicuro ritentare le operazioni non idempotenti. Consulta le linee guida precedenti per decidere tra Mappatura HTTP: servizio 503 non disponibile |
DATA_LOSS |
Perdita o danneggiamento dei dati non recuperabili. Mappatura HTTP: errore interno del server 500 |
UpdatedWidget
La risposta del widget aggiornato. Utilizzato per fornire opzioni di completamento automatico per un widget.
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 di 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 del 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 slash in Google Chat.
Rappresentazione JSON |
---|
{ "commandId": string } |
Campi | |
---|---|
commandId |
L'ID del comando slash richiamato. |
MatchedUrl
Un URL corrispondente in un messaggio di Chat. Le app di chat possono visualizzare l'anteprima degli URL corrispondenti. Per saperne di più, vedi Link di anteprima.
Rappresentazione JSON |
---|
{ "url": string } |
Campi | |
---|---|
url |
Solo output. L'URL corrispondente. |
EmojiReactionSummary
Il numero di persone che hanno reagito a un messaggio con un'emoji specifica.
Rappresentazione JSON |
---|
{
"emoji": {
object ( |
Campi | |
---|---|
emoji |
Emoji associata alle reazioni. |
reactionCount |
Il numero totale di reazioni utilizzando l'emoji associata. |
DeletionMetadata
Informazioni su un messaggio eliminato. Viene eliminato un messaggio se viene impostato deleteTime
.
Rappresentazione JSON |
---|
{
"deletionType": enum ( |
Campi | |
---|---|
deletionType |
Indica chi ha eliminato il messaggio. |
DeletionType
Chi ha eliminato il messaggio e come è stato eliminato.
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 quando è scaduto. |
CREATOR_VIA_APP |
Un'app di chat ha eliminato il messaggio per conto dell'utente. |
SPACE_OWNER_VIA_APP |
Un'app di Chat ha eliminato il messaggio per conto del proprietario dello spazio. |
QuotedMessageMetadata
Informazioni su un messaggio tra virgolette.
Rappresentazione JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Campi | |
---|---|
name |
Solo output. Nome risorsa del messaggio tra virgolette. Formato: |
lastUpdateTime |
Solo output. Il timestamp della creazione o dell'ultimo aggiornamento del messaggio citato. |
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 in fondo a un messaggio.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione action . Il tipo di azione. action può essere solo uno dei seguenti: |
|
buttonList |
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 in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da spazi e membri bloccati. |
|
Aggiorna un messaggio. |
|
Aggiorna un messaggio. |