REST Resource: spaces.messages

Risorsa: Message

Un messaggio in uno spazio di Google Chat.

Rappresentazione JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
Campi
name

string

Identificatore. Nome della risorsa del messaggio.

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

Dove {space} è l'ID dello spazio in cui viene pubblicato il messaggio e {message} è un ID assegnato dal sistema per il messaggio. Ad esempio: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Se imposti un ID personalizzato quando crei un messaggio, puoi utilizzarlo per specificare il messaggio in una richiesta sostituendo {message} con il valore del campo clientAssignedMessageId. Ad esempio: spaces/AAAAAAAAAAA/messages/client-custom-name. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
sender

object (User)

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

string (Timestamp format)

Facoltativo. Immutabile. Per gli spazi creati in Chat, l'ora in cui è stato creato il messaggio. Questo campo è di solo output, tranne quando viene utilizzato negli spazi in modalità di importazione.

Per gli spazi in modalità di importazione, imposta questo campo sul timestamp storico in cui il messaggio è stato creato nell'origine per conservare l'ora di creazione originale.
lastUpdateTime

string (Timestamp format)

Solo output. L'ora dell'ultima modifica del messaggio da parte di un utente. Se il messaggio non è mai stato modificato, questo campo è vuoto.
deleteTime

string (Timestamp format)

Solo output. L'ora in cui il messaggio è stato eliminato in Google Chat. Se il messaggio non viene mai eliminato, questo campo è vuoto.
text

string

Facoltativo. Corpo del messaggio in testo normale. Il primo link a un'immagine, un video o una pagina web genera un chip di anteprima. Puoi anche @menzionare un utente di Google Chat o tutti gli utenti dello spazio.

Per scoprire come creare messaggi, consulta Invia un messaggio.
formattedText

string

Solo output. Contiene il messaggio text con markup aggiunti per comunicare la formattazione. Questo campo potrebbe non acquisire tutta la formattazione visibile nell'interfaccia utente, ma include quanto segue:

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

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

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

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

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

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

object (Card)

Ritirato: utilizza invece cardsV2.

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

object (CardWithId)

Facoltativo. Un array di schede.

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

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

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

Apri Card Builder
annotations[]

object (Annotation)

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

object (Thread)

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

object (Space)

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

string

Facoltativo. Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio nelle notifiche mobile.
actionResponse

object (ActionResponse)

Solo input. Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta.
argumentText

string

Solo output. Corpo del messaggio in testo normale con tutte le menzioni dell'app di Chat rimosse.
slashCommand

object (SlashCommand)

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

object (Attachment)

Facoltativo. Allegato caricato dall'utente.
matchedUrl

object (MatchedUrl)

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

boolean

Solo output. Quando true, il messaggio è una risposta in un thread di risposte. Quando false, il messaggio è visibile nella conversazione di primo livello dello spazio come primo messaggio di un thread o come messaggio senza risposte in thread.

Se lo spazio non supporta le risposte in thread, questo campo è sempre false.
silent

boolean

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

string

Facoltativo. Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio o per recuperarlo, eliminarlo o aggiornarlo. Per impostare un ID personalizzato, specifica il campo messageId quando crei il messaggio. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
emojiReactionSummaries[]

object (EmojiReactionSummary)

Solo output. L'elenco dei riepiloghi delle reazioni con emoji nel messaggio.
privateMessageViewer

object (User)

Facoltativo. Immutabile. Input per la creazione di un messaggio, altrimenti solo output. L'utente che può visualizzare il messaggio. Se impostato, il messaggio è privato e visibile solo all'utente specificato e all'app Chat. Per includere questo campo nella richiesta, devi chiamare l'API Chat utilizzando l'autenticazione dell'app e omettere quanto segue:

Per maggiori dettagli, vedi Inviare un messaggio privato.
deletionMetadata

object (DeletionMetadata)

Solo output. Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando è impostato deleteTime.
quotedMessageMetadata

object (QuotedMessageMetadata)

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

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

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

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

object (AttachedGif)

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

object (AccessoryWidget)

Facoltativo. Uno o più widget interattivi visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o entrambi. Non supportato per i messaggi che contengono finestre di dialogo. Per maggiori dettagli, vedi Aggiungere widget interattivi nella parte inferiore di un messaggio.

La creazione di un messaggio con widget accessori richiede l'autenticazione dell'app.
elements

object (Elements)

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

markupSyntax

enum (MarkupSyntax)

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

CardWithId

Una scheda in un messaggio chat di Google Chat.

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

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

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

Apri il generatore di schede

Rappresentazione JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  },
  "ownerUser": {
    object (User)
  }
}
Campi
cardId

string

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

object (Card)

Una scheda. La dimensione massima è 32 kB.
ownerUser

object (User)

Solo output. L'app proprietaria della tessera.

Annotazione

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

Esempio di corpo del messaggio in testo normale:

Hello @FooBot how are you!"

I metadati delle annotazioni corrispondenti:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Rappresentazione JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Campi
type

enum (AnnotationType)

Il tipo di questa annotazione.
length

integer

Lunghezza della sottostringa nel corpo del messaggio in testo normale a cui corrisponde questa annotazione. Se non è presente, indica una lunghezza pari a 0.
startIndex

integer

Indice iniziale (in base 0, inclusivo) nel corpo del messaggio in testo normale a cui corrisponde questa annotazione.
Metadati aggiuntivi sull'annotazione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
userMention

object (UserMentionMetadata)

I metadati della menzione dell'utente.
slashCommand

object (SlashCommandMetadata)

I metadati di un comando slash.
customEmojiMetadata

object (CustomEmojiMetadata)

I metadati di un'emoji personalizzata.
Fine dei campi che si escludono a vicenda.

AnnotationType

Il tipo di annotazione.

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

UserMentionMetadata

Metadati delle annotazioni per le menzioni degli utenti (@).

Rappresentazione JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Campi
user

object (User)

L'utente menzionato.
type

enum (Type)

Il tipo di menzione dell'utente.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
ADD Aggiungi un utente allo spazio.
MENTION Menzionare un utente nello spazio.

SlashCommandMetadata

Metadati di annotazione per i comandi slash (/).

Rappresentazione JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Campi
bot

object (User)

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

enum (Type)

Il tipo di comando slash.
commandName

string

Il nome del comando slash richiamato.
commandId

string (int64 format)

L'ID comando del comando slash richiamato.
triggersDialog

boolean

Indica se il comando slash è per una finestra di dialogo.

Tipo

Enum
TYPE_UNSPECIFIED Valore predefinito per l'enum. Non utilizzare.
ADD Aggiungi l'app di Chat allo spazio.
INVOKE Richiamare il comando slash nello spazio.

RichLinkMetadata

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

Rappresentazione JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
Campi
uri

string

L'URI di questo link.
Dati per la risorsa collegata. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
Fine dei campi che si escludono a vicenda.

RichLinkType

Il tipo di link avanzato. In futuro potrebbero essere aggiunti altri tipi.

Enum
DRIVE_FILE Un tipo di link avanzato di Google Drive.
CHAT_SPACE Un tipo di link avanzato di uno spazio di Chat. Ad esempio, uno smart chip dello spazio.
GMAIL_MESSAGE Un tipo di link avanzato per i messaggi di Gmail. In particolare, un chip di Gmail da Condividi in Chat. L'API supporta solo la lettura di messaggi con link avanzati GMAIL_MESSAGE.
MEET_SPACE Un tipo di link avanzato per i messaggi di Meet. Ad esempio, un chip di Meet.
CALENDAR_EVENT Un tipo di link avanzato per i messaggi di Calendar. Ad esempio, un chip di Calendar.

DriveLinkData

Dati per i link di Google Drive.

Rappresentazione JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
Campi
driveDataRef

object (DriveDataRef)

Un DriveDataRef che fa riferimento a un file di Google Drive.
mimeType

string

Il tipo MIME della risorsa Google Drive collegata.

ChatSpaceLinkData

Dati per i link degli spazi di Chat.

Rappresentazione JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
Campi
space

string

Lo spazio della risorsa dello spazio di Chat collegato.

Formato: spaces/{space}
thread

string

Il thread della risorsa dello spazio di Chat collegato.

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

string

Il messaggio della risorsa dello spazio di Chat collegato.

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

MeetSpaceLinkData

Dati per i link degli spazi di Meet.

Rappresentazione JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
Campi
meetingCode

string

Codice riunione dello spazio di Meet collegato.
type

enum (Type)

Indica il tipo di spazio di Meet.
huddleStatus

enum (HuddleStatus)

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

Tipo

Il tipo di spazio di Meet.

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

HuddleStatus

Lo stato della riunione

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

CalendarEventLinkData

Dati per i link agli eventi nel calendario.

Rappresentazione JSON 
{
  "calendarId": string,
  "eventId": string
}
Campi
calendarId

string

L'identificatore del calendario collegato.
eventId

string

L'identificatore dell'evento nel calendario collegato.

CustomEmojiMetadata

Metadati di annotazione per le emoji personalizzate.

Rappresentazione JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
Campi
customEmoji

object (CustomEmoji)

L'emoji personalizzata.

Thread

Un thread in uno spazio di Google Chat. Per un esempio di utilizzo, consulta Avviare o rispondere a un thread di messaggi.

Se specifichi un thread durante la creazione di un messaggio, puoi impostare il campo messageReplyOption per determinare cosa succede se non viene trovato alcun thread corrispondente.

Rappresentazione JSON 
{
  "name": string,
  "threadKey": string
}
Campi
name

string

Identificatore. Nome risorsa del thread.

Esempio: spaces/{space}/threads/{thread}
threadKey

string

Facoltativo. Input per la creazione o l'aggiornamento di un thread. In caso contrario, solo output. ID del thread. Supporta fino a 4000 caratteri.

Questo ID è univoco per l'app di Chat che lo imposta. Ad esempio, se più app di Chat creano un messaggio utilizzando la stessa chiave thread, i messaggi vengono pubblicati in thread diversi. Per rispondere in un thread creato da una persona o da un'altra app di Chat, specifica invece il campo name del thread.

ActionResponse

Parametri che un'app di Chat può utilizzare per configurare la modalità di pubblicazione della risposta.

Rappresentazione JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Campi
type

enum (ResponseType)

Solo input. Il tipo di risposta dell'app di Chat.
url

string

Solo input. URL per l'autenticazione o la configurazione degli utenti. (Solo per i tipi di risposta REQUEST_CONFIG.)
dialogAction

object (DialogAction)

Solo input. Una risposta a un evento di interazione relativo a una finestra di dialogo. Deve essere accompagnato da ResponseType.Dialog.
updatedWidget

object (UpdatedWidget)

Solo input. La risposta del widget aggiornato.

ResponseType

Il tipo di risposta dell'app di Chat.

Enum
TYPE_UNSPECIFIED Tipo predefinito gestito come NEW_MESSAGE.
NEW_MESSAGE Pubblicare un nuovo messaggio nell'argomento.
UPDATE_MESSAGE Aggiorna il messaggio dell'app di Chat. Questa operazione è consentita solo per un evento CARD_CLICKED in cui il tipo di mittente del messaggio è BOT.
UPDATE_USER_MESSAGE_CARDS Aggiorna le schede nel messaggio di un utente. Questa operazione è consentita solo come risposta a un evento MESSAGE con un URL corrispondente o a un evento CARD_CLICKED in cui il tipo di mittente del messaggio è HUMAN. Il testo viene ignorato.
REQUEST_CONFIG Chiedi privatamente all'utente un'ulteriore autenticazione o configurazione.
DIALOG Presenta una finestra di dialogo.
UPDATE_WIDGET Query delle opzioni di completamento automatico del testo del widget.

DialogAction

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

Rappresentazione JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
Campi
actionStatus

object (ActionStatus)

Solo input. Stato di una richiesta di richiamo o invio di una finestra di dialogo. Se necessario, mostra uno stato e un messaggio agli utenti. Ad esempio, in caso di errore o esito positivo.
Azione da eseguire. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
dialog

object (Dialog)

Solo input. Finestra di dialogo per la richiesta.
Fine dei campi che si escludono a vicenda.

Dialog

Wrapper attorno al corpo della scheda della finestra di dialogo.

Rappresentazione JSON 
{
  "body": {
    object (Card)
  }
}
Campi
body

object (Card)

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

ActionStatus

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

Rappresentazione JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
Campi
statusCode

enum (Code)

Il codice di stato.
userFacingMessage

string

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

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 Status ricevuto da un altro spazio di indirizzi appartiene a uno spazio di errore non noto in questo spazio di indirizzi. Anche gli errori generati dalle API che non restituiscono informazioni sufficienti sull'errore possono essere convertiti in questo errore.

Mappatura HTTP: 500 Errore interno del server
INVALID_ARGUMENT

Il client ha specificato un argomento non valido. Tieni presente che questo valore è diverso da FAILED_PRECONDITION. INVALID_ARGUMENT indica argomenti problematici indipendentemente dallo stato del sistema (ad esempio, un nome file non valido).

Mappatura HTTP: 400 Bad Request
DEADLINE_EXCEEDED

La scadenza è trascorsa prima che l'operazione potesse essere completata. Per le operazioni che modificano 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 stata ritardata abbastanza da far scadere la scadenza.

Mappatura HTTP: 504 Gateway Timeout
NOT_FOUND

Impossibile trovare un'entità richiesta (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 una funzionalità o per una lista consentita non documentata, è possibile utilizzare NOT_FOUND. Se una richiesta viene rifiutata per alcuni utenti all'interno di una classe di utenti, ad esempio controllo dell'accesso basato sugli utenti, è necessario utilizzare PERMISSION_DENIED.

Mappatura HTTP: 404 - Non trovato
ALREADY_EXISTS

L'entità che un client ha tentato di creare (ad es. file o directory) esiste già.

Mappatura HTTP: 409 Conflict
PERMISSION_DENIED

Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. PERMISSION_DENIED non deve essere utilizzato per i rifiuti causati dall'esaurimento di una risorsa (per questi errori utilizza invece RESOURCE_EXHAUSTED). PERMISSION_DENIED non deve essere utilizzato se il chiamante non può essere identificato (per questi errori utilizza UNAUTHENTICATED). Questo codice di errore non implica che la richiesta sia valida o che l'entità richiesta esista o soddisfi altre precondizioni.

Mappatura HTTP: 403 Forbidden
UNAUTHENTICATED

La richiesta non ha credenziali di autenticazione valide per l'operazione.

Mappatura HTTP: 401 Unauthorized
RESOURCE_EXHAUSTED

Alcune risorse sono state esaurite, ad esempio una quota per utente o l'intero file system.

Mappatura HTTP: 429 Too Many Requests
FAILED_PRECONDITION

L'operazione è stata rifiutata perché il sistema non si trova in uno 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 dei servizi possono utilizzare le seguenti linee guida per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE: (a) Utilizza UNAVAILABLE se il client può riprovare solo la chiamata non riuscita. (b) Utilizza ABORTED se il client deve riprovare a un livello superiore. Ad esempio, quando un test-and-set specificato dal client non va a buon fine, indicando che il client deve riavviare una sequenza di lettura-modifica-scrittura. (c) Utilizza FAILED_PRECONDITION se il client non deve riprovare finché lo stato del sistema non è stato esplicitamente corretto. Ad esempio, se un comando "rmdir" non va a buon fine perché la directory non è vuota, deve essere restituito FAILED_PRECONDITION, poiché il client non deve riprovare a meno che i file non vengano eliminati dalla directory.

Mappatura HTTP: 400 Bad Request
ABORTED

L'operazione è stata interrotta, in genere a causa di un problema di concorrenza, ad esempio un errore di controllo del sequencer o l'interruzione di una transazione.

Consulta le linee guida riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mappatura HTTP: 409 Conflict
OUT_OF_RANGE

È stato eseguito un tentativo di operazione oltre l'intervallo valido. Ad esempio, ricerca o lettura oltre la fine del file.

A differenza di INVALID_ARGUMENT, questo errore indica un problema che potrebbe essere risolto se lo stato del sistema cambia. Ad esempio, un file system a 32 bit genererà INVALID_ARGUMENT se viene richiesto di leggere un offset non compreso nell'intervallo [0,2^32-1], ma genererà OUT_OF_RANGE se viene richiesto di leggere un offset oltre le dimensioni attuali del file.

Esiste una certa sovrapposizione tra FAILED_PRECONDITION e OUT_OF_RANGE. Ti consigliamo di utilizzare OUT_OF_RANGE (l'errore più specifico) quando applicabile, in modo che i chiamanti che eseguono l'iterazione in uno spazio possano cercare facilmente un errore OUT_OF_RANGE per rilevare quando hanno finito.

Mappatura HTTP: 400 Bad Request
UNIMPLEMENTED

L'operazione non è implementata o non è supportata/abilitata in questo servizio.

Mappatura HTTP: 501 Non implementato
INTERNAL

Errori interni. Ciò significa che alcune invarianti previste dal sistema sottostante sono state violate. Questo codice di errore è riservato a errori gravi.

Mappatura HTTP: 500 Errore interno del server
UNAVAILABLE

Il servizio non è al momento disponibile. È molto probabile che si tratti 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 riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mappatura HTTP: 503 Service Unavailable
DATA_LOSS

Perdita o danneggiamento dei dati non recuperabili.

Mappatura HTTP: 500 Errore interno del server

UpdatedWidget

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

Rappresentazione JSON 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
Campi
widget

string

L'ID del widget aggiornato. L'ID deve corrispondere a quello del widget che ha attivato la richiesta di aggiornamento.
Il widget è stato aggiornato in risposta a un'azione dell'utente. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
suggestions

object (SelectionItems)

Elenco dei risultati del completamento automatico del widget
Fine dei campi che si escludono a vicenda.

SelectionItems

Elenco dei risultati di completamento automatico del widget.

Rappresentazione JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
Campi
items[]

object (SelectionItem)

Un array di oggetti SelectionItem.

SlashCommand

Metadati relativi a un comando slash in Google Chat.

Rappresentazione JSON 
{
  "commandId": string
}
Campi
commandId

string (int64 format)

L'ID del comando slash.

MatchedUrl

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

Rappresentazione JSON 
{
  "url": string
}
Campi
url

string

Solo output. L'URL corrispondente.

EmojiReactionSummary

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

Rappresentazione JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Campi
emoji

object (Emoji)

Solo output. Emoji associata alle reazioni.
reactionCount

integer

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 (DeletionType)
}
Campi
deletionType

enum (DeletionType)

Indica chi ha eliminato il messaggio.

DeletionType

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

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

QuotedMessageMetadata

Informazioni su un messaggio citato da un altro messaggio.

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

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

Rappresentazione JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
Campi
name

string

Obbligatorio. Nome della risorsa del messaggio citato.

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

string (Timestamp format)

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

Se il messaggio è stato modificato, utilizza questo campo, lastUpdateTime. Se il messaggio non è mai stato modificato, utilizza createTime.

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

enum (QuoteType)

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

object (QuotedMessageSnapshot)

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

object (ForwardedMetadata)

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

QuoteType

Il tipo di citazione del messaggio citato.

Enum
QUOTE_TYPE_UNSPECIFIED Riservato. Questo valore non è utilizzato.
REPLY

Quando quoteType è REPLY, puoi:

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

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

Quando quoteType è FORWARD, puoi citare:

  • Messaggio proveniente da uno spazio diverso.

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

QuotedMessageSnapshot

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

Rappresentazione JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
Campi
sender

string

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

string

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

string

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

object (Annotation)

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

object (Attachment)

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

ForwardedMetadata

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

Rappresentazione JSON 
{
  "space": string,
  "spaceDisplayName": string
}
Campi
space

string

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

string

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

AttachedGif

Un'immagine GIF specificata da un URL.

Rappresentazione JSON 
{
  "uri": string
}
Campi
uri

string

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
Campi
Il tipo di azione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
buttonList

object (ButtonList)

Un elenco di pulsanti.
Fine dei campi che si escludono a vicenda.

Elementi

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

Rappresentazione JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
Campi
citedSources[]

object (CitedSource)

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

object (Citation)

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

CitedSource

Un riferimento a una fonte di informazioni.

Rappresentazione JSON 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
Campi
title

string

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

string

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

object (Snippet)

Facoltativo. Snippet contenente informazioni direttamente dalla fonte.
footer

object (Footer)

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

Snippet

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

Rappresentazione JSON 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
Campi
text

string

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

object (ElementsImage)

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

ElementsImage

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

Rappresentazione JSON 
{

  "imageUri": string
}
Campi
Obbligatorio. Una delle rappresentazioni di immagini supportate. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
imageUri

string

Obbligatorio. Un URI accessibile pubblicamente per un'immagine.
Fine dei campi che si escludono a vicenda.

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

Rappresentazione JSON 
{
  "text": string
}
Campi
text

string

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

Citazione

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

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

Rappresentazione JSON 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
Campi
id

string

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

object (CitedSource)

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

MarkupSyntax

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

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

Metodi

create

 Crea un messaggio in uno spazio di Google Chat.

delete

 Elimina un messaggio.

get

 Restituisce i dettagli di un messaggio.

list

 Elenca i messaggi in uno spazio di cui il chiamante è membro, inclusi i messaggi di membri e spazi bloccati.

patch

 Aggiorna un messaggio.

replaceCards

 Sostituisce le schede incluse in un messaggio.
Cerca i messaggi in Google Chat a cui l'utente chiamante ha accesso.

update

 Aggiorna un messaggio.