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 carte. Un en-tête contient généralement une image d’introduction et un titre. Les en-têtes apparaissent toujours en haut d'une fiche.

object (Section)

Contient une collection de widgets. Chaque section a son propre en-tête facultatif. Les sections sont séparées visuellement par un séparateur. Pour obtenir un exemple dans les applications Google Chat, consultez la section Carte.

enum (DividerStyle)

Style de séparateur entre les sections.

object (CardAction)

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

Comme les cartes des applications Chat n'ont pas de barre d'outils, cardActions[] n'est pas compatible avec les applications Chat.

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

"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 dans les cartes.

Étant donné que les applications Chat ne sont pas compatibles avec la navigation dans les cartes, elles ignorent ce champ.

object (CardFixedFooter)

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

Si vous définissez fixedFooter sans spécifier de primaryButton ni de secondaryButton, une erreur est générée.

Compatible avec les modules complémentaires Google Workspace et les applications Chat Pour les applications Chat, vous pouvez utiliser des pieds de page fixes dans les boîtes de dialogue, mais pas les messages sous forme de fiches.

enum (DisplayStyle)

Dans les modules complémentaires Google Workspace, définit les propriétés d'affichage de peekCardHeader.

Non compatible avec les applications Chat.

object (CardHeader)

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

Non compatible avec les applications Chat.

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

string

Obligatoire. Titre de l'en-tête de la carte. L'en-tête a une hauteur fixe: si un titre et un sous-titre sont 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. Si spécifié, il apparaît sur une ligne distincte sous title.

enum (ImageType)

Forme utilisée pour recadrer l'image.

string

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

string

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

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

string

Texte affiché en haut d'une section. Accepte 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 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 tout ou partie des widgets. Toutefois, les utilisateurs peuvent développer la section pour afficher les widgets masqués en cliquant sur Afficher plus. Les utilisateurs peuvent à nouveau masquer les widgets en cliquant sur Afficher moins.

Pour déterminer quels widgets sont masqués, spécifiez 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. uncollapsibleWidgetsCount n'est pris en compte que lorsque collapsible est défini sur true.

{
  "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)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

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

object (TextParagraph)

Affiche un paragraphe de texte. Accepte 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 du 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/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 l'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)

Une liste de boutons

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

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 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 code 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 avec des 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 permettant 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 permettant 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 de séparation horizontale entre les widgets.

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

"divider": {
}

object (Grid)

Affiche une grille avec un ensemble d'éléments.

Une grille accepte 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 comporte 5 lignes. Une grille de 11 éléments et 2 colonnes comporte 6 lignes.

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 des lignes, utilisez le widget 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"
          }
        }
      ]
    }
  ]
}

{
  "text": string
}

string

Texte affiché dans le widget.

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

string

URL HTTPS qui héberge l'image.

Exemple :

https://developers.google.com/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)
  }
  // End of list of possible types for union field data.
}

object (Action)

Si cet élément onClick est spécifié, une action est déclenchée.

object (OpenLink)

Si cet élément onClick est spécifié, il déclenche une action d'ouverture du lien.

object (Action)

Un module complémentaire déclenche cette action lorsqu'elle doit ouvrir un lien. Cette méthode diffère du openLink ci-dessus dans la mesure où elle doit communiquer avec le serveur pour obtenir le lien. Ainsi, un travail de préparation est nécessaire pour le client Web avant le retour de la réponse d'action de lien ouvert. Compatible avec les modules complémentaires Google Workspace, mais pas avec les applications Google Chat

object (Card)

Une nouvelle fiche est ajoutée à la pile de cartes après que l'utilisateur a cliqué dessus.

Compatible avec les modules complémentaires Google Workspace, mais pas avec les applications Google Chat

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

string

Fonction personnalisée à invoquer lorsque l'utilisateur clique sur l'élément conteneur ou est activé.

Pour obtenir un exemple d'utilisation, consultez la section Créer des fiches interactives.

object (ActionParameter)

Liste des paramètres d'action.

enum (LoadIndicator)

Spécifie l'indicateur de chargement affiché 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 la valeur est 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 sur NONE. Pour les messages sous forme de fiches dans les applications Chat, vous devez également définir ResponseType de l'action sur UPDATE_MESSAGE et utiliser le même cardId que celui de la fiche contenant l'action.

Si la valeur est 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 sur SPINNER.

enum (Interaction)

Facultatif. Obligatoire lors de l'ouverture d'une boîte de dialogue.

Que faire en réponse à une interaction avec un utilisateur (par exemple, lorsqu'il clique sur un bouton dans une fiche) ?

Si elle n'est pas spécifiée, l'application répond en exécutant normalement un action (comme l'ouverture d'un lien ou l'exécution d'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 cet indicateur est spécifié, aucun indicateur de chargement ne s'affiche.

Compatible avec les applications Chat, mais pas avec les modules complémentaires Google Workspace 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.

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

string

Nom du paramètre du script d'action.

string

Valeur du paramètre.

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

string

URL à ouvrir.

enum (OpenAs)

Ouvrir un lien. Non compatible avec les applications Chat.

enum (OnClose)

Ce paramètre indique si le client oublie un lien après l'avoir ouvert ou l'observe jusqu'à la fermeture de la fenêtre. Non compatible avec les applications Chat.

{
  "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. Tronque toujours.

string

Obligatoire. Texte principal.

Compatible avec la mise en forme 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 du texte dans les modules complémentaires Google Workspace.

boolean

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

S'applique uniquement à text, et non à topLabel et bottomLabel.

string

Texte qui s'affiche sous text. Encapsule toujours.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

Widget switch sur lequel un utilisateur peut cliquer pour modifier son état et déclencher une action.

object (Icon)

Icône affichée après le texte

Compatible avec les icônes intégrées et personnalisées.

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

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

string

Facultatif. Description de l'icône utilisée pour l'accessibilité. Si aucune valeur n'est 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 rôle. 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/chat.

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

enum (ImageType)

Style de recadrage appliqué à l'image. Dans certains cas, si vous appliquez un recadrage CIRCLE, l'image est 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 d'avion, spécifiez AIRPLANE. Pour un bus, spécifiez BUS.

Pour obtenir la liste complète des icônes compatibles, consultez la section Icônes intégrées.

string

afficher une icône personnalisée hébergée sur une URL HTTPS ;

Exemple :

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

Les types de fichiers .png et .jpg sont acceptés.

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

string

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

object (Icon)

Image de l'icône. Si icon et text sont tous deux définis, l'icône apparaît avant le texte.

object (Color)

S'il est défini, le bouton est rempli d'une couleur d'arrière-plan unie et la couleur de la police change pour maintenir le contraste avec la couleur d'arrière-plan. Par exemple, si vous définissez un arrière-plan bleu, le texte sera probablement blanc.

Si cette règle n'est pas configurée, l'arrière-plan de l'image est blanc et la couleur de la police est bleue.

Pour le rouge, le vert et le bleu, la valeur de chaque champ est un nombre float que vous pouvez exprimer de deux manières différentes: sous la forme d'un nombre compris entre 0 et 255 divisé par 255 (153/255) ou d'une valeur comprise entre 0 et 1 (0,6). 0 représente l'absence de couleur, et 1 ou 255/255 représente la présence totale de cette couleur sur l'échelle RVB.

Vous pouvez également définir alpha, qui définit un niveau de transparence à l'aide de l'équation suivante:

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

Pour alpha, la valeur 1 correspond à une couleur unie, et la valeur 0 à une couleur complètement transparente.

Par exemple, la couleur suivante représente un rouge à moitié transparent:

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

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 à l'état inactif et ne répond pas aux actions de l'utilisateur.

string

Texte alternatif utilisé pour l'accessibilité.

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

{
  "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 rendu en tant que couleur unie (comme si la valeur alpha avait été explicitement affectée à la valeur 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 de saisie de formulaire.

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

string

Valeur saisie par un utilisateur, renvoyée dans un événement de saisie de formulaire.

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

boolean

Si true, le bouton bascule est sélectionné.

object (Action)

L'action à effectuer lorsque l'état du commutateur est modifié, par exemple la fonction à exécuter.

enum (ControlType)

Affichage du bouton bascule dans l'interface utilisateur.

{
  "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)
  },
  "placeholderText": string
}

string

Nom par lequel l'entrée 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 des données de formulaire.

string

Texte affiché au-dessus du champ de saisie de texte dans l'interface utilisateur.

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

Obligatoire si hintText n'est pas spécifié. Sinon, cette étape est facultative.

string

Texte affiché sous le champ de saisie de texte destiné à aider les utilisateurs en les invitant à saisir une certaine valeur. Ce texte est toujours visible.

Obligatoire si label n'est pas spécifié. Sinon, cette étape est facultative.

string

Valeur saisie par un utilisateur, renvoyée dans un événement de saisie de formulaire.

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

enum (Type)

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

object (Action)

Que faire lorsqu'une modification se produit dans le champ de saisie de texte ? (par exemple, lorsqu'un utilisateur ajoute du texte au champ ou supprime du texte).

Voici quelques exemples d'actions à effectuer : exécuter une fonction personnalisée ou ouvrir une 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 filtrent dynamiquement 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 Jav, la liste des suggestions filtre uniquement Java et JavaScript.

Les valeurs suggérées aident les utilisateurs à saisir des valeurs facilement compréhensibles par votre application. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir javascript et d'autres java script. Suggérer JavaScript peut 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.

object (Action)

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

Si elles ne sont pas spécifiées, les suggestions sont définies par initialSuggestions et sont traitées 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.

Compatible avec les modules complémentaires Google Workspace, mais pas avec les applications Google Chat

string

Texte qui apparaît dans le champ de saisie de texte lorsqu'il est vide. Utilisez ce texte pour inviter les utilisateurs à saisir une valeur. Exemple : Enter a number from 0 to 100.

Compatible avec les applications Google Chat, mais pas avec les modules complémentaires Google Workspace

Action

Navigation

Diffusez ou mettez à jour les cartes affichées.

Card

La pile de cartes place une carte dans la pile.

Card

La pile de cartes met à jour la première fiche avec une nouvelle carte et conserve les valeurs des champs 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 entrée suggérée dans un champ de saisie de texte. Cela correspond à ce que les utilisateurs saisissent eux-mêmes.

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

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

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 des données de formulaire.

string

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

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

enum (SelectionType)

Type d'éléments présentés aux utilisateurs dans un widget SelectionInput. Les types de sélection acceptent 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. (tableau de cases d'option ou de cases à cocher, par exemple). Jusqu'à 100 articles

object (Action)

Si elle est spécifiée, le formulaire est envoyé lorsque la sélection change. S'il n'est pas spécifié, vous devez spécifier un bouton distinct qui permet d'envoyer le formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez 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, le nombre de caractères de texte saisis par un utilisateur avant que l'application Chat ne les interroge lors de la saisie semi-automatique et affiche des suggestions d'éléments dans le menu.

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

object (Action)

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

object (PlatformDataSource)

Une source de données de Google Workspace

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

string

Texte qui identifie l'article ou qui le décrit aux utilisateurs.

string

Valeur associée à cet élément. Le client doit l'utiliser comme valeur de saisie de formulaire.

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

boolean

Indique si l'élément est sélectionné par défaut. Si le champ de sélection n'accepte qu'une seule valeur (pour les cases d'option ou les menus déroulants, par exemple), ne définissez ce champ que pour un seul élément.

string

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

string

Pour les menus à sélection multiple, une description textuelle ou un libellé à afficher sous le champ text de l'élément.

{

  // 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, par exemple les utilisateurs d'une organisation Google Workspace.

object (HostAppDataSourceMarkup)

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

{

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

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

des espaces Google Chat dont l'utilisateur est membre ;

{
  "defaultToCurrentSpace": boolean
}

boolean

Si ce paramètre est défini sur true, le menu de sélection multiple 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)
  }
}

string

Nom par lequel l'élément 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 des données de formulaire.

string

Texte qui invite les utilisateurs à saisir une date, une heure, ou une date et une heure. Par exemple, si des 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 d'une date et d'une heure.

string (int64 format)

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

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

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

integer

Nombre représentant le décalage de fuseau horaire par rapport à l'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 définie sur le fuseau horaire de l'utilisateur.

object (Action)

Déclenchement lorsque l'utilisateur clique sur Enregistrer ou Effacer dans l'interface DateTimePicker.

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

string

Texte qui s'affiche 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 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 grille. Cet identifiant est renvoyé dans les paramètres de rappel onClick de la grille parente.

object (ImageComponent)

Image qui s'affiche dans l'élément de la grille.

string

Titre de l'élément de la grille.

string

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

enum (GridItemLayout)

Mise en page à utiliser pour l'élément de la 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

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)

Couleurs à utiliser lorsque le type est BORDER_TYPE_STROKE.

integer

Rayon de l'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)

Spécifie la façon dont une colonne remplit la largeur de la fiche.

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

Tableau de widgets inclus dans une colonne. Les widgets s'affichent 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)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph.

object (Image)

Image.

object (DecoratedText)

DecoratedText.

object (ButtonList)

ButtonList.

object (TextInput)

TextInput.

object (SelectionInput)

SelectionInput.

object (DateTimePicker)

DateTimePicker.

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

string

Libellé affiché comme élément du menu d'actions.

object (OnClick)

Action onClick pour cette tâche.

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

object (Button)

Bouton principal du pied de page fixe. Le bouton doit être un bouton textuel avec du texte et des couleurs définis.

object (Button)

Bouton secondaire du pied de page fixe. Le bouton doit être un bouton textuel avec du texte et des couleurs définis. Si secondaryButton est défini, vous devez également définir primaryButton.