Package google.apps.card.v1

string

Una funzione personalizzata da chiamare quando si fa clic sull'elemento contenitore o quando viene attivato in altro modo.

Per un esempio di utilizzo, consulta Leggere i dati del modulo.

ActionParameter

Elenco dei parametri di azione.

LoadIndicator

Specifica l'indicatore di caricamento visualizzato durante l'esecuzione dell'azione.

bool

Indica se i valori del modulo vengono mantenuti dopo l'azione. Il valore predefinito è false.

Se true, i valori del modulo rimangono dopo l'attivazione dell'azione. Per consentire all'utente di apportare modifiche durante l'elaborazione dell'azione, imposta LoadIndicator su NONE. Per i messaggi della scheda nelle app di chat, devi anche impostare ResponseType dell'azione su UPDATE_MESSAGE e utilizzare lo stesso card_id della scheda che conteneva l'azione.

Se false, i valori del modulo vengono cancellati quando viene attivata l'azione. Per impedire all'utente di apportare modifiche durante l'elaborazione dell'azione, imposta LoadIndicator su SPINNER.

Interaction

(Facoltativo) Obbligatorio quando si apre una finestra di dialogo.

Che cosa fare in risposta a un'interazione con un utente, ad esempio un clic su un pulsante in un messaggio della scheda.

Se non specificato, l'app risponde eseguendo un'istruzione action, ad esempio aprendo un link o eseguendo una funzione, come di consueto.

Se specifichi un interaction, l'app può rispondere in modi interattivi speciali. Ad esempio, se imposti interaction su OPEN_DIALOG, l'app può aprire una finestra di dialogo. Se specificato, non viene mostrato alcun indicatore di caricamento. Se viene specificato per un componente aggiuntivo, viene eliminata l'intera scheda e non viene visualizzato nulla nel client.

Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.

string

Se i widget elencati qui non hanno un valore quando viene richiamata questa azione, l'invio del modulo viene interrotto.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

bool

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

string

Il nome del parametro per lo script dell'azione.

string

Il valore del parametro.

BorderType

Il tipo di bordo.

Color

I colori da utilizzare quando il tipo è BORDER_TYPE_STROKE.

Per impostare il colore del tratto, specifica un valore per i campi red, green e blue. Il valore deve essere un numero decimale compreso tra 0 e 1 in base al valore del colore RGB, dove 0 (0/255) rappresenta l'assenza di colore e 1 (255/255) l'intensità massima del colore.

Ad esempio, di seguito viene impostato il colore rosso alla massima intensità:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Il campo alpha non è disponibile per il colore del tratto. Se specificato, questo campo viene ignorato.

int32

Il raggio d'angolo del bordo.

string

Il testo visualizzato all'interno del pulsante.

Icon

Un'icona visualizzata all'interno del pulsante. Se icon e text sono impostati, l'icona viene visualizzata prima del testo.

Color

(Facoltativo) Il colore del pulsante. Se impostato, il pulsante type è impostato su FILLED e il colore dei campi text e icon è impostato su un colore a contrasto per migliorare la leggibilità. Ad esempio, se il colore del pulsante è impostato su blu, qualsiasi testo o icona al suo interno sarà impostato su bianco.

Per impostare il colore del pulsante, specifica un valore per i campi red, green e blue. Il valore deve essere un numero decimale compreso tra 0 e 1 in base al valore del colore RGB, dove 0 (0/255) rappresenta l'assenza di colore e 1 (255/255) l'intensità massima del colore.

Ad esempio, il seguente codice imposta il colore rosso alla sua intensità massima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Il campo alpha non è disponibile per il colore del pulsante. Se specificato, questo campo viene ignorato.

OnClick

Obbligatorio. L'azione da eseguire quando un utente fa clic sul pulsante, ad esempio l'apertura di un link ipertestuale o l'esecuzione di una funzione personalizzata.

bool

Se true, il pulsante viene visualizzato in uno stato non attivo e non risponde alle azioni dell'utente.

string

Il testo alternativo utilizzato per l'accessibilità.

Imposta un testo descrittivo che indichi agli utenti la funzione del pulsante. Ad esempio, se un pulsante apre un link ipertestuale, potresti scrivere: "Apre una nuova scheda del browser e va alla documentazione per gli sviluppatori di Google Chat all'indirizzo https://developers.google.com/workspace/chat".

Type

(Facoltativo) Il tipo di pulsante. Se non viene impostato, il tipo di pulsante predefinito è OUTLINED. Se il campo color è impostato, il tipo di pulsante viene impostato forzatamente su FILLED e qualsiasi valore impostato per questo campo viene ignorato.

Disponibile per le app Google Chat e per i componenti aggiuntivi di Google Workspace.

Button

Un array di pulsanti.

CardHeader

L'intestazione della scheda. Un'intestazione di solito contiene un'immagine iniziale e un titolo. Le intestazioni vengono sempre visualizzate nella parte superiore di una scheda.

Section

Contiene una raccolta di widget. Ogni sezione ha un'intestazione facoltativa. Le sezioni sono separate visivamente da una linea divisoria. Per un esempio nelle app Google Chat, vedi Definire una sezione di una scheda.

DividerStyle

Lo stile del divisore tra l'intestazione, le sezioni e il piè di pagina.

CardAction

Le azioni della scheda. Le azioni vengono aggiunte al menu della barra degli strumenti della scheda.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

Ad esempio, il seguente JSON crea un menu di azioni della scheda con le opzioni Settings e Send Feedback:

"card_actions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

Nome della scheda. Utilizzato come identificatore della scheda nella navigazione tra le schede.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

CardFixedFooter

Il piè di pagina fisso mostrato in fondo a questa scheda.

L'impostazione di fixedFooter senza specificare un primaryButton o un secondaryButton causa un errore. Per le app di chat, puoi utilizzare i piè di pagina fissi nelle finestre di dialogo, ma non nei messaggi della scheda.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

DisplayStyle

In Componenti aggiuntivi di Google Workspace, imposta le proprietà di visualizzazione del peekCardHeader.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

CardHeader

Quando vengono visualizzati contenuti contestuali, l'intestazione della scheda di anteprima funge da segnaposto per consentire all'utente di passare dalle schede della home page alle schede contestuali.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

string

L'etichetta visualizzata come elemento del menu di azioni.

OnClick

L'azione onClick per questo elemento dell'attività.

Button

Il pulsante principale del piè di pagina fisso. Il pulsante deve essere un pulsante di testo con testo e colore impostati.

Button

Il pulsante secondario del piè di pagina fisso. Il pulsante deve essere un pulsante di testo con testo e colore impostati. Se il criterio secondaryButton viene impostato, devi impostare anche primaryButton.

string

Obbligatorio. Il titolo dell'intestazione della scheda. L'intestazione ha un'altezza fissa: se vengono specificati sia un titolo che un sottotitolo, ciascuno occupa una riga. Se viene specificato solo il titolo, questo occupa entrambe le righe.

string

Il sottotitolo dell'intestazione della scheda. Se specificato, viene visualizzato su una riga separata sotto title.

ImageType

La forma utilizzata per ritagliare l'immagine.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

string

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

string

Il testo alternativo di questa immagine utilizzato per l'accessibilità.

string

Testo visualizzato nella parte superiore di una sezione. Supporta il testo semplice con formattazione HTML. 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.

Widget

Tutti i widget della sezione. Deve contenere almeno un widget.

bool

Indica se questa sezione è comprimibile.

Le sezioni comprimibili nascondono alcuni o tutti i widget, ma gli utenti possono espandere la sezione per visualizzare i widget nascosti facendo clic su Mostra altro. Gli utenti possono nascondere di nuovo i widget facendo clic su Mostra meno.

Per determinare quali widget sono nascosti, specifica uncollapsibleWidgetsCount.

int32

Il numero di widget non comprimibili che rimangono visibili anche quando una sezione è compressa.

Ad esempio, quando una sezione contiene cinque widget e uncollapsibleWidgetsCount è impostato su 2, i primi due widget vengono sempre visualizzati e gli ultimi tre sono compressi per impostazione predefinita. uncollapsibleWidgetsCount viene preso in considerazione solo quando collapsible è true.

CollapseControl

(Facoltativo) Definisci i pulsanti di espansione e compressione della sezione. Questo pulsante viene visualizzato solo se la sezione è comprimibile. Se questo campo non è impostato, viene utilizzato il pulsante predefinito. Disponibile per le app Google Chat e per i componenti aggiuntivi di Google Workspace.

Icon

L'immagine dell'icona. Se icon e text sono impostati, l'icona viene visualizzata prima del testo.

string

Il testo visualizzato all'interno del chip.

OnClick

(Facoltativo) L'azione da eseguire quando un utente fa clic sul chip, ad esempio l'apertura di un link ipertestuale o l'esecuzione di una funzione personalizzata.

bool

Indica se il chip è in stato attivo e risponde alle azioni dell'utente. Il valore predefinito è true. Deprecato. Usa invece il criterio disabled.

bool

Indica se il chip è in uno stato non attivo e ignora le azioni dell'utente. Il valore predefinito è false.

string

Il testo alternativo utilizzato per l'accessibilità.

Imposta un testo descrittivo che indichi agli utenti la funzione del chip. Ad esempio, se un chip apre un link ipertestuale, scrivi: "Apre una nuova scheda del browser e si accede alla documentazione per gli sviluppatori di Google Chat all'indirizzo https://developers.google.com/workspace/chat".

Layout

Layout dell'elenco di chip specificato.

Chip

Un array di chip.

HorizontalAlignment

L'allineamento orizzontale del pulsante Espandi e comprimi.

Button

(Facoltativo) Definisci un pulsante personalizzabile per espandere la sezione. È necessario impostare entrambi i campi expand_button e collapse_button. Solo un insieme di campi non verrà applicato. Se questo campo non è impostato, viene utilizzato il pulsante predefinito.

Button

(Facoltativo) Definisci un pulsante personalizzabile per comprimere la sezione. È necessario impostare entrambi i campi expand_button e collapse_button. Solo un insieme di campi non verrà applicato. Se questo campo non è impostato, viene utilizzato il pulsante predefinito.

Column

Un array di colonne. Puoi includere fino a due colonne in una scheda o una finestra di dialogo.

HorizontalSizeStyle

Specifica in che modo una colonna riempie la larghezza della scheda.

HorizontalAlignment

Specifica se i widget devono essere allineati a sinistra, a destra o al centro di una colonna.

VerticalAlignment

Specifica se i widget devono essere allineati alla parte superiore, inferiore o al centro di una colonna.

Widgets

Un array di widget inclusi in una colonna. I widget vengono visualizzati nell'ordine in cui sono specificati.

TextParagraph

TextParagraph widget.

Image

Image widget.

DecoratedText

DecoratedText widget.

ButtonList

ButtonList widget.

TextInput

TextInput widget.

SelectionInput

SelectionInput widget.

DateTimePicker

DateTimePicker widget.

ChipList

ChipList widget. Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.

string

Il nome con cui DateTimePicker è identificato in un evento di inserimento di un modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

string

Il testo che chiede agli utenti di inserire una data, un'ora o una data e un'ora. Ad esempio, se gli utenti stanno fissando un appuntamento, utilizza un'etichetta come Appointment date o Appointment date and time.

DateTimePickerType

Indica se il widget supporta l'inserimento di una data, un'ora o la data e l'ora.

int64

Il valore predefinito visualizzato nel widget, in millisecondi dal tempo di Unix epoch.

Specifica il valore in base al tipo di selettore (DateTimePickerType):

• DATE_AND_TIME: una data e un'ora di calendario in UTC. Ad esempio, per indicare il 1° gennaio 2023 alle 12:00 UTC, utilizza 1672574400000.
• DATE_ONLY: una data di calendario alle ore 00:00:00 UTC. Ad esempio, per rappresentare il 1° gennaio 2023, utilizza 1672531200000.
• TIME_ONLY: un'ora in UTC. Ad esempio, per rappresentare le 12:00, utilizza 43200000 (o 12 * 60 * 60 * 1000).

int32

Il numero che rappresenta la differenza di fuso orario rispetto a UTC, in minuti. Se impostato, value_ms_epoch viene visualizzato nel fuso orario specificato. Se non viene configurato, il valore predefinito corrisponde all'impostazione del fuso orario dell'utente.

Action

Si attiva quando l'utente fa clic su Salva o Cancella nell'interfaccia DateTimePicker.

Validation

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

Icon

È stata sostituita da startIcon.

Icon

L'icona visualizzata davanti al testo.

string

Il testo visualizzato sopra text. Viene sempre troncato.

string

Obbligatorio. Il testo principale.

Supporta una formattazione semplice. 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.

bool

L'impostazione del testo a capo. Se true, il testo va a capo e viene visualizzato su più righe. In caso contrario, il testo viene troncato.

Si applica solo a text, non a topLabel e bottomLabel.

string

Il testo visualizzato sotto text. Si inserisce sempre un a capo.

OnClick

Questa azione viene attivata quando gli utenti fanno clic su topLabel o bottomLabel.

Button

Un pulsante su cui l'utente può fare clic per attivare un'azione.

SwitchControl

Un widget di opzione su cui un utente può fare clic per modificarne lo stato e attivare un'azione.

Icon

Un'icona visualizzata dopo il testo.

Supporta le icone incorporate e personalizzate.

string

Il nome con cui il widget di opzione viene identificato in un evento di inserimento di un modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

string

Il valore inserito da un utente, restituito nell'ambito di un evento di inserimento di un modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

bool

Quando è true, l'opzione è selezionata.

Action

L'azione da eseguire quando viene modificato lo stato del cambio, ad esempio la funzione da eseguire.

ControlType

Come viene visualizzato il pulsante di attivazione/disattivazione nell'interfaccia utente.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

string

Il testo visualizzato nell'intestazione della griglia.

GridItem

Gli elementi da visualizzare nella griglia.

BorderStyle

Lo stile del bordo da applicare a ogni elemento della griglia.

int32

Il numero di colonne da visualizzare nella griglia. Se questo campo non è specificato, viene utilizzato un valore predefinito diverso a seconda di dove viene visualizzata la griglia (dialogo o companion).

OnClick

Questo callback viene riutilizzato da ogni singolo elemento della griglia, ma con l'identificatore e l'indice dell'elemento nell'elenco di elementi aggiunti ai parametri del callback.

string

Un identificatore specificato dall'utente per questo elemento della griglia. Questo identificatore viene restituito nei onClickparametri di callback della griglia principale.

ImageComponent

L'immagine visualizzata nell'elemento della griglia.

string

Il titolo dell'elemento della griglia.

string

Il sottotitolo dell'elemento della griglia.

GridItemLayout

Il layout da utilizzare per l'elemento della griglia.

string

(Facoltativo) Una descrizione dell'icona utilizzata per l'accessibilità. Se non specificato, viene fornito il valore predefinito Button. Come best practice, ti consigliamo di impostare una descrizione utile per ciò che viene visualizzato dall'icona e, se applicabile, per la sua funzione. Ad esempio, A user's account portrait o Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Se l'icona è impostata in un Button, il altText viene visualizzato come testo di aiuto quando l'utente passa il mouse sopra il pulsante. Tuttavia, se il pulsante imposta anche text, altText dell'icona viene ignorato.

ImageType

Lo stile di ritaglio applicato all'immagine. In alcuni casi, l'applicazione di un ritaglio CIRCLE fa sì che l'immagine venga disegnata più grande di un'icona integrata.

string

Mostra una delle icone integrate fornite da Google Workspace.

Ad esempio, per visualizzare un'icona a forma di aereo, specifica AIRPLANE. Per gli autobus, specifica BUS.

Per un elenco completo delle icone supportate, consulta le icone integrate.

string

Mostra un'icona personalizzata ospitata su un URL HTTPS.

Ad esempio:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

I tipi di file supportati includono .png e .jpg.

MaterialIcon

Mostra una delle icone di Google Material.

Ad esempio, per visualizzare un'icona di casella di controllo, utilizza

"material_icon": {
  "name": "check_box"
}

Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.

string

L'URL HTTPS che ospita l'immagine.

Ad esempio:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

Quando un utente fa clic sull'immagine, il clic attiva questa azione.

string

Il testo alternativo di questa immagine utilizzato per l'accessibilità.

string

L'URL dell'immagine.

string

L'etichetta di accessibilità per l'immagine.

ImageCropStyle

Lo stile di ritaglio da applicare all'immagine.

BorderStyle

Lo stile del bordo da applicare all'immagine.

ImageCropType

Il tipo di ritaglio.

double

Le proporzioni da utilizzare se il tipo di ritaglio è RECTANGLE_CUSTOM.

Ad esempio, ecco come applicare proporzioni 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

Il nome dell'icona definito nell'icona di Google Material, ad esempio check_box. I nomi non validi vengono abbandonati e sostituiti con una stringa vuota, con la quale l'icona non viene visualizzata.

bool

Indica se l'icona viene visualizzata come riempita. Il valore predefinito è false.

Per visualizzare l'anteprima di diverse impostazioni delle icone, vai a Icone dei caratteri Google e modifica le impostazioni in Personalizza.

int32

Lo spessore del tratto dell'icona. Scegli tra {100, 200, 300, 400, 500, 600, 700}. Se non è presente, il valore predefinito è 400. Se viene specificato un altro valore, viene utilizzato il valore predefinito.

Per visualizzare l'anteprima di diverse impostazioni delle icone, vai a Icone dei caratteri Google e modifica le impostazioni in Personalizza.

int32

Lo spessore di un simbolo è influenzato dal tratto e dalla qualità. Le modifiche al grado sono più granulari di quelle al peso e hanno un piccolo impatto sulle dimensioni del simbolo. Scegli un'opzione tra {-25, 0, 200}. Se non è presente, il valore predefinito è 0. Se viene specificato un altro valore, viene utilizzato il valore predefinito.

Per visualizzare l'anteprima delle diverse impostazioni delle icone, vai a Icone dei caratteri Google e regola le impostazioni nella sezione Personalizza.

Action

Se specificato, questo onClick attiva un'azione.

OpenLink

Se specificato, questo onClick attiva un'azione di apertura del link.

Action

Un componente aggiuntivo attiva questa azione quando deve aprire un link. Questo comando è diverso da open_link sopra in quanto deve comunicare con il server per ottenere il link. Pertanto, è necessario che il client web esegua alcuni passaggi di preparazione prima di ricevere la risposta all'azione di apertura del link.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

Card

Una nuova scheda viene inserita nella pila di schede dopo aver fatto clic, se specificato.

Disponibile per i componenti aggiuntivi di Google Workspace e non per le app Google Chat.

OverflowMenu

Se specificato, onClick apre un menu extra. Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.

string

L'URL da aprire.

OpenAs

Come aprire un link.

Disponibile per i componenti aggiuntivi di Google Workspace e per le app Google Chat.

OnClose

Indica se il cliente dimentica un link dopo averlo aperto o lo osserva fino alla chiusura della finestra.

Disponibile per i componenti aggiuntivi di Google Workspace e per le app Google Chat.

OverflowMenuItem

Obbligatorio. L'elenco delle opzioni di menu.

Icon

L'icona visualizzata davanti al testo.

string

Obbligatorio. Il testo che identifica o descrive l'elemento per gli utenti.

OnClick

Obbligatorio. L'azione richiamata quando è selezionata un'opzione di menu. Questo OnClick non può contenere un OverflowMenu, qualsiasi OverflowMenu specificato viene eliminato e l'elemento del menu viene disattivato.

bool

Indica se l'opzione di menu è disabilitata. Il valore predefinito è false.

string

Obbligatorio. Il nome che identifica l'input di selezione in un evento di immissione di un modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

string

Il testo visualizzato sopra il campo di immissione della selezione nell'interfaccia utente.

Specifica un testo che aiuti l'utente a inserire le informazioni necessarie per la tua app. Ad esempio, se gli utenti selezionano l'urgenza di un ticket di lavoro da un menu a discesa, l'etichetta potrebbe essere "Urgenza" o "Seleziona urgenza".

SelectionType

Il tipo di elementi visualizzati agli utenti in un widget SelectionInput. I tipi di selezione supportano diversi tipi di interazioni. Ad esempio, gli utenti possono selezionare una o più caselle di controllo, ma possono selezionare un solo valore da un menu a discesa.

SelectionItem

Un array di elementi selezionabili. Ad esempio, un array di pulsanti di opzione o caselle di controllo. Supporta fino a 100 elementi.

Action

Se specificato, il modulo viene inviato quando la selezione cambia. Se non specificato, devi specificare un pulsante separato che invii il modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

int32

Per i menu a selezione multipla, il numero massimo di elementi che un utente può selezionare. Il valore minimo è 1 articolo. Se non specificato, il valore predefinito è 3 elementi.

int32

Per i menu a più opzioni, il numero di caratteri di testo inseriti da un utente prima che il menu restituisca gli elementi di selezione suggeriti.

Se non viene impostato, il menu di selezione multipla utilizza i seguenti valori predefiniti:

• Se il menu utilizza un array statico di elementi SelectionInput, il valore predefinito è 0 caratteri e gli elementi dell'array vengono compilati immediatamente.
• Se il menu utilizza un'origine dati dinamica (multi_select_data_source), il valore predefinito è 3 caratteri prima di eseguire una query sull'origine dati per restituire gli elementi suggeriti.

Validation

Per i menu a discesa, la convalida di questo campo di immissione di selezione.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

Action

Un'origine dati esterna, ad esempio un database relazionale.

PlatformDataSource

Un'origine dati di Google Workspace.

CommonDataSource

Un'origine dati condivisa da tutte le applicazioni Google Workspace, ad esempio gli utenti di un'organizzazione Google Workspace.

HostAppDataSourceMarkup

Un'origine dati univoca per un'applicazione host di Google Workspace, come gli spazi di Google Chat.

Questo campo supporta le librerie client delle API di Google, ma non è disponibile nelle librerie client di Cloud. Per scoprire di più, consulta Installare le librerie client.

string

Il testo che identifica o descrive l'elemento per gli utenti.

string

Il valore associato a questo elemento. Il cliente deve utilizzarlo come valore di input del modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

bool

Indica se l'elemento è selezionato per impostazione predefinita. Se l'input di selezione accetta un solo valore (ad esempio per i pulsanti di opzione o un menu a discesa), imposta questo campo solo per un elemento.

string

Per i menu a selezione multipla, l'URL dell'icona visualizzata accanto al campo text dell'elemento. Supporta i file PNG e JPEG. Deve essere un URL HTTPS. Ad esempio: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

string

Per i menu a selezione multipla, una descrizione testuale o un'etichetta visualizzata sotto il campo text dell'elemento.

SuggestionItem

Un elenco di suggerimenti utilizzati per i consigli di completamento automatico nei campi di immissione di testo.

string

Il valore di un input suggerito per un campo di immissione di testo. Corrisponde a quanto inserito dagli utenti.

string

Il nome con cui viene identificato l'input di testo in un evento di input del modulo.

Per informazioni dettagliate sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

string

Il testo visualizzato sopra il campo di immissione di testo nell'interfaccia utente.

Specifica un testo che aiuti l'utente a inserire le informazioni necessarie per la tua app. Ad esempio, se chiedi il nome di una persona, ma hai bisogno specificamente del suo cognome, scrivi surname anziché name.

Obbligatorio se hintText non è specificato. In caso contrario, facoltativo.

string

Testo visualizzato sotto il campo di immissione di testo per aiutare gli utenti chiedendo di inserire un determinato valore. Questo testo è sempre visibile.

Obbligatorio se label non è specificato. Altrimenti, facoltativo.

string

Il valore inserito da un utente, restituito nell'ambito di un evento di inserimento di un modulo.

Per maggiori dettagli sull'utilizzo degli input dei moduli, vedi Ricevere i dati dei moduli.

Type

La modalità di visualizzazione di un campo di immissione di testo nell'interfaccia utente. Ad esempio, se il campo è a una o più righe.

Action

Cosa fare quando si verifica una modifica nel campo di immissione di testo. Ad esempio, un utente che aggiunge testo al campo o lo elimina.

Alcuni esempi di azioni da intraprendere sono l'esecuzione di una funzione personalizzata o l'apertura di una finestra di dialogo in Google Chat.

Suggestions

Valori suggeriti che gli utenti possono inserire. Questi valori vengono visualizzati quando gli utenti fanno clic all'interno del campo di immissione testo. Man mano che gli utenti digitano, i valori suggeriti vengono filtrati in modo dinamico in base a ciò che hanno digitato.

Ad esempio, un campo di immissione di testo per il linguaggio di programmazione potrebbe suggerire Java, JavaScript, Python e C++. Quando gli utenti iniziano a digitare Jav, l'elenco dei suggerimenti viene filtrato in modo da mostrare solo Java e JavaScript.

I valori suggeriti aiutano gli utenti a inserire valori comprensibili per la tua app. Quando si fa riferimento a JavaScript, alcuni utenti potrebbero inserire javascript e altri java script. Suggerire JavaScript può standardizzare il modo in cui gli utenti interagiscono con la tua app.

Se specificato, TextInput.type è sempre SINGLE_LINE, anche se è impostato su MULTIPLE_LINE.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

Action

(Facoltativo) Specifica quale azione eseguire quando il campo di immissione di testo fornisce suggerimenti agli utenti che interagiscono con questo campo.

Se non specificato, i suggerimenti vengono impostati da initialSuggestions ed elaborati dal cliente.

Se specificato, l'app esegue l'azione specificata qui, ad esempio l'esecuzione di una funzione personalizzata.

Disponibile per i componenti aggiuntivi di Google Workspace e per le app Google Chat.

Validation

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

string

Il testo visualizzato nel campo di immissione di testo quando il campo è vuoto. Utilizza questo testo per chiedere agli utenti di inserire un valore. Ad esempio, Enter a number from 0 to 100.

Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.

string

Il testo visualizzato nel widget.

int32

Il numero massimo di righe di testo visualizzate nel widget. Se il testo supera il numero massimo di righe specificato, i contenuti in eccesso vengono nascosti dietro un pulsante Mostra altro. Se il testo è uguale o più breve del numero massimo di righe specificato, non viene visualizzato il pulsante Mostra altro.

Il valore predefinito è 0 e viene visualizzato tutto il contesto. I valori negativi vengono ignorati. Disponibile per le app Google Chat e per i componenti aggiuntivi di Google Workspace.

int32

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

InputType

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

HorizontalAlignment

Specifica se i widget devono essere allineati a sinistra, a destra o al centro di una colonna.

TextParagraph

Mostra un paragrafo di testo. Supporta il testo semplice con formattazione HTML. 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.

Ad esempio, il seguente JSON crea un testo in grassetto:

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

Mostra un'immagine.

Ad esempio, il seguente JSON crea un'immagine con testo alternativo:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

Mostra un elemento di testo decorato.

Ad esempio, il seguente JSON crea un widget di testo decorato che mostra l'indirizzo email:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

Un elenco di pulsanti.

Ad esempio, il seguente JSON crea due pulsanti. Il primo è un pulsante di testo blu e il secondo è un pulsante immagine che apre un link:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

Mostra una casella di testo in cui gli utenti possono digitare.

Ad esempio, il seguente JSON crea un input di testo per un indirizzo email:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Per fare un altro esempio, il seguente JSON crea un input di testo per un linguaggio di programmazione con suggerimenti statici:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

Mostra un controllo di selezione che consente agli utenti di selezionare elementi. I controlli di selezione possono essere caselle di controllo, pulsanti di opzione, opzioni o menu a discesa.

Ad esempio, il seguente JSON crea un menu a discesa che consente agli utenti di scegliere una taglia:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

DateTimePicker

Mostra un widget che consente agli utenti di inserire una data, un'ora o una data e un'ora.

Ad esempio, il seguente JSON crea un selettore di data e ora per pianificare un appuntamento:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Mostra una linea divisoria orizzontale tra i widget.

Ad esempio, il seguente JSON crea un divisore:

"divider": {
}

Grid

Mostra una griglia con una raccolta di elementi.

Una griglia supporta un numero qualsiasi di colonne ed elementi. Il numero di righe è determinato dai limiti superiori del numero di elementi divisi per il numero di colonne. Una griglia con 10 elementi e 2 colonne ha 5 righe. Una griglia con 11 elementi e 2 colonne ha 6 righe.

Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.

Ad esempio, il seguente JSON crea una griglia di 2 colonne con un singolo elemento:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

Columns

Consente di visualizzare fino a due colonne.

Per includere più di due colonne o per utilizzare le righe, utilizza il widget Grid.

Ad esempio, il seguente JSON crea due colonne ciascuna contenente paragrafi di testo:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

ChipList

Un elenco di chip.

Ad esempio, il seguente JSON crea due chip. Il primo è un chip di testo e il secondo un chip di icona che apre un link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Disponibile per le app Google Chat e non disponibile per i componenti aggiuntivi di Google Workspace.