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)

En-tête de la fiche. Un en-tête contient généralement une image de début et un titre. Les en-têtes apparaissent toujours en haut des fiches.

object (Section)

Contient un ensemble de widgets. Chaque section possède son propre en-tête facultatif. Les sections sont séparées visuellement par une ligne de séparation. Pour voir un exemple dans les applications Google Chat, consultez Définir une section d'une fiche

enum (DividerStyle)

Style de séparation entre les sections.

object (CardAction)

Actions de la fiche. Les actions sont ajoutées au menu de la barre d'outils de la fiche.

Disponible pour les modules complémentaires Google Workspace et indisponible pour les applications Google Chat.

Par exemple, le code JSON suivant construit un menu d'actions de carte avec Settings et Send Feedback options:

"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

Nom de la carte. Utilisé comme identifiant de carte dans la navigation par carte.

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

object (CardFixedFooter)

Pied de page fixe affiché au bas de cette fiche.

Paramètre fixedFooter sans spécifier de primaryButton ou un secondaryButton provoque une erreur. Pour les applications Chat, vous pouvez utiliser des pieds de page fixes dans dialogs, mais pas messages sous forme de fiches.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

enum (DisplayStyle)

Dans les modules complémentaires Google Workspace, cette option permet de définir les propriétés d'affichage peekCardHeader

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

object (CardHeader)

Lors de l'affichage de contenu contextuel, l'en-tête de la fiche d'aperçu fait office d'espace réservé pour que l'utilisateur puisse naviguer entre les fiches de la page d'accueil et les fiches contextuelles.

Disponible pour les modules complémentaires Google Workspace et indisponible pour les applications Google Chat.

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

string

Obligatoire. Titre de l'en-tête de la fiche. L'en-tête a une hauteur fixe: si un titre et un sous-titre sont tous les deux spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.

string

Sous-titre de l'en-tête de la carte. S'il est spécifié, il apparaît sur sa propre ligne sous la title

enum (ImageType)

Forme utilisée pour recadrer l'image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

string

URL HTTPS de l'image dans l'en-tête de la fiche.

string

Texte alternatif de cette image utilisé pour l'accessibilité.

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

string

Texte qui s'affiche en haut d'une section. Accepte les textes au format HTML simple. Pour en savoir plus sur la mise en forme du texte, consultez les articles Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

object (Widget)

Tous les widgets de la section. Doit contenir au moins un widget.

boolean

Indique si cette section peut être réduite.

Les sections réductibles masquent certains ou tous les widgets, mais les utilisateurs peuvent la développer pour afficher les widgets masqués en cliquant sur Plus : Les utilisateurs peuvent à nouveau masquer les widgets en cliquant sur Afficher moins.

Pour déterminer quels widgets sont masqués, indiquez uncollapsibleWidgetsCount

integer

Nombre de widgets non réductibles qui restent visibles même lorsqu'une section est réduite.

Par exemple, lorsqu'une section contient cinq widgets et que uncollapsibleWidgetsCount est défini sur 2, les deux premiers widgets sont toujours affichés et les trois derniers sont réduits par défaut. La uncollapsibleWidgetsCount n'est prise en compte collapsible correspond à true

object (CollapseControl)

Facultatif. Définissez le bouton de développement et de réduction de la section. Ce bouton ne s'affiche que si la section peut être réduite. Si ce champ n'est pas défini, le bouton par défaut est utilisé. Disponible pour les applications Google Chat et non disponible pour les modules complémentaires 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)

Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.

object (TextParagraph)

Affiche un paragraphe de texte. Compatible avec le texte au format HTML simple. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace

Par exemple, le code JSON suivant crée un texte en gras:

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

object (Image)

Affiche une image.

Par exemple, le code JSON suivant crée une image avec un texte alternatif:

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

object (DecoratedText)

Affiche un élément textuel décoré.

Par exemple, le code JSON suivant crée un widget de texte décoré affichant une adresse e-mail :

"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)

Liste de boutons.

Par exemple, l'exemple JSON suivant crée deux boutons. Le premier est un bouton de texte bleu et le second est un bouton image qui ouvre un lien:

"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)

Affiche une zone de texte dans laquelle les utilisateurs peuvent saisir du texte.

Par exemple, le fichier JSON suivant crée une entrée de texte pour une adresse e-mail:

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

Dans cet autre exemple, le code JSON suivant crée une entrée de texte pour un langage de programmation à l'aide de suggestions statiques:

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

object (SelectionInput)

Affiche une commande de sélection qui permet aux utilisateurs de sélectionner des éléments. Les commandes de sélection peuvent être des cases à cocher, des cases d'option, des boutons bascules ou des menus déroulants.

Par exemple, le code JSON suivant crée un menu déroulant qui permet aux utilisateurs de choisir une taille:

"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)

Affiche un widget qui permet aux utilisateurs de saisir une date, une heure, ou une date et une heure.

Par exemple, le code JSON suivant crée un sélecteur de date et d'heure pour planifier un rendez-vous :

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

object (Divider)

Affiche une ligne horizontale de séparation entre les widgets.

Par exemple, le code JSON suivant crée un séparateur:

"divider": {
}

object (Grid)

Affiche une grille avec une collection d'éléments.

Une grille peut comporter un nombre illimité de colonnes et d'éléments. Le nombre de lignes est déterminé par la limite supérieure du nombre d'éléments divisé par le nombre de colonnes. Une grille de 10 éléments et 2 colonnes contient 5 lignes. Une grille de 11 éléments et 2 colonnes contient 6 lignes.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Par exemple, le code JSON suivant crée une grille à deux colonnes avec un seul élément:

"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)

Affiche jusqu'à deux colonnes.

Pour inclure plus de deux colonnes ou utiliser des lignes, utilisez les Grid .

Par exemple, le code JSON suivant crée deux colonnes contenant chacune des paragraphes de texte:

"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)

Liste de chips.

Par exemple, le code JSON suivant crée deux chips. Le premier est un chip de texte et le second est un chip d'icône qui permet d'ouvrir un lien:

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

Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

string

Texte affiché dans le widget.

integer

Nombre maximal de lignes de texte affichées dans le widget. Si le texte dépasse le nombre maximal de lignes spécifié, le contenu en trop est dissimulé derrière un afficher plus . Si le texte est inférieur ou égal au nombre maximal de lignes spécifié, une afficher plus ne s'affiche pas.

La valeur par défaut est 0, ce qui signifie que tout le contexte est affiché. Les valeurs négatives sont ignorées. Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

string

URL HTTPS qui héberge l'image.

Exemple :

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

object (OnClick)

Lorsqu'un utilisateur clique sur l'image, le clic déclenche cette action.

string

Texte alternatif de cette image utilisé pour 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)

Si cet argument est spécifié, une action est déclenchée onClick

object (OpenLink)

Si cet argument est spécifié, onClick déclenche l'ouverture d'un lien.

object (Action)

Un module complémentaire déclenche cette action lorsqu'elle doit ouvrir un lien. Cela diffère du openLink ci-dessus, en ce sens que celui-ci doit communiquer avec le serveur pour obtenir le lien. Par conséquent, un travail de préparation est nécessaire au client Web avant le retour de la réponse à l'action de lien ouvert.

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

object (Card)

Si un clic est spécifié, une nouvelle carte est transférée dans la pile de cartes.

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

object (OverflowMenu)

Si cet argument est spécifié, onClick ouvre un menu à développer. Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

string

Fonction personnalisée à invoquer lorsque l'utilisateur clique sur l'élément parent ou est activé d'une autre manière.

Pour un exemple d'utilisation, consultez Lire les données de formulaire

object (ActionParameter)

Liste des paramètres d'action.

enum (LoadIndicator)

Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action.

boolean

Indique si les valeurs du formulaire sont conservées après l'action. La valeur par défaut est false

Si true, les valeurs du formulaire restent après le déclenchement de l'action. Pour permettre à l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator à NONE Pour les messages de fiche dans les applications Chat, vous devez également définir la valeur ResponseType de l'action sur UPDATE_MESSAGE et utiliser la même cardId de la fiche qui contenait l'action.

Si false, les valeurs du formulaire sont effacées lorsque l'action est déclenchée. Pour empêcher l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator à SPINNER

enum (Interaction)

Facultatif. Obligatoire pour ouvrir un dialog.

Que faire en réponse à une interaction avec un utilisateur (par exemple, un utilisateur qui clique sur un bouton dans un message de fiche) ?

Si aucune valeur n'est spécifiée, l'application répond en exécutant une action (par exemple, en ouvrant un lien ou en exécutant une fonction).

En spécifiant un interaction, l'application peut répondre de manière interactive spéciale. Par exemple, en définissant interaction sur OPEN_DIALOG, l'application peut ouvrir une boîte de dialogue. Si spécifié, aucun indicateur de chargement ne s'affiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

string

Si les widgets listés ici n'ont pas de valeur lorsque cette action est appelée, l'envoi du formulaire est interrompu.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

boolean

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

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

string

Nom du paramètre pour le script d'action.

string

Valeur du paramètre.

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

string

URL à ouvrir.

enum (OpenAs)

Ouvrir un lien

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

enum (OnClose)

Indique si le client a oublié un lien après l'avoir ouvert ou l'observe jusqu'à la fermeture de la fenêtre.

Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.

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

object (OverflowMenuItem)

Obligatoire. Liste des options du menu.

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

object (Icon)

Icône affichée devant le texte.

string

Obligatoire. Texte qui identifie ou décrit l'élément pour les utilisateurs.

object (OnClick)

Obligatoire. Action appelée lorsqu'une option de menu est sélectionnée. Ce OnClick ne peut pas contenir OverflowMenu (valeur spécifiée) OverflowMenu est supprimé et l'élément de menu est désactivé.

boolean

Indique si l'option de menu est désactivée. Valeur par défaut : "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

Facultatif. Description de l'icône utilisée pour l'accessibilité. Si elle n'est pas spécifiée, la valeur par défaut Button est fournie. Il est recommandé de définir une description utile de ce que l'icône affiche et, le cas échéant, de son fonctionnement. Par exemple, A user's account portrait ou Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat

Si l'icône est définie dans un Button, le altText apparaît en tant que texte d'aide lorsque l'utilisateur pointe sur le bouton. Toutefois, si le bouton définit également text, l'icône altText est ignoré.

enum (ImageType)

Style de recadrage appliqué à l'image. Dans certains cas, l'application d'une CIRCLE recadrée rend l'image plus grande qu'une icône intégrée.

string

Affichez l'une des icônes intégrées fournies par Google Workspace.

Par exemple, pour afficher une icône en forme d'avion, spécifiez AIRPLANE. Pour un bus, indiquez BUS

Pour obtenir la liste complète des icônes prises en charge, consultez icônes intégrées.

string

Affichez une icône personnalisée hébergée sur une URL HTTPS.

Exemple :

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

Types de fichiers compatibles : .png et .jpg

object (MaterialIcon)

Affichez l'une des icônes Google Material.

Par exemple, pour afficher une icône de case à cocher, utilisez

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

Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

string

Nom de l'icône défini dans le Icône Google Material, par exemple, check_box Tous les noms non valides sont abandonnés et remplacés par une chaîne vide, ce qui entraîne l'échec de l'affichage de l'icône.

boolean

Indique si l'icône est remplie ou non. La valeur par défaut est Faux (false).

Pour prévisualiser différents paramètres d'icône, accédez à Icônes Google Fonts et ajustez les paramètres sous Personnaliser :

integer

Épaisseur du trait de l'icône. Choisissez parmi les valeurs {100, 200, 300, 400, 500, 600, 700}. Si ce champ n'est pas renseigné, la valeur par défaut est 400. Si une autre valeur est spécifiée, la valeur par défaut est utilisée.

Pour prévisualiser différents paramètres d'icône, accédez à Icônes Google Fonts et ajustez les paramètres sous Personnaliser :

integer

Le poids et le niveau déterminent l'épaisseur d'un symbole. Les ajustements de note sont plus précis que les ajustements de pondération et ont un faible impact sur la taille du symbole. Choisissez parmi {-25, 0, 200}. Si ce champ n'est pas renseigné, la valeur par défaut est 0. Si une autre valeur est spécifiée, la valeur par défaut est utilisée.

Pour prévisualiser différents paramètres d'icône, accédez à Icônes Google Fonts et ajustez les paramètres sous Personnaliser :

{
  "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)

Obsolète au profit de startIcon

object (Icon)

Icône affichée devant le texte.

string

Texte qui s'affiche au-dessus de text. Toujours tronquer

string

Obligatoire. Texte principal.

Permet une mise en forme simple. Pour en savoir plus sur la mise en forme du texte, consultez les articles Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

boolean

Paramètre de retour à la ligne. Si la valeur est true, le texte se scinde et s'affiche sur plusieurs lignes. Sinon, le texte est tronqué.

S'applique uniquement aux éléments suivants : text, et non topLabel et bottomLabel

string

Le texte qui s'affiche en dessous text Encapsule toujours.

object (OnClick)

Cette action est déclenchée lorsque les utilisateurs cliquent sur topLabel ou bottomLabel.

object (Button)

Un bouton sur lequel un utilisateur peut cliquer pour déclencher une action.

object (SwitchControl)

Widget de contacteur sur lequel l'utilisateur peut cliquer pour modifier son état et déclencher une action.

object (Icon)

Icône affichée après le texte.

Compatible intégré et personnalisé .

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

string

Texte affiché à l'intérieur du bouton.

object (Icon)

Icône affichée à l'intérieur du bouton. Si les icon et text sont définies, l'icône apparaît avant le texte.

object (Color)

Facultatif. Couleur du bouton. S'il est défini, le bouton type est défini sur FILLED et la couleur du text et icon sont définis sur une couleur contrastée pour une meilleure lisibilité. Par exemple, si la couleur du bouton est bleue, le texte ou les icônes du bouton sont définis en blanc.

Pour définir la couleur du bouton, indiquez une valeur pour le paramètre red, green blue . La valeur doit être un nombre à virgule flottante compris entre 0 et 1, en fonction de la valeur de couleur RVB, où 0 (0/255) représente l'absence de couleur et 1 (255/255) représente l'intensité maximale de la couleur.

Par exemple, le code suivant définit la couleur sur rouge à son intensité maximale:

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

La alpha le champ n'est pas disponible pour la couleur du bouton. Si ce champ est spécifié, il est ignoré.

object (OnClick)

Obligatoire. Action à effectuer lorsqu'un utilisateur clique sur le bouton, par exemple ouvrir un lien hypertexte ou exécuter une fonction personnalisée.

boolean

Si la valeur est true, le bouton s'affiche dans un état inactif et ne répond pas aux actions de l'utilisateur.

string

Texte de substitution utilisé pour l'accessibilité.

Définissez un texte descriptif qui indique aux utilisateurs la fonction du bouton. Par exemple, si un bouton ouvre un lien hypertexte, vous pouvez écrire : "Ouvre un nouvel onglet de navigateur et permet d'accéder à la documentation Google Chat destinée aux développeurs à l'adresse https://developers.google.com/workspace/chat".

enum (Type)

Facultatif. Type de bouton. Si cette valeur n'est pas définie, le type de bouton est défini par défaut sur OUTLINED. Si le color est défini, le type de bouton est obligatoire FILLED et toute valeur définie pour ce champ est ignorée.

Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

number

Quantité de rouge dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Quantité de vert dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Quantité de bleu dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Fraction de cette couleur à appliquer au pixel. En d'autres termes, la couleur finale du pixel est définie par l'équation :

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

Cela signifie qu'une valeur de 1,0 correspond à une couleur solide, tandis qu'une valeur de 0,0 correspond à une couleur complètement transparente. Un message wrapper est utilisé à la place d'une simple valeur scalaire flottante afin qu'il soit possible de distinguer une valeur par défaut de la valeur non définie. S'il est omis, cet objet couleur est affiché sous la forme d'une couleur unie (comme si la valeur alpha avait été explicitement définie sur 1,0).

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

string

Nom par lequel le widget switch est identifié dans un événement d'entrée de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

string

Valeur saisie par un utilisateur, renvoyée dans le cadre d'un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

boolean

Quand ? true, le bouton bascule est sélectionné.

object (Action)

Action à effectuer lorsque l'état du bouton bascule est modifié, par exemple la fonction à exécuter.

enum (ControlType)

Affichage du bouton bascule dans l'interface utilisateur

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

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

object (Button)

Tableau de boutons.

{
  "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

Nom par lequel la saisie de texte est identifiée dans un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

string

Texte qui apparaît au-dessus du champ de saisie dans l'interface utilisateur.

Spécifiez un texte qui aide l'utilisateur à saisir les informations dont votre application a besoin. Par exemple, si vous demandez le nom d'une personne, mais que vous avez besoin de son nom de famille, écrivez surname au lieu de name

Obligatoire si hintText n'est pas spécifiée. Sinon, facultatif.

string

Texte qui s'affiche sous le champ de saisie pour aider les utilisateurs en les invitant à saisir une certaine valeur. Ce texte est toujours visible.

Obligatoire si label n'est pas spécifiée. Sinon, facultatif.

string

Valeur saisie par un utilisateur, renvoyée dans le cadre d'un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

enum (Type)

Affichage d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, indiquez si le champ comporte une ou plusieurs lignes.

object (Action)

Que faire en cas de modification du champ de saisie de texte ? Par exemple, un utilisateur ajoute du texte dans le champ ou en supprime.

Les exemples d'actions à effectuer incluent l'exécution d'une fonction personnalisée ou l'ouverture d'un boîte de dialogue dans Google Chat.

object (Suggestions)

Suggestions de valeurs que les utilisateurs peuvent saisir. Ces valeurs apparaissent lorsque les utilisateurs cliquent dans le champ de saisie de texte. À mesure que les utilisateurs saisissent du texte, les valeurs suggérées sont filtrées de manière dynamique pour correspondre à ce qu'ils ont saisi.

Par exemple, un champ de saisie de texte pour un langage de programmation peut suggérer Java, JavaScript, Python et C++. Lorsque les utilisateurs commencent à saisir du texte Jav, la liste de filtres de suggestions à afficher uniquement Java et JavaScript

Les valeurs suggérées aident les utilisateurs à saisir des valeurs pertinentes pour votre application. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir javascript et autres java script Suggestion JavaScript peuvent standardiser la façon dont les utilisateurs interagissent avec votre application.

Si spécifié, TextInput.type est toujours SINGLE_LINE, même s'il est défini sur MULTIPLE_LINE

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

object (Action)

Facultatif. Spécifiez l'action à effectuer lorsque le champ de saisie de texte fournit des suggestions aux utilisateurs qui interagissent avec lui.

Si aucune valeur n'est spécifiée, les suggestions sont définies par initialSuggestions et sont traités par le client.

Si elle est spécifiée, l'application effectue l'action spécifiée ici, comme exécuter une fonction personnalisée.

Disponible pour les modules complémentaires Google Workspace et indisponible pour les applications Google Chat.

object (Validation)

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

string

Texte qui s'affiche dans le champ de saisie lorsque celui-ci est vide. Utilisez ce texte pour inviter les utilisateurs à saisir une valeur. Exemple : Enter a number from 0 to 100.

Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Action

Navigation

Transférez ou mettez à jour les cartes affichées.

Card

La pile de cartes pousse une carte sur la pile de cartes.

Card

La pile de cartes remplace la carte du dessus par une nouvelle carte et conserve les valeurs des champs de formulaire remplis. Pour un champ non équivalent, la valeur est supprimée.

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

object (SuggestionItem)

Liste de suggestions utilisées pour les recommandations de saisie semi-automatique dans les champs de saisie de texte.

{

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

string

Valeur d'une suggestion d'entrée dans un champ de saisie de texte. Cela correspond à ce que les utilisateurs saisissent eux-mêmes.

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

integer

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

enum (InputType)

Disponible pour les applications Google Chat et les modules complémentaires 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

Obligatoire. Nom qui identifie l'entrée de sélection dans un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

string

Texte qui s'affiche au-dessus du champ de saisie de sélection dans l'interface utilisateur.

Spécifiez du texte qui aide l'utilisateur à saisir les informations dont votre application a besoin. Par exemple, si les utilisateurs sélectionnent l'urgence d'un ticket de travail dans un menu déroulant, le libellé peut être "Urgence". ou "Sélectionner le degré d'urgence".

enum (SelectionType)

Type d'éléments présentés aux utilisateurs dans une SelectionInput . Les types de sélection sont compatibles avec différents types d'interactions. Par exemple, les utilisateurs peuvent cocher une ou plusieurs cases, mais ils ne peuvent sélectionner qu'une seule valeur dans un menu déroulant.

object (SelectionItem)

Tableau d'éléments sélectionnables. Par exemple, un tableau de cases d'option ou de cases à cocher. Jusqu'à 100 éléments sont acceptés.

object (Action)

Si elle est spécifiée, le formulaire est envoyé lorsque la sélection change. Si aucune valeur n'est spécifiée, vous devez ajouter un bouton distinct pour envoyer le formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez la section Recevoir des données de formulaire.

integer

Pour les menus à sélection multiple, nombre maximal d'éléments qu'un utilisateur peut sélectionner. La valeur minimale est de 1 article. Si aucune valeur n'est spécifiée, la valeur par défaut est de 3 éléments.

integer

Pour les menus à sélection multiple, nombre de caractères de texte saisis par l'utilisateur avant que l'application n'interroge la saisie semi-automatique et affiche les éléments suggérés dans le menu.

Si cette valeur n'est pas spécifiée, elle est définie par défaut sur 0 caractère pour les sources de données statiques et sur 3 caractères pour les sources de données externes.

object (Validation)

Pour les menus déroulants, validation de ce champ de saisie de sélection.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

object (Action)

Source de données externe, telle qu'une base de données relationnelle.

object (PlatformDataSource)

Une source de données Google Workspace.

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

string

Texte qui identifie ou décrit l'élément pour les utilisateurs.

string

Valeur associée à cet élément. Le client doit l'utiliser comme valeur d'entrée du formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

boolean

Indique si l'élément est sélectionné par défaut. Si la zone de saisie de sélection n'accepte qu'une seule valeur (par exemple, pour les boutons d'option ou un menu déroulant), ne définissez ce champ que pour un seul élément.

string

Pour les menus à sélection multiple, l'URL de l'icône affichée à côté de l'icône text . Compatible avec les fichiers PNG et JPEG. Doit être une URL HTTPS. Par exemple, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

string

Pour les menus à sélection multiple, une description textuelle ou un libellé qui s'affiche sous le nom de l'élément 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)

Source de données partagée par toutes les applications Google Workspace, telles que les utilisateurs d'une organisation Google Workspace.

object (HostAppDataSourceMarkup)

Source de données propre à une application hôte Google Workspace, comme les espaces dans Google Chat.

Ce champ est compatible avec les bibliothèques clientes des API Google, mais n'est pas disponible dans les bibliothèques clientes Cloud. Pour en savoir plus, consultez la section Installer les bibliothèques clientes.

{

  // 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)

Source de données de 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)

Espaces Google Chat dont l'utilisateur est membre.

{
  "defaultToCurrentSpace": boolean
}

boolean

Si défini sur true, le menu multi-sélection sélectionne par défaut l'espace Google Chat actuel comme élément.

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

string

Le nom sous lequel DateTimePicker est identifié dans un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire

string

Texte qui invite les utilisateurs à saisir une date, une heure ou une date et une heure. Par exemple, si les utilisateurs planifient un rendez-vous, utilisez un libellé tel que Appointment date ou Appointment date and time.

enum (DateTimePickerType)

Indique si le widget prend en charge la saisie d'une date, d'une heure, ou de la date et l'heure.

string (int64 format)

Valeur par défaut affichée dans le widget, en millisecondes depuis l'epoch Unix.

Spécifiez la valeur en fonction du type de sélecteur ( DateTimePickerType):

• DATE_AND_TIME : une date et une heure du calendrier au format UTC. Par exemple, pour représenter le 1er janvier 2023 à minuit UTC, utilisez 1672574400000
• DATE_ONLY : une date du calendrier à 00:00:00 UTC. Par exemple, pour représenter le 1er janvier 2023, utilisez 1672531200000
• TIME_ONLY : une heure UTC. Par exemple, pour indiquer 12:00, utilisez 43200000 (ou 12 * 60 * 60 * 1000).

integer

Nombre représentant le décalage horaire par rapport à UTC, en minutes. S'il est défini, valueMsEpoch s'affiche dans le fuseau horaire spécifié. Si cette règle n'est pas configurée, la valeur par défaut est le fuseau horaire de l'utilisateur.

object (Action)

Déclenchement lorsque l'utilisateur clique sur Enregistrer ou Effacer à partir de DateTimePicker de commande.

object (Validation)

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

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

string

Texte affiché dans l'en-tête de la grille.

object (GridItem)

Éléments à afficher dans la grille.

object (BorderStyle)

Style de bordure à appliquer à chaque élément de la grille.

integer

Nombre de colonnes à afficher dans la grille. Une valeur par défaut est utilisée si ce champ n'est pas spécifié. Cette valeur par défaut varie en fonction de l'emplacement de la grille (boîte de dialogue ou création associée).

object (OnClick)

Ce rappel est réutilisé par chaque élément individuel de la grille, mais avec l'identifiant et l'index de l'élément dans la liste des éléments ajoutés aux paramètres du rappel.

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

string

Identifiant spécifié par l'utilisateur pour cet élément de la grille. Cet identifiant est renvoyé dans le onClick paramètres de rappel.

object (ImageComponent)

Image affichée dans l'élément de la grille.

string

Titre de l'élément de grille.

string

Sous-titre de l'élément de grille.

enum (GridItemLayout)

Mise en page à utiliser pour l'élément de grille.

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

string

URL de l'image.

string

Libellé d'accessibilité de l'image.

object (ImageCropStyle)

Style de recadrage à appliquer à l'image.

object (BorderStyle)

Style de bordure à appliquer à l'image.

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

enum (ImageCropType)

Type de recadrage.

number

Le format à utiliser si le type de recadrage est RECTANGLE_CUSTOM

Par exemple, voici comment appliquer un format 16:9 :

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

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

enum (BorderType)

Type de bordure.

object (Color)

Les couleurs à utiliser lorsque le type est BORDER_TYPE_STROKE

Pour définir la couleur du trait, spécifiez une valeur pour le paramètre red, green blue . La valeur doit être un nombre à virgule flottante compris entre 0 et 1, en fonction de la valeur de couleur RVB, où 0 (0/255) représente l'absence de couleur et 1 (255/255) représente l'intensité maximale de la couleur.

Par exemple, l'exemple suivant définit la couleur rouge à son intensité maximale :

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

La alpha le champ n'est pas disponible pour la couleur du trait. Si elle est spécifiée, ce champ est ignoré.

integer

Rayon d'angle de la bordure.

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

object (Column)

Tableau de colonnes. Vous pouvez inclure jusqu'à deux colonnes dans une fiche ou une boîte de dialogue.

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

enum (HorizontalSizeStyle)

Indique comment une colonne remplit la largeur de la fiche.

enum (HorizontalAlignment)

Indique si les widgets doivent être alignés à gauche, à droite ou au centre d'une colonne.

enum (VerticalAlignment)

Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne.

object (Widgets)

Tableau de widgets inclus dans une colonne. Les widgets apparaissent dans l'ordre dans lequel ils sont spécifiés.

{

  // 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)

Widget TextParagraph

object (Image)

Image .

object (DecoratedText)

DecoratedText .

object (ButtonList)

ButtonList .

object (TextInput)

TextInput .

object (SelectionInput)

SelectionInput .

object (DateTimePicker)

DateTimePicker .

object (ChipList)

ChipList . Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

enum (Layout)

Mise en page de la liste de chips spécifiée.

object (Chip)

Tableau de chips.

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

object (Icon)

Image de l'icône Si les valeurs icon et text sont définies, l'icône s'affiche avant le texte.

string

Texte affiché dans le chip.

object (OnClick)

Facultatif. Action à effectuer lorsqu'un utilisateur clique sur le chip, par exemple ouvrir un lien hypertexte ou exécuter une fonction personnalisée.

boolean

Indique si la puce est active et répond aux actions de l'utilisateur. La valeur par défaut est true Obsolète. Utilisez disabled à la place.

boolean

Indique si la puce est inactive et ignore les actions de l'utilisateur. La valeur par défaut est false

string

Texte alternatif utilisé pour l'accessibilité.

Définissez un texte descriptif qui indique aux utilisateurs à quoi sert le chip. Par exemple, si un chip ouvre un lien hypertexte, écrivez : "Ouvre un nouvel onglet de navigateur et accède à la documentation pour les développeurs Google Chat à l'adresse https://developers.google.com/workspace/chat".

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

enum (HorizontalAlignment)

Alignement horizontal du bouton de développement et de réduction.

object (Button)

Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs "expandButton" et "Réduire" doivent tous les deux être définis. Seul un seul ensemble de champs ne sera pas appliqué. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

object (Button)

Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs "expandButton" et "Réduire" doivent tous les deux être définis. Un seul ensemble de champs ne sera pas pris en compte. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

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

string

Libellé qui s'affiche en tant qu'élément de menu d'actions.

object (OnClick)

La onClick pour cette action.

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

object (Button)

Bouton principal du pied de page fixe. Le bouton doit être de type texte, et les couleurs et le texte doivent être définis.

object (Button)

Bouton secondaire du pied de page fixe. Le bouton doit être de type texte, et les couleurs et le texte doivent être définis. Si secondaryButton est définie, vous devez également définir primaryButton