Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

Lo stile del divisore tra le sezioni.

object (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 per le app Google Chat.

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

"cardActions": [
  {
    "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 per le app Google Chat.

object (CardFixedFooter)

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

Impostazione fixedFooter senza specificare un primaryButton o un secondaryButton causa un errore. Per le app di chat, puoi utilizzare piè di pagina fissi dialoganti, ma non messaggi della scheda.

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

enum (DisplayStyle)

Nei componenti aggiuntivi di Google Workspace, imposta le proprietà di visualizzazione peekCardHeader.

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

object (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 disponibile per le app Google Chat.

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

Obbligatorio. Il titolo dell'intestazione della scheda. 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. Se specificato, compare su una riga separata sotto il title.

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

string

Testo visualizzato nella parte superiore di una sezione. Supporta testo in formato HTML semplice. Per ulteriori informazioni sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

object (Widget)

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

boolean

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 Mostra altro. Gli utenti possono nascondere nuovamente i widget facendo clic Mostra meno.

Per determinare quali widget sono nascosti, specifica uncollapsibleWidgetsCount.

integer

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

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

object (CollapseControl)

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

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

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

object (TextParagraph)

Visualizza un paragrafo di testo. Supporta testo in formato HTML semplice. Per ulteriori informazioni sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

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

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

object (Image)

Consente di visualizzare 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"
}

object (DecoratedText)

Consente di mostrare 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"
  }
}

object (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"
        }
      }
    }
  ]
}

object (TextInput)

Visualizza 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"
      }
    ]
  }
}

object (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
    }
  ]
}

object (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"
}

object (Divider)

Visualizza una linea orizzontale di divisione tra i widget.

Ad esempio, il seguente JSON crea un divisore:

"divider": {
}

object (Grid)

Visualizza una griglia con una raccolta di elementi.

Una griglia supporta un numero illimitato di colonne ed elementi. Il numero di righe è determinato dal limite superiore del numero di elementi diviso 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 a 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"
    }
  }
}

object (Columns)

Consente di visualizzare fino a due colonne.

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

Ad esempio, il seguente JSON crea due colonne contenenti ciascuna 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"
          }
        }
      ]
    }
  ]
}

object (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 per i componenti aggiuntivi di Google Workspace.

{
  "text": string,
  "maxLines": integer
}

string

Il testo visualizzato nel widget.

integer

Il numero massimo di righe di testo visualizzate nel widget. Se il testo supera il numero massimo specificato di righe, il contenuto in eccesso viene nascosto da un mostra altro . Se il testo è uguale o più breve del numero massimo di righe specificato, viene mostra altro .

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

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

L'URL HTTPS che ospita l'immagine.

Ad esempio:

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

object (OnClick)

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

string

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

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

object (Action)

Se specificata, viene attivata un'azione onClick.

object (OpenLink)

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

object (Action)

Un componente aggiuntivo attiva questa azione quando l'azione deve aprire un link. Questa operazione è diversa da quella riportata 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 per le app Google Chat.

object (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 disponibile per le app Google Chat.

object (OverflowMenu)

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

string

Una funzione personalizzata da richiamare quando l'elemento contenitore viene selezionato o attivato in altro modo.

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

object (ActionParameter)

Elenco dei parametri di azione.

enum (LoadIndicator)

Specifica l'indicatore di caricamento che l'azione mostra mentre si fa l'invito all'azione.

boolean

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 a NONE. Per messaggi nella scheda nelle app di chat, devi impostare anche il valore ResponseType: a UPDATE_MESSAGE e utilizzare lo stesso cardId dalla 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 a SPINNER.

enum (Interaction)

(Facoltativo) Obbligatorio all'apertura di un dialog.

Cosa fare in risposta a un'interazione con un utente, ad esempio il clic su un pulsante in un messaggio di una scheda.

Se non specificato, l'app risponde eseguendo un 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, impostando interaction a OPEN_DIALOG, l'app può aprire un finestra di dialogo. Se specificato, non viene visualizzato un indicatore di caricamento. Se specificato per un componente aggiuntivo, l'intera scheda viene rimossa e nel client non viene visualizzato nulla.

Disponibile per le app Google Chat e 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.

boolean

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

{
  "key": string,
  "value": string
}

string

Il nome del parametro per l'action script.

string

Il valore del parametro.

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

L'URL da aprire.

enum (OpenAs)

Come aprire un link.

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

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

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

Obbligatorio. L'elenco delle opzioni di menu.

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

Icona visualizzata davanti al testo.

string

Obbligatorio. Il testo che identifica o descrive l'articolo agli utenti.

object (OnClick)

Obbligatorio. L'azione invocata quando viene selezionata un'opzione di menu. Questo OnClick non può contenere un OverflowMenu, qualsiasi specificato OverflowMenu viene rimosso e la voce di menu è disattivata.

boolean

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

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

string

(Facoltativo) Una descrizione dell'icona utilizzata per l'accessibilità. Se non specificato, il valore predefinito Button in cui viene fornito il valore. 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, oppure 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.

enum (ImageType)

Lo stile di ritaglio applicato all'immagine. In alcuni casi, l'applicazione di CIRCLE ritaglia l'immagine viene disegnata più grande di quella 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, vedi icone integrate.

string

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

object (MaterialIcon)

Visualizza uno dei Icone dei materiali Google.

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

"materialIcon": {
  "name": "check_box"
}

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

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

Il nome dell'icona definito nel Google Material Icon, ad esempio, check_box. I nomi non validi vengono abbandonati e sostituiti con una stringa vuota, causando un errore di visualizzazione dell'icona.

boolean

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

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

integer

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 qualsiasi altro valore, viene utilizzato quello predefinito.

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

integer

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

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

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

Deprecato a favore di startIcon.

object (Icon)

Icona visualizzata davanti al testo.

string

Il testo visualizzato sopra text. Tronca sempre.

string

Obbligatorio. Il testo principale.

Supporta una formattazione semplice. Per ulteriori informazioni sulla formattazione del testo, vedi Formattazione del testo nelle app Google Chat e Formattazione del testo nei componenti aggiuntivi di Google Workspace.

boolean

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 topLabel e bottomLabel.

string

Il testo visualizzato sotto text. Confezione sempre disponibile.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

Un widget di cambio su cui un utente può fare clic per modificare il proprio stato e attivare un'azione.

object (Icon)

Icona visualizzata dopo il testo.

Supporta integrata e personalizzato .

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

Il testo visualizzato all'interno del pulsante.

object (Icon)

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

object (Color)

(Facoltativo) Il colore del pulsante. Se impostato, il pulsante type è impostato su FILLED e il colore text e icon campi sono impostati su un colore contrastante per la leggibilità. Ad esempio, se il colore del pulsante è impostato sul blu, il testo o le icone nel pulsante sono impostati su bianco.

Per impostare il colore del pulsante, specifica un valore per il parametro red, green e blue campi. Il valore deve essere un numero in virgola mobile 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) rappresenta la massima intensità del colore.

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

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

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

object (OnClick)

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

boolean

Se true, il pulsante viene visualizzato in stato inattivo 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 passa alla documentazione per gli sviluppatori di Google Chat all'indirizzo https://developers.google.com/workspace/chat".

enum (Type)

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

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

La quantità di rosso nel colore come valore nell'intervallo [0, 1].

number

La quantità di verde nel colore come valore nell'intervallo [0, 1].

number

La quantità di blu nel colore come valore nell'intervallo [0, 1].

number

La frazione di questo colore che deve essere applicata al pixel. In altre parole, il colore finale dei pixel è definito dall'equazione:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Ciò significa che un valore pari a 1,0 corrisponde a un colore in tinta unita, mentre un valore pari a 0,0 a un colore completamente trasparente. Viene utilizzato un messaggio wrapper anziché un semplice scalare float in modo da distinguere un valore predefinito dal valore non impostato. Se omesso, l'oggetto colore viene visualizzato come colore a tinta unita (come se al valore alpha fosse stato assegnato esplicitamente un valore 1,0).

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

Il nome con cui viene identificato il widget di cambio in un evento di input del modulo.

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

string

Il valore inserito da un utente, restituito come parte di un evento di input modulo.

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

boolean

Quando true, l'opzione è selezionata.

object (Action)

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

enum (ControlType)

Come viene visualizzata l'opzione nell'interfaccia utente.

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

Una serie di pulsanti.

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

string

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

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

string

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

Specifica il testo che aiuti l'utente a inserire le informazioni necessarie alla 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. Altrimenti, facoltativo.

string

Testo visualizzato sotto il campo di immissione testo per assistere gli utenti chiedendo loro 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 modulo, vedi Ricevere i dati dei moduli.

enum (Type)

Come viene visualizzato un campo di immissione di testo nell'interfaccia utente. ad esempio se il campo è a una o più righe.

object (Action)

Cosa fare quando si verifica una modifica nel campo di immissione del testo. ad esempio un utente che aggiunge un elemento al campo o elimina del testo.

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

object (Suggestions)

Valori suggeriti che gli utenti possono inserire. Questi valori vengono visualizzati quando gli utenti fanno clic all'interno del campo di immissione del testo. Mentre gli utenti digitano, i valori suggeriti vengono filtrati in modo dinamico per corrispondere alle parole digitate dagli utenti.

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 con cui la tua app può avere un senso. Quando si fa riferimento a JavaScript, alcuni utenti potrebbero inserire javascript e altri java script. I suggerimenti JavaScript possono 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.

object (Action)

(Facoltativo) Specifica l'azione da eseguire quando il campo di immissione di testo fornisce suggerimenti agli utenti che interagiscono con esso.

Se non specificati, i suggerimenti vengono impostati initialSuggestions e vengono elaborati dal client.

Se specificata, 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.

object (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 richiedere agli utenti di inserire un valore. Ad esempio: Enter a number from 0 to 100.

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

Action

Navigation

Invia o aggiorna le schede visualizzate.

Card

Pila di carte spinge una carta nella pila.

Card

La pila di schede aggiorna la scheda principale con una nuova scheda e conserva i valori dei campi compilati. Per un campo non equivalente, il valore viene eliminato.

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

Il valore di un input suggerito in un campo di immissione di testo. Equivale ai dati inseriti dagli utenti.

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

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

enum (InputType)

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

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

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

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

string

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

Specifica il testo che aiuti l'utente a inserire le informazioni necessarie alla 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".

enum (SelectionType)

Il tipo di elementi che vengono mostrati agli utenti in una SelectionInput widget. 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.

object (SelectionItem)

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

object (Action)

Se specificato, il modulo viene inviato quando la selezione cambia. Se non specificato, devi specificare un pulsante separato per l'invio del modulo.

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

integer

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

integer

Per i menu a più opzioni, il numero di caratteri di testo inseriti da un utente prima che le query dell'app vengano completate automaticamente e vengano visualizzati gli elementi suggeriti nel menu.

Se non specificato, il valore predefinito è 0 caratteri per le origini dati statiche e 3 caratteri per le origini dati esterne.

object (Validation)

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

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

object (Action)

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

object (PlatformDataSource)

Un'origine dati di Google Workspace.

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

Il testo che identifica o descrive l'articolo agli 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, consulta Ricevere i dati dei moduli.

boolean

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 per 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 file PNG e JPEG. Deve essere un HTTPS URL. 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 text .

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (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 saperne di più, vedi Installa le librerie client.

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

Un'origine dati di Google Chat.

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

Spazi di Google Chat di cui l'utente è membro.

{
  "defaultToCurrentSpace": boolean
}

boolean

Se impostato su true, nel menu a selezione multipla viene selezionato per impostazione predefinita lo spazio di Google Chat attuale come elemento.

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

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

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

string

Il testo che richiede 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.

enum (DateTimePickerType)

Se il widget supporta l'inserimento di data, ora o data e ora.

string (int64 format)

Il valore predefinito visualizzato nel widget, in millisecondi a partire da Tempo di Unix:

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

• DATE_AND_TIME : data e ora di calendario nel fuso orario UTC. Ad esempio, per indicare il 1° gennaio 2023 alle 12:00 UTC, utilizza 1672574400000.
• DATE_ONLY : una data di calendario alle 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).

integer

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

object (Action)

Si attiva quando l'utente fa clic Salva o Cancella dal DateTimePicker a riga di comando.

object (Validation)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

Il testo visualizzato nell'intestazione della griglia.

object (GridItem)

Gli elementi da visualizzare nella griglia.

object (BorderStyle)

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

integer

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

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

Un identificatore specificato dall'utente per questo elemento della griglia. Questo identificatore viene restituito nella griglia padre onClick i parametri di callback.

object (ImageComponent)

L'immagine visualizzata nell'elemento della griglia.

string

Il titolo dell'elemento della griglia.

string

Il sottotitolo dell'elemento della griglia.

enum (GridItemLayout)

Il layout da utilizzare per l'elemento della griglia.

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

L'URL dell'immagine.

string

L'etichetta di accessibilità per l'immagine.

object (ImageCropStyle)

Lo stile di ritaglio da applicare all'immagine.

object (BorderStyle)

Lo stile del bordo da applicare all'immagine.

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

Il tipo di ritaglio.

number

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
}

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

Il tipo di bordo.

object (Color)

I colori da utilizzare quando il tipo è BORDER_TYPE_STROKE.

Per impostare il colore del tratto, specifica un valore per il parametro red, green e blue campi. 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) rappresenta l'intensità massima del colore.

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

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

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

integer

Il raggio d'angolo del bordo.

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

Specifica se i widget sono allineati in alto, in basso o al centro di una colonna.

object (Widgets)

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

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph widget.

object (Image)

Image widget.

object (DecoratedText)

DecoratedText widget.

object (ButtonList)

ButtonList widget.

object (TextInput)

TextInput widget.

object (SelectionInput)

SelectionInput widget.

object (DateTimePicker)

DateTimePicker widget.

object (ChipList)

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

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

Layout dell'elenco di chip specificato.

object (Chip)

Un array di chip.

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

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

string

Il testo visualizzato all'interno del chip.

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

boolean

Indica se il chip è in stato attivo e risponde alle azioni dell'utente. Il valore predefinito è true. Deprecato. Utilizza le funzionalità di disabled .

boolean

Indica se il chip è in stato inattivo 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 passa alla documentazione per gli sviluppatori di Google Chat all'indirizzo https://developers.google.com/workspace/chat".

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

L'allineamento orizzontale del pulsante Espandi e Comprimi.

object (Button)

(Facoltativo) Definisci un pulsante personalizzabile per espandere la sezione. È necessario impostare sia il campo espandibiliButton che il campo CompressButton. Un solo set di campi non verrà applicato. Se questo campo non è impostato, viene utilizzato il pulsante predefinito.

object (Button)

(Facoltativo) Definisci un pulsante personalizzabile per comprimere la sezione. È necessario impostare sia il campo espandibiliButton che il campo CompressButton. Un solo set di campi non verrà applicato. Se questo campo non è impostato, viene utilizzato il pulsante predefinito.

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

L'etichetta visualizzata come voce del menu azione.

object (OnClick)

La onClick per questa attività.

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

Il pulsante secondario del piè di pagina fisso. Il pulsante deve essere un pulsante di testo con testo e colori impostati. Se secondaryButton devi impostare anche primaryButton.