Package google.chat.v1

ButtonList

Un elenco di pulsanti.

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

Solo input. La risposta del widget aggiornato.

SelectionItem

Un array di oggetti SelectionItem.

string

L'ID del widget aggiornato. L'ID deve corrispondere a quello del widget che ha attivato la richiesta di aggiornamento.

SelectionItems

Elenco dei risultati di completamento automatico del widget

Code

Il codice di stato.

string

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

AnnotationType

Il tipo di questa annotazione.

int32

Lunghezza della sottostringa nel corpo del messaggio in testo normale a cui corrisponde questa annotazione.

int32

Indice iniziale (in base 0, incluso) nel corpo del messaggio in testo normale a cui corrisponde questa annotazione.

UserMentionMetadata

I metadati della menzione dell'utente.

SlashCommandMetadata

I metadati di un comando slash.

RichLinkMetadata

I metadati per un link avanzato.

string

Solo output. L'URL che ospita l'immagine GIF.

string

Nome della risorsa dell'allegato, nel formato spaces/{space}/messages/{message}/attachments/{attachment}.

string

Solo output. Il nome file originale per i contenuti, non il percorso completo.

string

Solo output. Il tipo di contenuto (tipo MIME) del file.

string

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.

string

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.

AttachmentDataRef

Un riferimento ai dati dell'allegato. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati.

DriveDataRef

Solo output. Un riferimento all'allegato di Google Drive. Questo campo viene utilizzato con l'API Google Drive.

string

Il nome risorsa dei dati degli allegati. Questo campo viene utilizzato con l'API multimediale per scaricare i dati degli allegati.

string

Token opaco contenente un riferimento a un allegato caricato. Trattati dai client come una stringa opaca e utilizzata per creare o aggiornare i messaggi di Chat con allegati.

string

Obbligatorio se il messaggio contiene più schede. Identificatore univoco di una scheda in un messaggio.

Card

Una scheda. La dimensione massima è 32 kB.

string

Lo spazio della risorsa dello spazio di Chat collegato.

Formato: spaces/{space}

string

Il thread della risorsa dello spazio di Chat collegata.

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

string

Il messaggio della risorsa dello spazio di Chat collegata.

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

string

Obbligatorio. Nome della risorsa dello spazio in modalità di importazione.

Formato: spaces/{space}

Space

Lo spazio in modalità di importazione.

CardHeader

L'intestazione della scheda. Un'intestazione di solito contiene un titolo e un'immagine.

Section

Le sezioni sono separate da un separatore di linea.

CardAction

Le azioni di questa scheda.

string

Nome della carta.

string

L'etichetta che veniva visualizzata nella voce del menu azione.

OnClick

L'azione onclick per questo elemento dell'azione.

string

Il titolo deve essere specificato. L'intestazione ha un'altezza fissa: se vengono specificati sia un titolo che un sottotitolo, entrambi occupano una riga. Se viene specificato solo il titolo, questo occupa entrambe le righe.

string

Il sottotitolo dell'intestazione della scheda.

ImageStyle

Il tipo di immagine (ad esempio, bordo quadrato o bordo circolare).

string

L'URL dell'immagine nell'intestazione della scheda.

string

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.

WidgetMarkup

Una sezione deve contenere almeno un widget.

CustomEmoji

Obbligatorio. L'emoji personalizzata da creare.

string

Obbligatorio. Il nome della risorsa dello spazio per il quale creare l'appartenenza.

Formato: spaces/{space}

Membership

Obbligatorio. La relazione di appartenenza da creare.

Il campo memberType deve contenere un utente con i campi user.name e user.type compilati. Il server assegnerà un nome risorsa e sovrascriverà qualsiasi elemento specificato.

Quando un'app di Chat crea una relazione di appartenenza per un utente, deve utilizzare determinati ambiti di autorizzazione e impostare valori specifici per determinati campi:

• Quando esegui l'autenticazione come utente, è necessario l'ambito di autorizzazione chat.memberships.

• Quando esegui l'autenticazione come app, è necessario l'ambito di autorizzazione chat.app.memberships. L'autenticazione come app è disponibile in

• Imposta user.type su HUMAN e user.name con il formato users/{user}, dove {user} può essere l'indirizzo email dell'utente. Per gli utenti della stessa organizzazione Workspace, {user} può anche essere il id della persona dell'API People o il id dell'utente nell'API Directory. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi aggiungere l'utente allo spazio impostando membership.member.name su users/user@example.com o users/123456789.

Quando un'app di chat crea una relazione di appartenenza per se stessa, deve autenticarsi come utente] e utilizzare l'ambito chat.memberships.app, impostare user.type su BOT e impostare user.name su users/app.

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'chat.admin.memberships ambito OAuth 2.0.

La creazione di abbonamenti per app o la creazione di abbonamenti per utenti esterni all'organizzazione Google Workspace dell'amministratore non è supportata utilizzando l'accesso amministrativo.

string

Obbligatorio. Il nome della risorsa dello spazio in cui creare un messaggio.

Formato: spaces/{space}

Message

Obbligatorio. Corpo del messaggio.

string

(Facoltativo) Deprecato: utilizza thread.thread_key. ID del thread. Supporta fino a 4000 caratteri. Per avviare o aggiungere un messaggio a un thread, crea un messaggio e specifica un threadKey o il thread.name. Ad esempio, vedi Avviare o rispondere a un thread di messaggi.

string

(Facoltativo) Un ID richiesta univoco per questo messaggio. Se viene specificato un ID richiesta esistente, viene restituito il messaggio creato con quell'ID anziché crearne uno nuovo.

MessageReplyOption

(Facoltativo) Specifica se un messaggio avvia un thread o risponde a uno. Supportato solo negli spazi con un nome.

string

(Facoltativo) Un ID personalizzato per un messaggio. Consente alle app di Chat di recuperare, aggiornare o eliminare un messaggio senza dover archiviare l'ID assegnato dal sistema nel nome della risorsa del messaggio (rappresentato nel campo name del messaggio).

Il valore di questo campo deve soddisfare i seguenti requisiti:

• Inizia con client-. Ad esempio, client-custom-name è un ID personalizzato valido, ma custom-name non lo è.
• Deve contenere fino a 63 caratteri e solo lettere minuscole, numeri e trattini.
• Sia univoco all'interno di uno spazio. Un'app di chat non può utilizzare lo stesso ID personalizzato per messaggi diversi.

Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

string

Obbligatorio. Il messaggio in cui viene creata la reazione.

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

Reaction

Obbligatorio. La reazione da creare.

Space

Obbligatorio. I campi displayName e spaceType devono essere compilati. È supportato solo SpaceType.SPACE.

Se ricevi il messaggio di errore ALREADY_EXISTS, prova con un altro displayName. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

Se sei un membro del programma Anteprima per gli sviluppatori, puoi utilizzare SpaceType.GROUP_CHAT se importMode è impostato su true.

Lo spazio name è assegnato sul server, pertanto qualsiasi elemento specificato in questo campo verrà ignorato.

string

(Facoltativo) Un identificatore univoco per questa richiesta. È consigliato un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app Chat con un utente autenticato diverso, viene restituito un errore.

string

Identificatore. Il nome risorsa dell'emoji personalizzata, assegnato dal server.

Formato: customEmojis/{customEmoji}

string

Solo output. Chiave univoca per la risorsa di emoji personalizzate.

string

Immutabile. Nome fornito dall'utente per l'emoji personalizzata, che è 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: :valid-emoji-name:

string

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.

CustomEmojiPayload

Solo input. Dati di payload.

bytes

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.

string

Obbligatorio. Solo input. Il nome del file immagine.

Estensioni file supportate: .png, .jpg, .gif.

string

Obbligatorio. Nome della risorsa dell'emoji personalizzata da eliminare.

Formato: customEmojis/{customEmoji}

Puoi usare il nome dell'emoji come alias per {customEmoji}. Ad esempio, customEmojis/:example-emoji:, dove :example-emoji: è il nome dell'emoji personalizzata.

string

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 si elimina un'appartenenza umana, sono necessari l'ambito chat.memberships e il formato spaces/{space}/members/{member}. Puoi utilizzare l'email come alias per {member}. Ad esempio, spaces/{space}/members/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

Quando elimini un abbonamento a un'app, sono richiesti l'ambito chat.memberships.app e il formato spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app.

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.

L'eliminazione degli abbonamenti alle app in uno spazio non è supportata utilizzando l'accesso amministrativo.

string

Obbligatorio. Nome della risorsa del messaggio.

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

Se hai impostato un ID personalizzato per il messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

bool

Quando true, l'eliminazione di un messaggio comporta anche l'eliminazione delle relative risposte in thread. Quando false, se un messaggio ha risposte in thread, l'eliminazione non riesce.

Si applica solo quando l'autenticazione avviene come utente. Non ha alcun effetto se esegui l'autenticazione come app di Chat.

string

Obbligatorio. Nome della reazione da eliminare.

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

string

Obbligatorio. Nome risorsa dello spazio da eliminare.

Formato: spaces/{space}

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede l'chat.admin.delete ambito OAuth 2.0.

DeletionType

Indica chi ha eliminato il messaggio.

Card

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

ActionStatus

Solo input. Stato di una richiesta per richiamare o inviare una finestra di dialogo. Mostra uno stato e un messaggio agli utenti, se necessario. Ad esempio, in caso di errore o esito positivo.

Dialog

Solo input. Finestra di dialogo per la richiesta.

string

L'ID del file di Drive. Da utilizzare con l'API Drive.

DriveDataRef

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

string

Il tipo MIME della risorsa di Google Drive collegata.

string

Un'emoji di base rappresentata da una stringa Unicode.

CustomEmoji

Solo output. Un'emoji personalizzata.

Emoji

Emoji associate alle reazioni.

int32

Il numero totale di reazioni che utilizzano l'emoji associata.

string

Obbligatorio. Nome della risorsa dell'utente con cui trovare il messaggio diretto.

Formato: users/{user}, dove {user} è il valore id per la persona dell'API People o il valore id per l'utente nell'API Directory. Ad esempio, se l'ID profilo dell'API People è 123456789, puoi trovare un messaggio diretto con quella persona utilizzando users/123456789 come name. Una volta eseguito l'autenticazione come utente, puoi utilizzare l'email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

string

Obbligatorio. Nome della risorsa dell'allegato, nel formato spaces/{space}/messages/{message}/attachments/{attachment}.

string

Obbligatorio. Nome risorsa dell'emoji personalizzata.

Formato: customEmojis/{customEmoji}

Puoi utilizzare il nome dell'emoji come alias per {customEmoji}. Ad esempio, customEmojis/:example-emoji:, dove :example-emoji: è il nome dell'emoji personalizzata.

string

Obbligatorio. Nome della risorsa dell'abbonamento da recuperare.

Per ottenere l'abbonamento dell'app utilizzando l'autenticazione utente, puoi eventualmente utilizzare spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app

Puoi utilizzare l'indirizzo email dell'utente come alias per {member}. Ad esempio, spaces/{space}/members/example@gmail.com, dove example@gmail.com è l'indirizzo email dell'utente di Google Chat.

bool

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede gli ambiti OAuth 2.0 chat.admin.memberships o chat.admin.memberships.readonly.

L'ottenimento di abbonamenti alle app in uno spazio non è supportato quando si utilizza l'accesso amministrativo.

string

Obbligatorio. Nome della risorsa del messaggio.

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

Se hai impostato un ID personalizzato per il messaggio, puoi utilizzare il valore del campo clientAssignedMessageId per {message}. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

string

Obbligatorio. Il nome della risorsa dell'evento dello spazio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

string

Obbligatorio. Nome risorsa dello stato di lettura dello spazio da recuperare.

Supporta solo il recupero dello stato di lettura per l'utente chiamante.

Per fare riferimento all'utente che chiama, imposta una delle seguenti opzioni:

• L'alias me. Ad esempio, users/me/spaces/{space}/spaceReadState.

• Il relativo indirizzo email Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

• Il proprio ID utente. Ad esempio, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

string

Obbligatorio. Nome risorsa dello spazio, nel formato spaces/{space}.

Formato: spaces/{space}

bool

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede gli ambiti OAuth 2.0 chat.admin.spaces o chat.admin.spaces.readonly.

string

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:

• L'alias me. Ad esempio, users/me/spaces/{space}/threads/{thread}/threadReadState.

• Il relativo indirizzo email Workspace. Ad esempio, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

• Il proprio ID utente. Ad esempio, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Nome della risorsa per un gruppo Google.

Rappresenta un gruppo nell'API Cloud Identity Groups.

Formato: groups/{group}

int32

(Facoltativo) Il numero massimo di emoji personalizzate restituito. 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.

string

(Facoltativo) (Se riprendi da una query precedente).

Un token di pagina ricevuto da una precedente chiamata dell'emoji personalizzata dell'elenco. Forniscilo per recuperare la pagina successiva.

Quando viene visualizzata la paginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token pagina. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti.

string

(Facoltativo) Un filtro di query.

Supporta il filtro per autore.

Per filtrare in base al creator, devi specificare un valore valido. Al momento, solo creator("users/me") e NOT creator("users/me") sono accettati per filtrare le emoji personalizzate in base al fatto che siano state create o meno dall'utente che chiama.

Ad esempio, la seguente query restituisce emoji personalizzate create dal chiamante:

creator("users/me")

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

CustomEmoji

Elenco non ordinato. Elenco di emoji personalizzate nella pagina richiesta (o nella prima).

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

string

Obbligatorio. Il nome della risorsa dello spazio per cui recuperare un elenco di membri.

Formato: space/{space}

int32

(Facoltativo) Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire meno di questo valore.

Se non specificato, vengono restituite al massimo 100 abbonamenti.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.

string

(Facoltativo) Un token di pagina ricevuto da una chiamata precedente per elencare le iscrizioni. Fornisci 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.

string

(Facoltativo) Un filtro per query.

Puoi filtrare le iscrizioni in base al ruolo (role) e al tipo (member.type) di un membro.

Per filtrare in base al ruolo, imposta role su ROLE_MEMBER o ROLE_MANAGER.

Per filtrare per tipo, imposta member.type su HUMAN o BOT. Puoi anche filtrare per member.type utilizzando l'operatore !=.

Per filtrare in base a ruolo e tipo, utilizza l'operatore AND. Per filtrare in base a ruolo o tipo, utilizza l'operatore OR.

member.type = "HUMAN" o member.type != "BOT" è obbligatorio quando use_admin_access è impostato su true. Gli altri filtri dei tipi di membri verranno rifiutati.

Ad esempio, le seguenti query sono valide:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Le seguenti query non sono valide:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

bool

(Facoltativo) Quando true, oltre ad altri tipi di abbonamenti, restituisce anche gli abbonamenti associati a un Google Group. Se è impostato un filter, gli abbonamenti Google Group che non corrispondono ai criteri di filtro non vengono restituiti.

bool

(Facoltativo) Quando true, restituisce anche gli abbonamenti associati ai membri invited, oltre ad altri tipi di abbonamenti. Se viene impostato un filtro, le appartenenze a invited che non corrispondono ai criteri del filtro non vengono restituite.

Attualmente richiede l'autenticazione dell'utente.

bool

Quando true, il metodo viene eseguito utilizzando i privilegi amministrativi di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

Se si utilizza l'accesso amministrativo, non è possibile elencare gli abbonamenti all'app in uno spazio.

Membership

Elenco non ordinato. Elenco degli abbonamenti nella pagina richiesta (o prima).

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

string

Obbligatorio. Il nome della risorsa dello spazio da cui elencare i messaggi.

Formato: spaces/{space}

int32

Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire meno messaggi di questo valore.

Se non specificato, vengono restituiti al massimo 25.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.

string

Facoltativo, se riprendi da una query precedente.

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. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.

string

Un filtro di query.

Puoi filtrare i messaggi per data (create_time) e thread (thread.name).

Per filtrare i messaggi in base alla data di creazione, specifica create_time con un timestamp nel formato RFC-3339 e virgolette doppie. Ad esempio: "2023-04-21T11:30:00-04:00". Puoi utilizzare l'operatore maggiore di > per elencare i messaggi creati dopo un timestamp o l'operatore minore di < per elencare i messaggi creati prima di un timestamp. Per filtrare i messaggi in un intervallo di tempo, utilizza l'operatore AND tra due timestamp.

Per filtrare per thread, specifica thread.name, formattato come spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare in base sia al thread che alla data, utilizza l'operatore AND nella query.

Ad esempio, le seguenti query sono valide:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

string

Facoltativo, se riprendi da una query precedente.

L'ordinamento dell'elenco dei messaggi. Specifica un valore da ordinare tramite un'operazione di ordinamento. I valori validi per l'operazione di ordinamento sono:

• ASC per l'ordine crescente.

• DESC per decrescente.

L'ordinamento predefinito è create_time ASC.

bool

Se includere i messaggi eliminati. I messaggi eliminati includono l'ora e i metadati relativi alla loro eliminazione, ma i contenuti dei messaggi non sono disponibili.

Message

Elenco dei messaggi.

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

string

Obbligatorio. Il messaggio a cui gli utenti hanno aggiunto una reazione.

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

int32

(Facoltativo) Il numero massimo di reazioni restituite. Il servizio può restituire meno reazioni di questo valore. Se non specificato, il valore predefinito è 25. Il valore massimo è 200; i valori superiori a 200 vengono modificati in 200.

string

(Facoltativo) (se riprendi da una query precedente).

Un token di pagina ricevuto da una precedente chiamata di reazioni 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. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti.

string

(Facoltativo) Un filtro per query.

Puoi filtrare le reazioni per emoji (emoji.unicode o emoji.custom_emoji.uid) e utente (user.name).

Per filtrare le reazioni per più emoji o utenti, unisci campi simili con l'operatore OR, ad esempio emoji.unicode = "🙂" OR emoji.unicode = "👍" e user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Per filtrare le reazioni per emoji e utente, utilizza l'operatore AND, ad esempio emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Se la query utilizza sia AND sia OR, raggruppale tra parentesi.

Ad esempio, le seguenti query sono valide:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Le seguenti query non sono valide:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

Reaction

Elenco delle reazioni nella pagina richiesta (o nella prima).

string

Token di continuazione per recuperare la pagina di risultati successiva. È vuoto per l'ultima pagina dei risultati.

string

Obbligatorio. Nome della risorsa dello spazio di Google Chat in cui si sono verificati gli eventi.

Formato: spaces/{space}.

int32

(Facoltativo) Il numero massimo di eventi dello spazio restituiti. Il servizio potrebbe restituire un valore inferiore a questo valore.

I valori negativi restituiscono un errore INVALID_ARGUMENT.

string

Un token di pagina ricevuto da una precedente chiamata di eventi dello spazio elenco. Fornisci questo valore per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token della pagina. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti.

string

Obbligatorio. Un filtro per query.

Devi specificare almeno un tipo di evento (event_type) utilizzando l'operatore has :. Per filtrare in base a più tipi di eventi, utilizza l'operatore OR. Ometti tipi di eventi batch nel filtro. La richiesta restituisce automaticamente tutti gli eventi batch correlati. Ad esempio, se filtri per le nuove reazioni (google.workspace.chat.reaction.v1.created), il server restituisce anche gli eventi batch delle nuove reazioni (google.workspace.chat.reaction.v1.batchCreated). Per un elenco dei tipi di eventi supportati, consulta la documentazione di riferimento di SpaceEvents.

Se vuoi, puoi anche filtrare per ora di inizio (start_time) e ora di fine (end_time):

• start_time: timestamp esclusivo da cui iniziare a elencare gli eventi dello spazio. Puoi elencare gli eventi che si sono verificati fino a 28 giorni fa. Se non specificato, vengono elencati gli eventi dello spazio degli ultimi 28 giorni.
• end_time: timestamp inclusivo fino al quale gli eventi dello spazio vengono elencati. Se non specificato, elenca gli eventi fino al momento della richiesta.

Per specificare un'ora di inizio o di fine, utilizza l'operatore = uguale a e il formato in RFC-3339. Per filtrare in base a start_time e end_time, utilizza l'operatore AND.

Ad esempio, le seguenti query sono valide:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Le seguenti query non sono valide:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

SpaceEvent

I risultati vengono restituiti in ordine cronologico (primo evento meno recente). Nota: il campo permissionSettings non viene restituito nell'oggetto Space per le richieste di elenco.

string

Token di continuazione utilizzato per recuperare più eventi. Se questo campo viene omesso, non verranno visualizzate altre pagine.

int32

(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 INVALID_ARGUMENT.

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata agli spazi di elenco. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso può portare a risultati imprevisti.

string

(Facoltativo) Un filtro per query.

Puoi filtrare gli spazi in base al tipo (space_type).

Per filtrare in base al tipo di spazio, devi specificare un valore enum valido, come SPACE o GROUP_CHAT (il space_type non può essere SPACE_TYPE_UNSPECIFIED). Per eseguire query su più tipi di spazi, utilizza l'operatore OR.

Ad esempio, le seguenti query sono valide:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

Space

Elenco degli spazi nella pagina richiesta (o nella prima). Nota: il campo permissionSettings non viene restituito nell'oggetto Space per le richieste di elenco.

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

string

Solo output. L'URL con corrispondenza.

string

Nome della risorsa dell'abbonamento, assegnato dal server.

Formato: spaces/{space}/members/{member}

MembershipState

Solo output. Stato dell'abbonamento.

MembershipRole

(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 UpdateMembership.

Timestamp

(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.

Timestamp

(Facoltativo) Immutabile. La data e l'ora di eliminazione dell'abbonamento, ad esempio quando un membro ha abbandonato uno spazio o è stato rimosso. Questo campo è solo di output, tranne quando viene utilizzato per importare gli abbonamenti storici negli spazi in modalità di importazione.

User

L'utente o l'app di Google Chat a cui corrisponde l'abbonamento. Se la tua app di chat si autentica come utente, l'output compila name e type dell'utente.

Group

Il gruppo Google a cui corrisponde l'iscrizione.

La lettura o la modifica delle iscrizioni per Google Gruppi richiede l'autenticazione dell'utente.

MembershipCreatedEventData

Un elenco dei nuovi abbonamenti.

MembershipDeletedEventData

Un elenco di abbonamenti eliminati.

MembershipUpdatedEventData

Un elenco degli abbonamenti aggiornati.

Membership

Il nuovo abbonamento.

Membership

L'abbonamento eliminato. Vengono compilati solo i campi name e state.

Membership

L'abbonamento aggiornato.

string

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 al messaggio. Ad esempio: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Se imposti un ID personalizzato durante la creazione di un messaggio, puoi utilizzarlo per specificarlo 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.

User

Solo output. L'utente che ha creato il messaggio. Se l'app Chat si autentica come utente, l'output compila i campi utente name e type.

Timestamp

(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.

Timestamp

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

Timestamp

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

string

Corpo del messaggio in testo normale. Il primo link a un'immagine, un video o una pagina web genera un chip di anteprima. Puoi anche @menzionare un utente di Google Chat o tutte le persone presenti nello spazio.

Per ulteriori informazioni sulla creazione di messaggi di testo, vedi Inviare un messaggio.

string

Solo output. Contiene il messaggio text con i markup aggiunti per comunicare la formattazione. Questo campo potrebbe non acquisire tutta la formattazione visibile nella UI, ma include quanto segue:

• Sintassi del markup per grassetto, corsivo, barrato, carattere monospazio, blocco di carattere monospazio ed elenco puntato.

• L'utente menziona nel 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 :{emoji_name}:, ad esempio :smile:. Questo non si applica alle emoji Unicode, ad esempio U+1F600 per un'emoji con un sorriso.

Per ulteriori informazioni, vedi Visualizzare la formattazione del testo inviata in un messaggio.

Card

Deprecato: utilizza cards_v2.

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 e cards_v2 possono avere una dimensione massima di 32 KB.

CardWithId

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.

Annotation

Solo output. Annotazioni associate a text in questo messaggio.

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 compila lo spazio name.

string

Una descrizione in testo normale delle schede del messaggio, utilizzata quando non è possibile visualizzare le schede effettive, ad esempio per le notifiche su dispositivi mobili.

ActionResponse

Solo input. Parametri che un'app di chat può utilizzare per configurare il modo in cui viene pubblicata la sua risposta.

string

Solo output. Testo normale del messaggio con tutte le menzioni dell'app Chat rimosse.

SlashCommand

Solo output. Informazioni sul comando slash, se applicabile.

Attachment

Allegato caricato dall'utente.

MatchedUrl

Solo output. Un URL in spaces.messages.text che corrisponde a un pattern di anteprima del link. Per ulteriori informazioni, consulta la sezione Link di anteprima.

bool

Solo output. Quando true, il messaggio è una risposta in un thread di risposta. 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 nei thread, questo campo è sempre false.

string

(Facoltativo) Un ID personalizzato per il messaggio. Puoi utilizzare il campo per identificare un messaggio o per ricevere, eliminare o aggiornare un messaggio. Per impostare un ID personalizzato, specifica il campo messageId quando crei il messaggio. Per maggiori dettagli, vedi Assegnare un nome a un messaggio.

EmojiReactionSummary

Solo output. L'elenco di riepiloghi di reazioni emoji sul messaggio.

User

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:

• Collegamenti
• Widget accessori

Per maggiori dettagli, vedi Inviare un messaggio privato.

DeletionMetadata

Solo output. Informazioni su un messaggio eliminato. Un messaggio viene eliminato quando viene impostato delete_time.

QuotedMessageMetadata

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.

AttachedGif

Solo output. GIF allegate al messaggio.

AccessoryWidget

Uno o più widget interattivi che vengono visualizzati nella parte inferiore di un messaggio. Puoi aggiungere widget accessori ai messaggi che contengono testo, schede o testo e schede. Non 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 delle app.

MessageCreatedEventData

Un elenco di nuovi messaggi.

MessageDeletedEventData

Un elenco di messaggi eliminati.

MessageUpdatedEventData

Un elenco di messaggi aggiornati.

Message

Il nuovo messaggio.

Message

Il messaggio eliminato. Vengono compilati solo i campi name, createTime, deleteTime e deletionMetadata.

Message

Il messaggio aggiornato.

string

Solo output. Nome della risorsa del messaggio tra virgolette.

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

Timestamp

Solo output. Il timestamp di creazione del messaggio citato o dell'ultimo aggiornamento di quest'ultimo.

string

Il nome della risorsa della reazione.

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

User

Solo output. L'utente che ha creato la reazione.

Emoji

L'emoji utilizzata nella reazione.

ReactionCreatedEventData

Un elenco di nuove reazioni.

ReactionDeletedEventData

Un elenco di reazioni eliminate.

Reaction

La nuova reazione.

Reaction

La reazione eliminata.

string

L'URI di questo link.

RichLinkType

Il tipo di link avanzato.

DriveLinkData

Dati per un link di Drive.

ChatSpaceLinkData

Dati per il link a uno spazio di Chat.

bool

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'ambito OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

Al momento, questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo true.

int32

Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore.

Se non specificati, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000.

string

Un token, ricevuto dalla chiamata precedente agli spazi di ricerca. Specifica questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti.

string

Obbligatorio. Una query di ricerca.

Puoi eseguire ricerche utilizzando i seguenti parametri:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

create_time e last_active_time accettano un timestamp in formato RFC-3339 e gli operatori di confronto supportati sono: =, <, >, <=, >=.

customer è obbligatorio e viene utilizzato per indicare da quale cliente recuperare gli spazi. customers/my_customer è l'unico valore supportato.

display_name accetta solo l'operatore HAS (:). Il testo da abbinare viene prima tokenizzato in token e ogni token viene associato, senza distinzione tra maiuscole e minuscole e indipendentemente dal prefisso, come sottostringa in qualsiasi punto dello spazio display_name. Ad esempio, Fun Eve corrisponde a Fun event o The evening was fun, ma non a notFun event o even.

external_user_allowed accetta true o false.

space_history_state accetta solo i valori del campo historyState di una risorsa space.

space_type è obbligatorio e l'unico valore valido è SPACE.

In diversi campi, sono supportati solo gli operatori AND. Un esempio valido è space_type = "SPACE" AND display_name:"Hello", mentre un esempio non valido è space_type = "SPACE" OR display_name:"Hello".

Nello stesso campo, space_type non supporta gli operatori AND o OR. display_name, "space_history_state" e "external_user_allowed" supporta solo gli operatori OR. last_active_time e create_time supportano sia gli operatori AND che OR. AND può essere utilizzato solo per rappresentare un intervallo, ad esempio last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

I seguenti esempi di query sono validi:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

(Facoltativo) Come viene ordinato l'elenco degli spazi.

Gli attributi supportati per l'ordinamento sono:

• membership_count.joined_direct_human_user_count: indica il numero di utenti che si sono uniti direttamente a uno spazio.
• last_active_time: indica la data e l'ora in cui l'ultimo elemento idoneo viene aggiunto a qualsiasi argomento di questo spazio.
• create_time: indica l'ora di creazione dello spazio.

I valori validi per l'operazione di ordinamento sono:

• ASC per ordine crescente. Valore predefinito.

• DESC per la modalità discendente.

La sintassi supportata è:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Una pagina degli spazi richiesti.

string

Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci saranno pagine successive.

int32

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.

Space

Obbligatorio. Il campo Space.spaceType è obbligatorio.

Per creare uno spazio, imposta Space.spaceType su SPACE e imposta Space.displayName. Se ricevi il messaggio di errore ALREADY_EXISTS durante la configurazione di uno spazio, prova un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Per creare una chat di gruppo, imposta Space.spaceType su GROUP_CHAT. Non impostare Space.displayName.

Per creare una conversazione 1:1 tra persone, imposta Space.spaceType su DIRECT_MESSAGE e imposta Space.singleUserBotDm su false. Non impostare Space.displayName o Space.spaceDetails.

Per creare una conversazione 1:1 tra una persona e l'app di Chat che effettua la chiamata, imposta Space.spaceType su DIRECT_MESSAGE e Space.singleUserBotDm su true. Non impostare Space.displayName o Space.spaceDetails.

Se esiste già uno spazio DIRECT_MESSAGE, viene restituito anziché crearne uno nuovo.

string

(Facoltativo) Un identificatore univoco per questa richiesta. È consigliabile utilizzare un UUID casuale. Se viene specificato un ID richiesta esistente, viene restituito lo spazio creato con quell'ID anziché crearne uno nuovo. Se specifichi un ID richiesta esistente della stessa app di Chat con un utente autenticato diverso, viene restituito un errore.

Membership

(Facoltativo) Gli utenti o i gruppi di Google Chat da invitare a partecipare allo spazio. Ometti l'utente chiamante poiché viene aggiunto automaticamente.

Attualmente, il set consente fino a 20 abbonamenti (oltre a quello del chiamante).

Per l'appartenenza umana, il campo Membership.member deve contenere un user con name compilato (formato: users/{user}) e type impostato su User.Type.HUMAN. Puoi aggiungere utenti umani solo durante la configurazione di uno spazio (l'aggiunta di app di Chat è supportata solo per la configurazione dei messaggi diretti con l'app di chiamata). Puoi anche aggiungere membri utilizzando l'indirizzo email dell'utente come alias per {user}. Ad esempio, user.name può essere users/example@gmail.com. Per invitare utenti di Gmail o utenti di domini Google Workspace esterni, è necessario utilizzare l'indirizzo email dell'utente per {user}.

Per l'appartenenza a gruppi Google, il campo Membership.group_member deve contenere un elemento group con name compilato (formato groups/{group}). Puoi aggiungere gruppi Google solo se imposti Space.spaceType su SPACE.

Facoltativo se imposti Space.spaceType su SPACE.

Obbligatorio quando si imposta Space.spaceType su GROUP_CHAT, insieme ad almeno due abbonamenti.

Obbligatorio quando imposti Space.spaceType su DIRECT_MESSAGE con un utente umano, insieme a un solo abbonamento.

Deve essere vuoto quando viene creata una conversazione 1:1 tra una persona e l'app Chat che effettua la chiamata (quando Space.spaceType è impostato su DIRECT_MESSAGE e Space.singleUserBotDm su true).

int64

L'ID del comando slash invocato.

User

L'app Chat di cui è stato invocato il comando.

Type

Il tipo di comando slash.

string

Il nome del comando slash richiamato.

int64

L'ID del comando slash invocato.

bool

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

string

Nome della risorsa dello spazio.

Formato: spaces/{space}

Dove {space} rappresenta l'ID assegnato dal sistema allo spazio. Puoi ottenere l'ID spazio chiamando il metodo spaces.list() o dall'URL dello spazio. Ad esempio, se l'URL dello spazio è https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID spazio è AAAAAAAAA.

Type

Solo output. Deprecato: usa invece space_type. Il tipo di uno spazio.

SpaceType

Il tipo di spazio. Obbligatorio quando si crea uno spazio o si aggiorna il tipo di uno spazio. Output solo per altri utilizzi.

bool

(Facoltativo) Indica se lo spazio è un messaggio diretto tra un'app Chat e una singola persona.

bool

Solo output. Deprecato: usa invece spaceThreadingState. Indica se i messaggi sono organizzati in thread in questo spazio.

string

Il nome visualizzato dello spazio. Obbligatorio quando crei uno spazio con un spaceType pari a SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS quando crei uno spazio o aggiorni il displayName, prova con un altro displayName. Questo nome visualizzato potrebbe essere già utilizzato da uno spazio esistente all'interno dell'organizzazione Google Workspace.

Per i messaggi diretti, questo campo potrebbe essere vuoto.

Supporta fino a 128 caratteri.

bool

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:

• L'utente autenticato utilizza un account consumer (account utente non gestito). Per impostazione predefinita, uno spazio creato da un account consumer consente l'accesso a qualsiasi utente di Google Chat.

Questo campo viene restituito solo per gli spazi esistenti.

SpaceThreadingState

Solo output. Lo stato della conversazione in thread nello spazio di Chat.

SpaceDetails

Dettagli sullo spazio, tra cui descrizione e regole.

HistoryState

Lo stato della cronologia dei messaggi per i messaggi e i thread in questo spazio.

bool

(Facoltativo) Indica se questo spazio è stato creato in Import Mode nell'ambito di una migrazione dei dati in Google Workspace. Durante l'importazione, gli spazi non sono visibili agli utenti finché l'operazione non è completata.

La creazione di uno spazio in Import Moderichiede l'autenticazione dell'utente.

Timestamp

(Facoltativo) Immutabile. Per gli spazi creati in Chat, la data e l'ora di creazione dello 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 spaceType è GROUP_CHAT o SPACE.

Timestamp

Solo output. Timestamp dell'ultimo messaggio nello spazio.

bool

Solo output. Per gli spazi con messaggi diretti (MD) 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 parte degli amministratori, l'app Chat deve includere la messaggistica diretta.

MembershipCount

Solo output. Il numero di abbonamenti uniti raggruppati per tipo di abbonamento. Compilato quando space_type è SPACE, DIRECT_MESSAGE o GROUP_CHAT.

AccessSettings

(Facoltativo) Specifica l'impostazione di accesso dello spazio. Viene compilato solo quando space_type è SPACE.

string

Solo output. L'URI che consente a un utente di accedere allo spazio.

string

(Facoltativo) Immutabile. L'ID cliente del dominio dello spazio. È obbligatorio solo per la creazione di uno spazio con autenticazione app e il valore SpaceType è SPACE, altrimenti non deve essere impostato.

Nel formato customers/{customer}, dove customer è id della [risorsa cliente dell'SDK Admin](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Anche le app private possono utilizzare l'alias customers/my_customer per creare lo spazio nella stessa organizzazione Google Workspace dell'app.

Per i messaggi diretti, questo campo non viene compilato.

PredefinedPermissionSettings

(Facoltativo) Solo input. Impostazioni predefinite per le autorizzazioni per lo spazio, da inserire solo durante la creazione di uno spazio. Se il campo non viene impostato, viene creato uno spazio di collaborazione. Dopo aver creato lo spazio, le impostazioni vengono inserite nel campo PermissionSettings.

PermissionSettings

(Facoltativo) Impostazioni delle autorizzazioni per gli spazi esistenti. Input per l'aggiornamento delle impostazioni esatte relative alle autorizzazioni per gli spazi, in cui le impostazioni di autorizzazione esistenti vengono sostituite. L'output elenca le impostazioni di autorizzazione correnti.

AccessState

Solo output. Indica lo stato di accesso allo spazio.

string

(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 per un pubblico di destinazione.

Formato: audiences/{audience}

Per utilizzare il pubblico di destinazione predefinito per l'organizzazione Google Workspace, imposta il valore audiences/default.

La lettura del pubblico di destinazione supporta:

• Autenticazione utente

• Autenticazione app con approvazione dell'amministratore con l'ambito chat.app.spaces in

Questo campo non viene compilato quando utilizzi l'ambito chat.bot con l'autenticazione delle app.

L'impostazione del pubblico di destinazione richiede l'autenticazione dell'utente.

int32

Numero di utenti che si sono uniti direttamente allo spazio, esclusi gli utenti che si sono uniti tramite l'iscrizione a un gruppo unito.

int32

Numero di tutti i gruppi che sono entrati direttamente nello spazio.

bool

Indica se i gestori degli spazi dispongono di questa autorizzazione.

bool

Indica se i membri non gestori dispongono di questa autorizzazione.

PermissionSetting

Impostazione per la gestione di membri e gruppi in uno spazio.

PermissionSetting

Impostazione per l'aggiornamento del nome dello spazio, dell'avatar, della descrizione e delle linee guida.

PermissionSetting

Impostazione per attivare e disattivare la cronologia degli spazi.

PermissionSetting

Impostazione per l'utilizzo di @tutti in uno spazio.

PermissionSetting

Impostazione per la gestione delle app in uno spazio.

PermissionSetting

Impostazione per la gestione dei webhook in uno spazio.

PermissionSetting

Solo output. Impostazione per la pubblicazione di messaggi in uno spazio.

PermissionSetting

Impostazione per rispondere ai messaggi in uno spazio.

string

(Facoltativo) Una descrizione dello spazio. Ad esempio, descrivi l'argomento di discussione, lo scopo funzionale o i partecipanti dello spazio.

Supporta fino a 150 caratteri.

string

(Facoltativo) Regole, aspettative ed etichetta dello spazio.

Supporta fino a 5000 caratteri.

SpaceUpdatedEventData

Un elenco degli spazi aggiornati.

string

Nome risorsa dell'evento dello spazio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Ora in cui si è verificato l'evento.

string

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 spaceEvents.list(), ometti i tipi di eventi batch nel filtro di query. Per impostazione predefinita, il server restituisce sia il tipo di evento sia la sua versione batch.

Tipi di eventi supportati per i messaggi:

• Nuovo messaggio: google.workspace.chat.message.v1.created
• Messaggio aggiornato: google.workspace.chat.message.v1.updated
• Messaggio eliminato: google.workspace.chat.message.v1.deleted
• Più nuovi messaggi: google.workspace.chat.message.v1.batchCreated
• Più messaggi aggiornati: google.workspace.chat.message.v1.batchUpdated
• Più messaggi eliminati: google.workspace.chat.message.v1.batchDeleted

Tipi di eventi supportati per gli abbonamenti:

• Nuovo abbonamento: google.workspace.chat.membership.v1.created
• Abbonamento aggiornato: google.workspace.chat.membership.v1.updated
• Abbonamento eliminato: google.workspace.chat.membership.v1.deleted
• Più nuovi abbonamenti: google.workspace.chat.membership.v1.batchCreated
• Più abbonamenti aggiornati: google.workspace.chat.membership.v1.batchUpdated
• Più abbonamenti eliminati: google.workspace.chat.membership.v1.batchDeleted

Tipi di eventi supportati per le reazioni:

• Nuova reazione: google.workspace.chat.reaction.v1.created
• Reazione eliminata: google.workspace.chat.reaction.v1.deleted
• Più nuove reazioni: google.workspace.chat.reaction.v1.batchCreated
• Più reazioni eliminate: google.workspace.chat.reaction.v1.batchDeleted

Tipi di eventi supportati relativi allo spazio:

• Spazio aggiornato: google.workspace.chat.space.v1.updated
• Più aggiornamenti dello spazio: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Payload dell'evento per un nuovo messaggio.

Tipo di evento: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Payload evento per un messaggio aggiornato.

Tipo di evento: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Payload dell'evento per un messaggio eliminato.

Tipo di evento: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Payload dell'evento per più nuovi messaggi.

Tipo di evento: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Payload dell'evento per più messaggi aggiornati.

Tipo di evento: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Payload dell'evento per più messaggi eliminati.

Tipo di evento: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Payload dell'evento per un aggiornamento dello spazio.

Tipo di evento: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Payload evento per più aggiornamenti di uno spazio.

Tipo di evento: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Payload evento per un nuovo abbonamento.

Tipo di evento: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Payload dell'evento per un'appartenenza aggiornata.

Tipo di evento: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Payload dell'evento per un'appartenenza eliminata.

Tipo di evento: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Payload dell'evento per più nuove iscrizioni.

Tipo di evento: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Payload dell'evento per più abbonamenti aggiornati.

Tipo di evento: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Payload dell'evento per più appartenenze eliminate.

Tipo di evento: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Payload dell'evento per una nuova reazione.

Tipo di evento: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Payload evento per una reazione eliminata.

Tipo di evento: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Payload dell’evento per diverse nuove reazioni.

Tipo di evento: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Payload dell'evento per più reazioni eliminate.

Tipo di evento: google.workspace.chat.reaction.v1.batchDeleted

string

Nome della risorsa dello stato di lettura dello spazio.

Formato: users/{user}/spaces/{space}/spaceReadState

Timestamp

(Facoltativo) L'ora in cui lo stato di lettura dello spazio dell'utente è stato aggiornato. Di solito corrisponde al timestamp dell'ultimo messaggio letto o a un timestamp specificato dall'utente per contrassegnare l'ultima posizione di lettura in uno spazio.

Space

Lo spazio aggiornato.

string

Nome della risorsa del thread.

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

string

(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 Chat che lo imposta. Ad esempio, se più app di Chat creano un messaggio utilizzando la stessa chiave di thread, i messaggi vengono pubblicati in thread diversi. Per rispondere in un thread creato da una persona o da un'altra app di chat, specifica il campo name del thread.

string

Nome della risorsa dello stato di lettura del thread.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

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.

Membership

Obbligatorio. L'abbonamento da aggiornare. Vengono aggiornati solo i campi specificati da update_mask.

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza * per aggiornare tutti i percorsi dei campi.

Percorsi dei campi attualmente supportati:

• role

bool

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede l'chat.admin.memberships ambito OAuth 2.0.

Message

Obbligatorio. Messaggio con campi aggiornati.

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Separa più valori con virgole o utilizza * per aggiornare tutti i percorsi dei campi.

Percorsi dei campi attualmente supportati:

• text

• attachment

• cards (è richiesta l'autenticazione dell'app).

• cards_v2 (richiede l'autenticazione dell'app).

• accessory_widgets (richiede l'autenticazione dell'app).

bool

(Facoltativo) Se true e il messaggio non vengono trovati, viene creato un nuovo messaggio e updateMask viene ignorato. L'ID messaggio specificato deve essere assegnato dal client, altrimenti la richiesta non avrà esito positivo.

SpaceReadState

Obbligatorio. Lo stato di lettura dello spazio e i campi da aggiornare.

Supporta solo l'aggiornamento dello stato di lettura per l'utente chiamante.

Per fare riferimento all'utente che chiama, imposta una delle seguenti opzioni:

• L'alias me. Ad esempio, users/me/spaces/{space}/spaceReadState.

• Il relativo indirizzo email Workspace. Ad esempio, users/user@example.com/spaces/{space}/spaceReadState.

• Il proprio ID utente. Ad esempio, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

FieldMask

Obbligatorio. I percorsi dei campi da aggiornare. Percorsi dei campi attualmente supportati:

• last_read_time

Quando last_read_time è precedente all'ora di creazione dell'ultimo messaggio, lo spazio appare come da leggere nell'interfaccia utente.

Per contrassegnare lo spazio come letto, imposta last_read_time su un valore successivo (più grande) dell'ora di creazione dell'ultimo messaggio. Il valore last_read_time viene forzato in modo che corrisponda all'ora di creazione dell'ultimo messaggio. Tieni presente che lo stato di lettura dello spazio influisce solo sullo stato di lettura dei messaggi visibili nella conversazione di primo livello dello spazio. Le risposte nei thread non sono interessate da questo timestamp e si basano invece sullo stato di lettura del thread.

Space

Obbligatorio. Spazio con campi da aggiornare. Space.name deve essere compilato nel formato spaces/{space}. Vengono aggiornati solo i campi specificati da update_mask.

FieldMask

Obbligatorio. I percorsi dei campi aggiornati, separati da virgole, se presenti.

Puoi aggiornare i seguenti campi per uno spazio:

space_details: aggiorna la descrizione dello spazio. Supporta fino a 150 caratteri.

display_name: supporta l'aggiornamento del nome visualizzato solo per gli spazi in cui il campo spaceType è SPACE. Se ricevi il messaggio di errore ALREADY_EXISTS, prova con un valore diverso. Uno spazio esistente all'interno dell'organizzazione Google Workspace potrebbe già utilizzare questo nome visualizzato.

space_type: supporta solo la modifica di un tipo di spazio GROUP_CHAT in SPACE. Includi display_name insieme a space_type nella maschera di aggiornamento e assicurati che lo spazio specificato abbia un nome visualizzato non vuoto e il tipo di spazio SPACE. L'inclusione della maschera space_type e del tipo SPACE nello spazio specificato durante l'aggiornamento del nome visualizzato è facoltativa se lo spazio esistente presenta già il tipo SPACE. Se provi ad aggiornare il tipo di spazio in altri modi, viene visualizzato un errore relativo a un argomento non valido. space_type non è supportato con useAdminAccess.

space_history_state: aggiorna le impostazioni della cronologia degli spazi attivando o disattivando la cronologia per lo spazio. Funzionalità supportata solo se le impostazioni della cronologia sono attivate per l'organizzazione Google Workspace. Per aggiornare lo stato della cronologia dello spazio, devi omettere tutte le altre maschere di campo nella richiesta. space_history_state non è supportato con useAdminAccess.

access_settings.audience: aggiorna l'impostazione di accesso di chi può scoprire lo spazio, partecipare allo spazio e visualizzare l'anteprima dei messaggi nello spazio denominato in cui il campo spaceType è SPACE. Se lo spazio esistente ha un pubblico di destinazione, puoi rimuoverlo e limitare l'accesso allo spazio omettendo un valore per questa maschera di campo. Per aggiornare le impostazioni di accesso per uno spazio, l'utente che esegue l'autenticazione deve essere un gestore dello spazio e omettere tutte le altre maschere dei campi nella richiesta. Non puoi aggiornare questo campo se lo spazio è in modalità di importazione. Per scoprire di più, vedi Rendere uno spazio rilevabile per utenti specifici. access_settings.audience non è supportato con useAdminAccess.

permission_settings: supporta la modifica delle impostazioni delle autorizzazioni di uno spazio. Quando aggiorni le impostazioni delle autorizzazioni, puoi specificare solo permissionSettings maschere dei campi. non puoi aggiornare contemporaneamente altre maschere dei campi. permissionSettings non è supportato con useAdminAccess. Le maschere dei campi supportate includono:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi.

Richiede l'chat.admin.spaces ambito OAuth 2.0.

Alcuni valori di FieldMask non sono supportati se utilizzi l'accesso amministrativo. Per maggiori dettagli, vedi la descrizione di update_mask.

string

Nome della risorsa per un user di Google Chat.

Formato: users/{user}. users/app può essere utilizzato come alias per l'utente bot dell'app per la chiamata.

Per human users, {user} è lo stesso identificatore utente di:

• id per la persona nell'API People. Ad esempio, users/123456789 nell'API Chat rappresenta la stessa persona dell'ID profilo della persona 123456789 nell'API People.

• id per un utente nell'API Admin SDK Directory.

• l'indirizzo email dell'utente può essere utilizzato come alias per {user} nelle richieste API. Ad esempio, se l'ID profilo persona dell'API People di user@example.com è 123456789, puoi utilizzare users/user@example.com come alias per fare riferimento a users/123456789. L'API restituirà solo il nome canonico della risorsa (ad es. users/123456789).

string

Solo output. Il nome visualizzato dell'utente.

string

L'identificatore univoco del dominio Google Workspace dell'utente.

Type

Tipo di utente.

bool

Solo output. Se il valore è true, l'utente è stato eliminato o il suo profilo non è visibile.

User

L'utente menzionato.

Type

Il tipo di menzione dell'utente.

Button

Un elenco di pulsanti. Anche i pulsanti sono oneof data e solo uno di questi campi deve essere impostato.

TextParagraph

Mostra un paragrafo di testo in questo widget.

Image

Visualizza un'immagine in questo widget.

KeyValue

Visualizza un elemento chiave-valore in questo widget.

TextButton

Un pulsante con testo e azione onclick.

ImageButton

Un pulsante con immagine e azione onclick.

string

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.

ActionParameter

Elenco dei parametri di azione.

string

Il nome del parametro per l'action script.

string

Il valore del parametro.

string

L'URL dell'immagine.

OnClick

L'azione onclick.

double

Le proporzioni dell'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.

OnClick

L'azione onclick.

string

Il nome di questo image_button utilizzato per l'accessibilità. Se questo nome non è specificato, viene fornito il valore predefinito.

Icon

L'icona specificata da un enum che fa riferimento a un'icona fornita dall'API Chat.

string

L'icona specificata da un URL.

string

Il testo dell'etichetta in alto. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

string

Il testo dei contenuti. Testo formattato supportato e sempre obbligatorio. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

bool

Se i contenuti devono essere su più righe.

string

Il testo dell'etichetta in basso. Testo formattato supportato. Per saperne di più sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

OnClick

L'azione onclick. Sono selezionabili solo l'etichetta superiore, l'etichetta inferiore e l'area di contenuti.

Icon

Un valore enum sostituito dall'API Chat con l'immagine dell'icona corrispondente.

string

L'icona specificata da un URL.

Button

Un pulsante su cui è possibile fare clic per attivare un'azione.

FormAction

Se specificata, questa azione onclick attiva un'azione di modulo.

OpenLink

Questa azione onclick attiva un'azione di apertura del link, se specificata.

string

L'URL da aprire.

string

Il testo del pulsante.

OnClick

L'azione onclick del pulsante.

string