Card Service

Service de carte

Ce service permet aux scripts de configurer et de créer des composants de cartes et de widgets, ainsi que des comportements pour une UI. Les structures d'UI que vous créez avec ce service sont automatiquement disponibles sur les ordinateurs et les appareils mobiles. Vous n'avez donc pas besoin de développer des UI distinctes pour les deux.

Classes

NomBrève description
ActionAction qui permet l'interactivité dans les éléments d'interface utilisateur.
ActionResponseObjet de réponse qui peut être renvoyé à partir d'une fonction de rappel (par exemple, un gestionnaire de réponse de formulaire) pour effectuer une ou plusieurs actions sur le client.
ActionResponseBuilderCompilateur pour les objets ActionResponse.
ActionStatusClasse qui représente l'état d'une requête pour appeler ou envoyer une boîte de dialogue.
AttachmentReprésente une pièce jointe créée par un module complémentaire.
AuthorizationActionAction d'autorisation qui redirige l'utilisateur vers AuthorizationUrl lorsqu'il clique dessus.
AuthorizationExceptionErreur pouvant être renvoyée pour déclencher l'affichage d'une carte d'autorisation à l'utilisateur.
BorderStyleClasse qui représente un style de bordure complet pouvant être appliqué aux widgets.
BorderTypeÉnumération représentant les types de bordures pouvant être appliqués aux widgets.
ButtonClasse de base pour tous les boutons.
ButtonSetContient un ensemble d'objets Button affichés sur une même ligne.
CalendarEventActionResponseReprésente une réponse qui modifie l'événement d'agenda que l'utilisateur est en train de modifier en réaction à une action effectuée dans l'UI, comme un clic sur un bouton.
CalendarEventActionResponseBuilderCompilateur pour les objets CalendarEventActionResponse.
CardUne fiche de contexte qui représente une seule vue dans l'UI.
CardActionÉlément de menu cliquable ajouté au menu de l'en-tête de la fiche.
CardBuilderCompilateur pour les objets Card.
CardHeaderEn-tête d'un Card.
CardSectionUne section de fiche contient des groupes de widgets et les sépare visuellement.
CardServiceLe service Cardpermet de créer des cartes génériques utilisées dans différents produits d'extensibilité Google, tels que les modules complémentaires Google Workspace.
CardWithIdCompilateur pour les objets CardWithId.
CarouselLe carrousel, également appelé curseur, fait défiler et affiche une liste de widgets sous forme de diaporama, avec des boutons permettant de passer au widget précédent ou suivant.
CarouselCardCarte pouvant être affichée en tant qu'élément de carrousel.
ChatActionResponseClasse qui représente les paramètres qu'une application Chat peut utiliser pour configurer la façon dont sa réponse est publiée.
ChatClientDataSourcePour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données provenant de Google Chat.
ChatResponseObjet de réponse pour un message sous forme de fiche dans Google Chat.
ChatResponseBuilderCompilateur pour les objets ChatResponse.
ChatSpaceDataSourceSource de données qui remplit les espaces Google Chat en tant qu'éléments de sélection pour un menu à sélection multiple.
ChipUn Chip avec une icône et un libellé de texte.
ChipListContient un ensemble d'objets Chip qui sont affichés sur une ligne et qui passent à la ligne suivante pour permettre le défilement horizontal.
ChipListLayoutÉnumération qui spécifie la mise en page de ChipList.
CollapseControlContrôle de réduction et d'expansion personnalisable.
ColumnUne colonne.
ColumnsLe widget Columns affiche jusqu'à deux colonnes dans une fiche ou une boîte de dialogue.
CommonDataSourceSource de données partagée par toutes les applications Google Workspace.
CommonWidgetActionDéfinit les actions qui n'impliquent pas d'évaluations, comme la mise à jour de la visibilité des widgets.
ComposeActionResponseObjet de réponse pouvant être renvoyé par une méthode de rappel pour l'action de rédaction dans un module complémentaire Gmail.
ComposeActionResponseBuilderCompilateur pour les objets ComposeActionResponse.
ComposedEmailTypeValeur enum qui indique si l'e-mail composé est un brouillon autonome ou une réponse.
ConditionCondition utilisée pour exécuter une action d'événement dans le cadre de la validation d'une expression CEL.
ContentTypeValeur d'énumération qui spécifie le type de contenu généré par un UpdateDraftActionResponse.
DatePickerChamp de saisie permettant de saisir une date.
DateTimePickerChamp de saisie permettant aux utilisateurs de saisir une date et une heure.
DecoratedTextWidget qui affiche du texte avec des décorations facultatives.
DialogPour en savoir plus, consultez Ouvrir des boîtes de dialogue interactives dans la documentation Google Chat.
DialogActionCompilateur pour les objets DialogAction.
DisplayStyleÉnumération qui définit le style d'affichage de la fiche.
DividerSéparateur horizontal.
DriveItemsSelectedActionResponseReprésente une réponse qui modifie Drive lorsque des éléments Drive sont sélectionnés et en réaction à une action effectuée dans l'UI, comme un clic sur un bouton.
DriveItemsSelectedActionResponseBuilderCompilateur pour les objets DriveItemsSelectedActionResponse.
EditorFileScopeActionResponseApporte des modifications à un éditeur, tel que Google Docs, Sheets ou Slides, en réaction à une action effectuée dans l'UI.
EditorFileScopeActionResponseBuilderCompilateur pour les objets EditorFileScopeActionResponse.
EventActionEventAction à exécuter lorsqu'une condition de validation d'expression CEL est remplie.
ExpressionDataDonnées d'expression utilisées pour évaluer une expression
ExpressionDataActionActions pour la validation des expressions CEL .
ExpressionDataActionTypeÉnumération représentant le type de l'action de données d'expression.
ExpressionDataConditionReprésente le résultat d'une validation d'expression CEL.
ExpressionDataConditionTypeIndique si l'expression CEL a été évaluée avec succès.
FixedFooterPied de page fixe affiché en bas d'un Card.
GridGrille organisée permettant d'afficher une collection d'éléments de grille.
GridItemÉléments avec lesquels les utilisateurs interagissent dans un widget de grille.
GridItemLayoutÉnumération qui définit le style d'image et de texte d'un GridItem.
HorizontalAlignmentÉnumération qui spécifie l'alignement horizontal d'un widget.
HorizontalSizeStyleÉnumération qui définit la façon dont les widgets remplissent l'espace d'une colonne.
HostAppDataSourcePour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données provenant d'une application Google Workspace.
IconIcônes prédéfinies pouvant être utilisées dans divers objets d'interface utilisateur, tels que les widgets ImageButton ou DecoratedText.
IconImageIcône prédéfinie, icône Material Design ou icône provenant d'une URL avec un style de recadrage personnalisable.
ImageWidget affichant une seule image.
ImageButtonUn ImageButton avec une image affichée.
ImageButtonStyleÉnumération qui spécifie le style de ImageButton.
ImageComponentComposant d'image pouvant être ajouté aux éléments de grille.
ImageCropStyleClasse représentant un style de recadrage pouvant être appliqué aux composants d'image.
ImageCropTypeÉnumération représentant les styles de recadrage appliqués aux composants d'image.
ImageStyleÉnumération qui définit un style de recadrage d'image.
InputTypeÉnumération qui définit le type d'entrée du widget.
InteractionType d'énumération qui spécifie l'action à effectuer en réponse à une interaction avec un utilisateur, par exemple lorsqu'il clique sur un bouton dans un message de fiche.
KeyValueCette classe est obsolète.
LinkPreviewAction de carte qui affiche une fiche d'aperçu de lien et un chip intelligent dans l'application hôte.
LoadIndicatorType d'énumération qui spécifie le type d'indicateur de chargement ou de progression à afficher lors du traitement d'un Action.
MaterialIconObjet compatible avec toutes les icônes Google Fonts.
NavigationObjet d'assistance qui contrôle la navigation dans les cartes.
NotificationNotification affichée à l'utilisateur en réponse à une interaction avec un élément d'UI.
OnCloseÉnumération qui spécifie ce qu'il faut faire lorsqu'une URL ouverte via un OpenLink est fermée.
OpenAsÉnumération qui spécifie comment ouvrir une URL.
OpenLinkReprésente une action permettant d'ouvrir un lien avec certaines options.
OverflowMenuContient une liste d'objets OverflowMenuItem qui s'affichent dans un menu pop-up.
OverflowMenuItemUn OverflowMenuItem avec une icône et un libellé de texte.
PlatformDataSourcePour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données Google Workspace.
ResponseTypeÉnumération représentant le type de réponse de l'application Chat.
SelectionInputChamp de saisie permettant de choisir parmi un ensemble d'options prédéfinies.
SelectionInputTypeFormat des éléments que les utilisateurs peuvent sélectionner.
StatusÉnumération représentant le code d'état.
SuggestionsSuggestions de saisie semi-automatique pour compléter un widget TextInput.
SuggestionsResponseObjet de réponse pouvant être renvoyé à partir d'une fonction de rappel de suggestions.
SuggestionsResponseBuilderCompilateur pour les objets SuggestionsResponse.
SwitchÉlément d'interface utilisateur qui peut être activé ou désactivé.
SwitchControlTypeType de sélecteur de widget Switch.
TextButtonTextButton avec un libellé de texte.
TextButtonStyleÉnumération qui spécifie le style de TextButton.
TextInputWidget de champ de saisie qui accepte la saisie de texte.
TextParagraphWidget qui affiche du texte et accepte la mise en forme HTML de base.
TimePickerChamp de saisie permettant aux utilisateurs de saisir une heure.
TriggerUn déclencheur qui exécute les actions d'événement du widget Validation d'expression CEL en fonction de l'ID de règle d'action.
UniversalActionResponseObjet de réponse pouvant être renvoyé par une méthode qui crée une action universelle.
UniversalActionResponseBuilderCompilateur pour les objets UniversalActionResponse.
UpdateDraftActionResponseReprésente une action qui met à jour le brouillon d'e-mail que l'utilisateur est en train de modifier.
UpdateDraftActionResponseBuilderCompilateur pour les objets UpdateDraftActionResponse.
UpdateDraftBccRecipientsActionMet à jour les destinataires en copie cachée d'un brouillon d'e-mail.
UpdateDraftBodyActionMet à jour le corps du brouillon d'e-mail.
UpdateDraftBodyTypeValeur d'énumération qui spécifie le type d'un UpdateDraftBodyAction.
UpdateDraftCcRecipientsActionMet à jour les destinataires en copie d'un brouillon d'e-mail.
UpdateDraftSubjectActionCette action met à jour la ligne d'objet d'un brouillon d'e-mail.
UpdateDraftToRecipientsActionCette action met à jour les destinataires "À" d'un brouillon d'e-mail.
UpdateVisibilityActionMet à jour la visibilité d'un widget de carte pour l'afficher ou le masquer.
UpdatedWidgetRéponse du widget mis à jour.
ValidationObjet qui définit la règle de validation du widget auquel il est associé.
VariableButtonSizeÉnumération représentant la taille du bouton du sélecteur de variables.
VerticalAlignmentÉnumération qui définit l'alignement vertical des widgets dans une colonne.
VisibilityÉnumération représentant l'état de visibilité des widgets.
WidgetClasse de base pour tous les widgets pouvant être ajoutés à un Card.
WorkflowDataSourcePour un widget SelectionInput,DateTimePicker ou TextInput, une source de données provenant d'un flux Google Workspace.
WorkflowDataSourceTypeÉnumération représentant le type de source de données du workflow.
WrapStyleÉnumération qui définit le style d'encapsulage du contenu d'une colonne.

Action

Méthodes

MéthodeType renvoyéBrève description
addRequiredWidget(requiredWidget)ActionAjoute les noms des widgets dont cette action a besoin pour une soumission valide.
setAllWidgetsAreRequired(allWidgetsAreRequired)ActionIndique si cette action nécessite des entrées de tous les widgets.
setFunctionName(functionName)ActionDéfinit le nom de la fonction de rappel à appeler.
setInteraction(interaction)ActionDéfinit l'interaction avec un utilisateur. Cette option n'est requise que lors de l'ouverture d'une boîte de dialogue.
setLoadIndicator(loadIndicator)ActionDéfinit l'indicateur de chargement qui s'affiche pendant l'action.
setParameters(parameters)ActionPermet de transmettre des paramètres personnalisés à la fonction de rappel.
setPersistValues(persistValues)ActionIndique si les valeurs du formulaire sont déterminées par les valeurs du client ou celles du serveur après qu'une réponse d'action met à jour le Card du formulaire.

ActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

ActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()ActionResponseCrée la réponse à l'action en cours et la valide.
setNavigation(navigation)ActionResponseBuilderDéfinit la réponse à une action Navigation.
setNotification(notification)ActionResponseBuilderDéfinit la notification à afficher lorsque l'action est activée.
setOpenLink(openLink)ActionResponseBuilderDéfinit l'URL vers laquelle accéder lorsque l'action est activée.
setStateChanged(stateChanged)ActionResponseBuilderDéfinit un indicateur pour indiquer que cette action a modifié l'état des données existantes.

ActionStatus

Méthodes

MéthodeType renvoyéBrève description
setStatusCode(statusCode)ActionStatusReprésente l'état d'une requête visant à ouvrir ou à envoyer une boîte de dialogue.
setUserFacingMessage(message)ActionStatusMessage à envoyer aux utilisateurs concernant l'état de leur demande.

Attachment

Méthodes

MéthodeType renvoyéBrève description
setIconUrl(iconUrl)AttachmentDéfinit l'URL de l'icône de la pièce jointe.
setMimeType(mimeType)AttachmentDéfinit le type MIME de la pièce jointe.
setResourceUrl(resourceUrl)AttachmentDéfinit l'URL de la ressource pour la pièce jointe.
setTitle(title)AttachmentDéfinit le titre de la pièce jointe.

AuthorizationAction

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationUrl(authorizationUrl)AuthorizationActionDéfinit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation.

AuthorizationException

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.
setAuthorizationUrl(authUrl)AuthorizationExceptionDéfinit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation.
setCustomUiCallback(callback)AuthorizationExceptionNom d'une fonction à appeler pour générer une invite d'autorisation personnalisée.
setResourceDisplayName(name)AuthorizationExceptionDéfinit le nom affiché à l'utilisateur lorsque l'autorisation est demandée.
throwException()voidDéclenche la génération de cette exception.

BorderStyle

Méthodes

MéthodeType renvoyéBrève description
setCornerRadius(radius)BorderStyleDéfinit le rayon d'angle de la bordure (par exemple, 8).
setStrokeColor(color)BorderStyleDéfinit la couleur de la bordure.
setType(type)BorderStyleDéfinit le type de bordure.

BorderType

Propriétés

PropriétéTypeDescription
NO_BORDEREnumAucun style de bordure.
STROKEEnumStyle de bordure du trait.

Button

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)ButtonDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ButtonDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setOnClickAction(action)ButtonDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)ButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)ButtonDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setOverflowMenu(menu)ButtonDéfinit un menu pop-up à ouvrir lorsque l'objet est cliqué.

ButtonSet

Méthodes

MéthodeType renvoyéBrève description
addButton(button)ButtonSetAjoute un bouton.

CalendarEventActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

CalendarEventActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
addAttachments(attachments)CalendarEventActionResponseBuilderIndique que la réponse doit ajouter les pièces jointes à l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.
addAttendees(emails)CalendarEventActionResponseBuilderIndique que la réponse doit ajouter les participants indiqués à l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.
build()CalendarEventActionResponseCrée la réponse à l'action d'événement d'agenda actuelle et la valide.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderIndique que la réponse doit définir les données de conférence indiquées sur l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.

Card

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

CardAction

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)CardActionDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)CardActionDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setOnClickAction(action)CardActionDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)CardActionDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)CardActionDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setText(text)CardActionDéfinit le texte du menu pour cette action.

CardBuilder

Méthodes

MéthodeType renvoyéBrève description
addCardAction(cardAction)CardBuilderAjoute un CardAction à cette carte.
addSection(section)CardBuilderAjoute une section à cette carte.
build()CardCrée la fiche actuelle et la valide.
setDisplayStyle(displayStyle)CardBuilderDéfinit le style d'affichage de cette fiche.
setFixedFooter(fixedFooter)CardBuilderDéfinit un pied de page fixe pour cette carte.
setHeader(cardHeader)CardBuilderDéfinit l'en-tête de cette carte.
setName(name)CardBuilderDéfinit le nom de cette carte.
setPeekCardHeader(peekCardHeader)CardBuilderDéfinit l'en-tête de la carte de prévisualisation.

CardHeader

Méthodes

MéthodeType renvoyéBrève description
setImageAltText(imageAltText)CardHeaderDéfinit le texte alternatif de l'image d'en-tête.
setImageStyle(imageStyle)CardHeaderDéfinit le recadrage de l'icône dans l'en-tête de la carte.
setImageUrl(imageUrl)CardHeaderDéfinit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données.
setSubtitle(subtitle)CardHeaderDéfinit le sous-titre de l'en-tête de la carte.
setTitle(title)CardHeaderDéfinit le titre de l'en-tête de la carte.

CardSection

Méthodes

MéthodeType renvoyéBrève description
addWidget(widget)CardSectionAjoute le widget donné à cette section.
setCollapseControl(collapseControl)CardSectionDéfinit les boutons de développement et de réduction personnalisables de la section.
setCollapsible(collapsible)CardSectionIndique si la section peut être réduite.
setHeader(header)CardSectionDéfinit l'en-tête de la section.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionDéfinit le nombre de widgets qui restent affichés lorsque cette section est réduite.

CardService

Propriétés

PropriétéTypeDescription
BorderTypeBorderTypeÉnumération BorderType.
ChipListLayoutChipListLayoutÉnumération ChipListLayout.
ComposedEmailTypeComposedEmailTypeÉnumération ComposedEmailType.
ContentTypeContentTypeÉnumération ContentType.
ExpressionDataActionTypeExpressionDataActionTypeÉnumération ExpressionDataActionType.
ExpressionDataConditionTypeExpressionDataConditionTypeÉnumération ExpressionDataConditionType.
GridItemLayoutGridItemLayoutÉnumération GridItemLayout.
HorizontalAlignmentHorizontalAlignmentÉnumération HorizontalAlignment.
IconIconÉnumération Icon.
ImageButtonStyleImageButtonStyleÉnumération ImageButtonStyle.
ImageCropTypeImageCropTypeÉnumération ImageCropType.
ImageStyleImageStyleÉnumération ImageStyle.
InputTypeInputTypeÉnumération InputType.
LoadIndicatorLoadIndicatorÉnumération LoadIndicator.
OnCloseOnCloseÉnumération OnClose.
OpenAsOpenAsÉnumération OpenAs.
SelectionInputTypeSelectionInputTypeÉnumération SelectionInputType.
TextButtonStyleTextButtonStyleÉnumération TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeÉnumération UpdateDraftBodyType.
VisibilityVisibilityÉnumération Visibility.
WorkflowDataSourceTypeWorkflowDataSourceTypeÉnumération WorkflowDataSourceType.

Méthodes

MéthodeType renvoyéBrève description
newAction()Actioncrée un objet Action ;
newActionResponseBuilder()ActionResponseBuildercrée un objet ActionResponseBuilder ;
newActionStatus()ActionStatuscrée un objet ActionStatus ;
newAttachment()Attachmentcrée un objet Attachment ;
newAuthorizationAction()AuthorizationActioncrée un objet AuthorizationAction ;
newAuthorizationException()AuthorizationExceptioncrée un objet AuthorizationException ;
newBorderStyle()BorderStylecrée un objet BorderStyle ;
newButtonSet()ButtonSetcrée un objet ButtonSet ;
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuildercrée un objet CalendarEventActionResponseBuilder ;
newCardAction()CardActioncrée un objet CardAction ;
newCardBuilder()CardBuilderCrée un générateur de cartes.
newCardHeader()CardHeadercrée un objet CardHeader ;
newCardSection()CardSectioncrée un objet CardSection ;
newCardWithId()CardWithIdcrée un objet CardWithId ;
newCarousel()CarouselCrée un objet Carousel.
newCarouselCard()CarouselCardcrée un objet CarouselCard ;
newChatActionResponse()ChatActionResponsecrée un objet ChatActionResponse ;
newChatResponseBuilder()ChatResponseBuildercrée un objet ChatResponseBuilder ;
newChip()Chipcrée un objet Chip ;
newChipList()ChipListcrée un objet ChipList ;
newCollapseControl()CollapseControlcrée un objet CollapseControl ;
newColumn()Columncrée un objet Column ;
newColumns()ColumnsCrée un ensemble de Columns.
newComposeActionResponseBuilder()ComposeActionResponseBuildercrée un objet ComposeActionResponseBuilder ;
newDatePicker()DatePickercrée un objet DatePicker ;
newDateTimePicker()DateTimePickercrée un objet DateTimePicker ;
newDecoratedText()DecoratedTextcrée un objet DecoratedText ;
newDialog()Dialogcrée un objet Dialog ;
newDialogAction()DialogActioncrée un objet DialogAction ;
newDivider()Dividercrée un objet Divider ;
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuildercrée un objet DriveItemsSelectedActionResponseBuilder ;
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuildercrée un objet EditorFileScopeActionResponseBuilder ;
newFixedFooter()FixedFootercrée un objet FixedFooter ;
newGrid()Gridcrée un objet Grid ;
newGridItem()GridItemcrée un objet GridItem ;
newHostAppDataSource()HostAppDataSourceCrée un HostAppDataSource et renvoie un HostAppDataSource vide.
newIconImage()IconImagecrée un objet IconImage ;
newImage()Imagecrée un objet Image ;
newImageButton()ImageButtoncrée un objet ImageButton ;
newImageComponent()ImageComponentcrée un objet ImageComponent ;
newImageCropStyle()ImageCropStylecrée un objet ImageCropStyle ;
newKeyValue()KeyValuecrée un objet KeyValue ;
newLinkPreview()LinkPreviewcrée un objet LinkPreview ;
newMaterialIcon()MaterialIconcrée un objet MaterialIcon ;
newNavigation()Navigationcrée un objet Navigation ;
newNotification()Notificationcrée un objet Notification ;
newOpenLink()OpenLinkcrée un objet OpenLink ;
newOverflowMenu()OverflowMenucrée un objet OverflowMenu ;
newOverflowMenuItem()OverflowMenuItemcrée un objet OverflowMenuItem ;
newSelectionInput()SelectionInputcrée un objet SelectionInput ;
newSuggestions()Suggestionscrée un objet Suggestions ;
newSuggestionsResponseBuilder()SuggestionsResponseBuildercrée un objet SuggestionsResponseBuilder ;
newSwitch()Switchcrée un objet Switch ;
newTextButton()TextButtoncrée un objet TextButton ;
newTextInput()TextInputcrée un objet TextInput ;
newTextParagraph()TextParagraphcrée un objet TextParagraph ;
newTimePicker()TimePickercrée un objet TimePicker ;
newUniversalActionResponseBuilder()UniversalActionResponseBuildercrée un objet UniversalActionResponseBuilder ;
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuildercrée un objet UpdateDraftActionResponseBuilder ;
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActioncrée un objet UpdateDraftBccRecipientsAction ;
newUpdateDraftBodyAction()UpdateDraftBodyActioncrée un objet UpdateDraftBodyAction ;
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActioncrée un objet UpdateDraftCcRecipientsAction ;
newUpdateDraftSubjectAction()UpdateDraftSubjectActioncrée un objet UpdateDraftSubjectAction ;
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActioncrée un objet UpdateDraftToRecipientsAction ;
newValidation()Validationcrée un objet Validation ;

CardWithId

Méthodes

MéthodeType renvoyéBrève description
setCard(card)CardWithIdDéfinit la carte de cardWithId.
setCardId(id)CardWithIdDéfinit l'identifiant unique de la carte cardWithId.

Méthodes

MéthodeType renvoyéBrève description
addCarouselCard(card)CarouselAjoute une carte de carrousel.

CarouselCard

Méthodes

MéthodeType renvoyéBrève description
addFooterWidget(widget)CarouselCardAjoute le widget donné au pied de page de cette fiche de carrousel.
addWidget(widget)CarouselCardAjoute le widget donné à cette fiche de carrousel.

ChatActionResponse

Méthodes

MéthodeType renvoyéBrève description
setDialogAction(dialogAction)ChatActionResponseDéfinit l'action de boîte de dialogue sur un événement lié à une boîte de dialogue.
setResponseType(responseType)ChatActionResponseType de réponse de l'application Chat.
setUpdatedWidget(updatedWidget)ChatActionResponseDéfinit le widget mis à jour, utilisé pour fournir des options de saisie semi-automatique pour un widget.
setUrl(url)ChatActionResponseURL permettant aux utilisateurs de s'authentifier ou de configurer leur compte.

ChatClientDataSource

Méthodes

MéthodeType renvoyéBrève description
setSpaceDataSource(spaceDataSource)ChatClientDataSourceSource de données qui remplit les espaces Google Chat en tant qu'éléments de sélection pour un menu à sélection multiple.

ChatResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

ChatResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
addCardsV2(cardWithId)ChatResponseBuilderDéfinit le champ de carte du message.
build()ChatResponseCrée la réponse à l'action en cours et la valide.
setActionResponse(actionResponse)ChatResponseBuilderDéfinit le champ de réponse de l'action du message.
setText(text)ChatResponseBuilderDéfinit le texte du message Chat.

ChatSpaceDataSource

Méthodes

MéthodeType renvoyéBrève description
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourceSi la valeur est définie sur true, le menu à sélection multiple sélectionne l'espace Google Chat actuel comme élément par défaut.

Chip

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ChipDéfinit le texte alternatif du chip pour l'accessibilité.
setAuthorizationAction(action)ChipDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ChipDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setDisabled(disabled)ChipIndique si le chip est désactivé.
setIcon(icon)ChipDéfinit l'icône à utiliser comme chip.
setLabel(label)ChipDéfinit le titre du chip.
setOnClickAction(action)ChipDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)ChipDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)ChipDéfinit une URL à ouvrir lorsque l'objet est cliqué.

ChipList

Méthodes

MéthodeType renvoyéBrève description
addChip(chip)ChipListAjoute un chip.
setLayout(layout)ChipListDéfinit la mise en page de la liste de chips.

ChipListLayout

Propriétés

PropriétéTypeDescription
WRAPPEDEnumLa liste de chips passe à la ligne suivante si l'espace horizontal est insuffisant.
HORIZONTAL_SCROLLABLEEnumLes chips défilent horizontalement s'ils ne tiennent pas dans l'espace disponible.

CollapseControl

Méthodes

MéthodeType renvoyéBrève description
setCollapseButton(button)CollapseControlDéfinit le Button qui s'affiche pour le bouton "Afficher moins".
setExpandButton(button)CollapseControlDéfinit le Button qui s'affiche pour le bouton "Afficher plus".
setHorizontalAlign(horizontalAlignment)CollapseControlDéfinit le HorizontalAlignment de CollapseControl.

Column

Columns

Méthodes

MéthodeType renvoyéBrève description
addColumn(column)ColumnsAjoute un Column au widget "Colonnes".
setWrapStyle(wrapStyle)ColumnsDéfinit le style d'habillage des colonnes et contrôle la façon dont la colonne est redimensionnée en fonction de la largeur de l'écran.

CommonDataSource

Propriétés

PropriétéTypeDescription
UNKNOWNEnumValeur par défaut.
USEREnumUtilisateurs Google Workspace.

CommonWidgetAction

Méthodes

MéthodeType renvoyéBrève description
setUpdateVisibilityAction(updateVisibilityAction)CommonWidgetActionDéfinit l'action de visibilité de la mise à jour pour les widgets.

ComposeActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

ComposeActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()ComposeActionResponseCrée la réponse de l'action de composition actuelle et la valide.
setGmailDraft(draft)ComposeActionResponseBuilderDéfinit le brouillon GmailMessage créé à l'aide de GmailMessage.createDraftReply(body) ou de fonctions similaires.

ComposedEmailType

Propriétés

PropriétéTypeDescription
REPLY_AS_DRAFTEnumBrouillon qui est une réponse à un autre message.
STANDALONE_DRAFTEnumBrouillon qui est un message autonome.

Condition

Méthodes

MéthodeType renvoyéBrève description
setActionRuleId(actionRuleId)ConditionID unique de la règle d'action à exécuter en réponse à la condition.
setExpressionDataCondition(expressionDataCondition)ConditionDéfinit la condition de validation de l'expression CEL utilisée pour déterminer si l'action d'événement doit s'exécuter.

ContentType

Propriétés

PropriétéTypeDescription
TEXTEnumIndique que le contenu généré est en texte brut.
MUTABLE_HTMLEnumIndique que le contenu généré est au format HTML.
IMMUTABLE_HTMLEnumIndique que le contenu généré est au format HTML, mais qu'il ne peut pas être modifié après sa génération.

DatePicker

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)DatePickerDéfinit le nom du champ qui identifie ce sélecteur dans l'objet d'événement généré en cas d'interaction avec l'UI.
setOnChangeAction(action)DatePickerDéfinit un Action que le script exécute chaque fois que l'entrée du sélecteur change.
setTitle(title)DatePickerDéfinit le titre affiché au-dessus du champ de saisie.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDéfinit la valeur préremplie à définir dans le champ de saisie.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDéfinit la valeur préremplie à définir dans le champ de saisie.

DateTimePicker

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)DateTimePickerDéfinit le nom du champ qui identifie ce sélecteur dans l'objet d'événement généré en cas d'interaction avec l'UI.
setHostAppDataSource(hostAppDataSource)DateTimePickerDans un flux Google Workspace, les variables d'entrée acceptent les sorties de date et heure des autres étapes du flux.
setOnChangeAction(action)DateTimePickerDéfinit un Action que le script exécute chaque fois que l'entrée du sélecteur change.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerDéfinit le nombre de minutes de décalage du fuseau horaire par rapport à l'heure UTC.
setTitle(title)DateTimePickerDéfinit le titre affiché au-dessus du champ de saisie.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDéfinit la valeur préremplie à définir dans le champ de saisie.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDéfinit la valeur préremplie à définir dans le champ de saisie.

DecoratedText

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)DecoratedTextDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setBottomLabel(text)DecoratedTextDéfinit le texte du libellé à utiliser comme clé et l'affiche sous le contenu textuel.
setButton(button)DecoratedTextDéfinit le Button qui s'affiche à droite du texte.
setComposeAction(action, composedEmailType)DecoratedTextDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setEndIcon(endIcon)DecoratedTextDéfinit le IconImage facultatif qui s'affiche à droite du contenu.
setOnClickAction(action)DecoratedTextDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)DecoratedTextDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)DecoratedTextDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setStartIcon(startIcon)DecoratedTextDéfinit le IconImage facultatif à afficher avant le contenu textuel.
setSwitchControl(switchToSet)DecoratedTextDéfinit le Switch qui s'affiche à droite du contenu.
setText(text)DecoratedTextDéfinit le texte à utiliser comme valeur.
setTopLabel(text)DecoratedTextDéfinit le texte du libellé à utiliser comme clé et qui s'affiche au-dessus du contenu textuel.
setWrapText(wrapText)DecoratedTextIndique si le texte de la valeur doit être affiché sur une ou plusieurs lignes.

Dialog

Méthodes

MéthodeType renvoyéBrève description
setBody(card)DialogDéfinit la carte de Dialog.

DialogAction

Méthodes

MéthodeType renvoyéBrève description
setActionStatus(actionStatus)DialogActionDéfinit l'état de l'action de DialogAction.
setDialog(dialog)DialogActionDéfinit la boîte de dialogue de DialogAction.

DisplayStyle

Propriétés

PropriétéTypeDescription
PEEKEnumAffichez l'en-tête de la fiche en bas du contenu du module complémentaire, au-dessus du contenu existant.
REPLACEEnumAffichez la fiche en remplaçant le contenu existant.

Divider

DriveItemsSelectedActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

DriveItemsSelectedActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()DriveItemsSelectedActionResponseCrée la réponse de l'action Drive actuelle.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderSpécifie que la réponse demande l'accès au champ d'application du fichier pour l'élément contextuel pertinent dans Drive.

EditorFileScopeActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

EditorFileScopeActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()EditorFileScopeActionResponseCrée la réponse de l'action de l'éditeur actuel.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderDemande le champ d'application drive.file pour le document Editor actif actuel.

EventAction

Méthodes

MéthodeType renvoyéBrève description
addPostEventTrigger(trigger)EventActionAjoute une condition de validation d'expression CEL à évaluer après l'exécution de l'action d'événement.
setActionRuleId(actionRuleId)EventActionDéfinit un identifiant unique pour l'action d'événement.
setCommonWidgetAction(commonWidgetAction)EventActionDéfinissez l'action de widget courante pour les widgets.
setExpressionDataAction(expressionDataAction)EventActionDéfinit l'action de données validation de l'expression CEL pour les widgets.

ExpressionData

Méthodes

MéthodeType renvoyéBrève description
addCondition(condition)ExpressionDataAjoute une condition aux données d'expression actuelles.
addEventAction(eventAction)ExpressionDataAjoute une action d'événement aux données d'expression actuelles.
setExpression(expression)ExpressionDataDéfinit la valeur des données d'expression.
setId(id)ExpressionDataDéfinit l'ID des données d'expression.

ExpressionDataAction

Méthodes

MéthodeType renvoyéBrève description
setActionType(type)ExpressionDataActionDéfinit le type de l'action de données d'expression.

ExpressionDataActionType

Propriétés

PropriétéTypeDescription
ACTION_TYPE_UNSPECIFIEDEnumType d'action non spécifié.
START_EXPRESSION_EVALUATIONEnumAction permettant de lancer la validation des expressions CEL.

ExpressionDataCondition

Méthodes

MéthodeType renvoyéBrève description
setConditionType(type)ExpressionDataConditionDéfinit le type de condition pour une validation d'expression CEL afin d'indiquer si l'expression a été évaluée avec succès.

ExpressionDataConditionType

Propriétés

PropriétéTypeDescription
CONDITION_TYPE_UNSPECIFIEDEnumType de condition non spécifié.
EXPRESSION_EVALUATION_SUCCESSEnumL'expression CEL a renvoyé un résultat positif.
EXPRESSION_EVALUATION_FAILUREEnumL'expression CEL a renvoyé un résultat d'échec.

FixedFooter

Méthodes

MéthodeType renvoyéBrève description
setPrimaryButton(button)FixedFooterDéfinissez le bouton principal dans le pied de page fixe.
setSecondaryButton(button)FixedFooterDéfinissez le bouton secondaire dans le pied de page fixe.

Grid

Méthodes

MéthodeType renvoyéBrève description
addItem(gridItem)GridAjoute un élément de grille à la grille.
setAuthorizationAction(action)GridDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setBorderStyle(borderStyle)GridDéfinit le style de bordure appliqué à chaque élément de la grille.
setComposeAction(action, composedEmailType)GridDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setNumColumns(numColumns)GridNombre de colonnes à afficher dans la grille.
setOnClickAction(action)GridDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)GridDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)GridDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setTitle(title)GridDéfinit le texte du titre de la grille.

GridItem

Méthodes

MéthodeType renvoyéBrève description
setIdentifier(id)GridItemDéfinit l'identifiant de l'élément de grille.
setImage(image)GridItemDéfinit l'image de cet élément de grille.
setLayout(layout)GridItemDéfinit la mise en page du texte et de l'image pour l'élément de grille.
setSubtitle(subtitle)GridItemDéfinit le sous-titre de l'élément de grille.
setTextAlignment(alignment)GridItemDéfinit l'alignement horizontal de l'élément de grille.
setTitle(title)GridItemDéfinit le texte du titre de l'élément de grille.

GridItemLayout

Propriétés

PropriétéTypeDescription
TEXT_BELOWEnumLe titre et le sous-titre s'affichent sous l'image de l'élément de grille.
TEXT_ABOVEEnumLe titre et le sous-titre s'affichent au-dessus de l'image de l'élément de grille.

HorizontalAlignment

Propriétés

PropriétéTypeDescription
STARTEnumAlignez le widget sur le début de la phrase.
CENTEREnumAlignez le widget au centre.
ENDEnumAlignez le widget sur la fin de la phrase.

HorizontalSizeStyle

Propriétés

PropriétéTypeDescription
FILL_AVAILABLE_SPACEEnumDimensionne Widget pour remplir l'espace horizontal disponible d'un Column.
FILL_MINIMUM_SPACEEnumRedimensionne Widget pour qu'il occupe le moins d'espace horizontal possible dans un Column.

HostAppDataSource

Méthodes

MéthodeType renvoyéBrève description
setChatDataSource(chatClientDataSource)HostAppDataSourceDéfinit la source de données à partir de Google Chat.
setWorkflowDataSource(workflowDataSource)HostAppDataSourceDéfinit la source de données à partir de Google Workspace Flows.

Icon

Propriétés

PropriétéTypeDescription
NONEEnumAucune icône.
AIRPLANEEnumIcône d'un vol en avion
BOOKMARKEnumIcône de favori
BUSEnumIcône de bus
CAREnumIcône de voiture
CLOCKEnumIcône représentant une horloge
CONFIRMATION_NUMBER_ICONEnumIcône du numéro de confirmation
DOLLAREnumIcône Dollar
DESCRIPTIONEnumIcône Description
EMAILEnumIcône de messagerie
EVENT_PERFORMEREnumIcône de messagerie
EVENT_SEATEnumIcône de place pour un événement
FLIGHT_ARRIVALEnumIcône d'arrivée du vol
FLIGHT_DEPARTUREEnumIcône de départ du vol
HOTELEnumIcône d'hôtel
HOTEL_ROOM_TYPEEnumIcône d'hôtel
INVITEEnumIcône Inviter
MAP_PINEnumIcône de repère sur la carte
MEMBERSHIPEnumIcône Abonnement
MULTIPLE_PEOPLEEnumIcône représentant plusieurs personnes
OFFEREnumIcône d'offre
PERSONEnumIcône représentant une personne
PHONEEnumIcône de téléphone
RESTAURANT_ICONEnumIcône de restaurant
SHOPPING_CARTEnumIcône Panier d'achat
STAREnumIcône de favoris
STOREEnumIcône du magasin
TICKETEnumIcône de billet
TRAINEnumIcône du train
VIDEO_CAMERAEnumIcône de caméra
VIDEO_PLAYEnumIcône Lecture de vidéo

IconImage

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)IconImageDéfinit le texte alternatif de l'URL utilisé pour l'accessibilité.
setIcon(icon)IconImageDéfinit l'icône prédéfinie si l'URL n'est pas définie.
setIconUrl(url)IconImageDéfinit l'URL de l'icône si elle n'est pas définie.
setImageCropType(imageCropType)IconImageDéfinit le style de recadrage de l'image.
setMaterialIcon(icon)IconImageDéfinit l'icône Material Design.

Image

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ImageDéfinit le texte alternatif de l'image pour l'accessibilité.
setAuthorizationAction(action)ImageDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ImageDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setImageUrl(url)ImageDéfinit l'image à utiliser en fournissant son URL ou sa chaîne de données.
setOnClickAction(action)ImageDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)ImageDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)ImageDéfinit une URL à ouvrir lorsque l'objet est cliqué.

ImageButton

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ImageButtonDéfinit le texte alternatif du bouton pour l'accessibilité.
setAuthorizationAction(action)ImageButtonDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ImageButtonDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setIcon(icon)ImageButtonDéfinit un Icon prédéfini à afficher sur le bouton.
setIconUrl(url)ImageButtonDéfinit l'URL d'une image à utiliser comme icône de ce bouton.
setImageButtonStyle(imageButtonStyle)ImageButtonDéfinit le style du bouton.
setMaterialIcon(icon)ImageButtonDéfinit l'icône Material Design.
setOnClickAction(action)ImageButtonDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)ImageButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)ImageButtonDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setOverflowMenu(menu)ImageButtonDéfinit un menu pop-up à ouvrir lorsque l'objet est cliqué.

ImageButtonStyle

Propriétés

PropriétéTypeDescription
BORDERLESSEnumBouton d'image sans bordure.
OUTLINEDEnumBouton image avec un arrière-plan transparent.
FILLEDEnumBouton image avec un arrière-plan coloré.
FILLED_TONALEnumBouton d'image avec une alternative intermédiaire entre les boutons pleins et les boutons avec contour.

ImageComponent

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ImageComponentDéfinit le texte alternatif de l'image.
setBorderStyle(borderStyle)ImageComponentDéfinit le style de bordure appliqué à l'image.
setCropStyle(imageCropStyle)ImageComponentDéfinit le style de recadrage de l'image.
setImageUrl(url)ImageComponentDéfinit l'URL de l'image.

ImageCropStyle

Méthodes

MéthodeType renvoyéBrève description
setAspectRatio(ratio)ImageCropStyleDéfinit le format à utiliser si le type de recadrage est RECTANGLE_CUSTOM.
setImageCropType(type)ImageCropStyleDéfinit le type de recadrage de l'image.

ImageCropType

Propriétés

PropriétéTypeDescription
SQUAREEnumStyle de recadrage carré.
CIRCLEEnumStyle de recadrage en forme de cercle.
RECTANGLE_CUSTOMEnumStyle de recadrage rectangulaire avec un format personnalisé.
RECTANGLE_4_3EnumStyle de recadrage rectangulaire au format 4:3.

ImageStyle

Propriétés

PropriétéTypeDescription
SQUAREEnumPas de recadrage.
CIRCLEEnumRecadrez l'image en forme de cercle.

InputType

Propriétés

PropriétéTypeDescription
TEXTEnumAcceptez le texte normal.
INTEGEREnumAccepte un nombre entier.
FLOATEnumAcceptez un nombre à virgule flottante.
EMAILEnumAccepter une adresse e-mail

Interaction

Propriétés

PropriétéTypeDescription
INTERACTION_UNSPECIFIEDEnumValeur par défaut.
OPEN_DIALOGEnumOuvre une boîte de dialogue, une interface basée sur des fiches que les applications Chat utilisent pour interagir avec les utilisateurs.

KeyValue

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)KeyValueDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)KeyValueDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setOnClickAction(action)KeyValueDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)KeyValueDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)KeyValueDéfinit une URL à ouvrir lorsque l'objet est cliqué.

LinkPreview

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.
setLinkPreviewTitle(title)LinkPreviewDéfinit le titre qui s'affiche dans l'aperçu du lien au-dessus de la fiche d'aperçu.
setPreviewCard(previewCard)LinkPreviewDéfinit la fiche qui affiche des informations sur un lien provenant d'un service tiers ou non Google.
setTitle(title)LinkPreviewDéfinit le titre qui s'affiche dans l'icône intelligente pour l'aperçu du lien.

LoadIndicator

Propriétés

PropriétéTypeDescription
SPINNEREnumUtilisez un indicateur de rotation.
NONEEnumN'utilisez pas d'indicateur.

MaterialIcon

Méthodes

MéthodeType renvoyéBrève description
setFill(fill)MaterialIconIndique si l'icône s'affiche comme remplie.
setGrade(grade)MaterialIconL'épaisseur et le niveau ont une incidence sur l'épaisseur d'un symbole.
setName(name)MaterialIconDéfinit le nom de l'icône.
setWeight(weight)MaterialIconÉpaisseur du trait de l'icône.

Méthodes

MéthodeType renvoyéBrève description
popCard()NavigationSupprime une carte de la pile de navigation.
popToNamedCard(cardName)NavigationAffiche la fiche spécifiée par son nom.
popToRoot()NavigationFait passer la pile de cartes à la carte racine.
printJson()StringAffiche la représentation JSON de cet objet.
pushCard(card)NavigationTransfère la carte donnée sur la pile.
updateCard(card)NavigationRemplace la carte actuelle.

Notification

Méthodes

MéthodeType renvoyéBrève description
setText(text)NotificationDéfinit le texte à afficher dans la notification.

OnClose

Propriétés

PropriétéTypeDescription
NOTHINGEnumNe rien faire à la fermeture.
RELOADEnumRecharge le module complémentaire lorsque la fenêtre se ferme.

OpenAs

Propriétés

PropriétéTypeDescription
FULL_SIZEEnumOuvrez-le en plein écran ou dans un onglet.
OVERLAYEnumOuvrez-le sous forme de superposition, comme un pop-up.

Méthodes

MéthodeType renvoyéBrève description
setOnClose(onClose)OpenLinkDéfinit le comportement de l'action d'URL lorsque la fenêtre ou l'onglet de l'URL sont fermés.
setOpenAs(openAs)OpenLinkDéfinit le comportement de l'URL lorsqu'elle est ouverte.
setUrl(url)OpenLinkDéfinit l'URL à ouvrir.

OverflowMenu

Méthodes

MéthodeType renvoyéBrève description
addMenuItem(menuItem)OverflowMenuAjoute un élément de menu.

OverflowMenuItem

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)OverflowMenuItemDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)OverflowMenuItemDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setDisabled(disabled)OverflowMenuItemDétermine si l'élément de menu est désactivé.
setOnClickAction(action)OverflowMenuItemDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)OverflowMenuItemDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)OverflowMenuItemDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setStartIcon(icon)OverflowMenuItemDéfinit l'icône de début de l'élément de menu.
setText(text)OverflowMenuItemDéfinit le titre de l'élément de menu.

PlatformDataSource

Méthodes

MéthodeType renvoyéBrève description
setCommonDataSource(commonDataSource)PlatformDataSourceDéfinit la source de données à partir de Google Workspace.
setHostAppDataSource(hostAppDataSource)PlatformDataSourcePermet de remplir les espaces dans le menu à sélection multiple.

ResponseType

Propriétés

PropriétéTypeDescription
TYPE_UNSPECIFIEDEnumType par défaut géré en tant que NEW_MESSAGE.
NEW_MESSAGEEnumPublier un nouveau message dans le sujet
UPDATE_MESSAGEEnumModifiez le message de l'application Chat.
UPDATE_USER_MESSAGE_CARDSEnumMettez à jour les fiches du message d'un utilisateur.
REQUEST_CONFIGEnumDemandez à l'utilisateur de manière privée de fournir une authentification ou une configuration supplémentaire.
DIALOGEnumAffiche une boîte de dialogue.
UPDATE_WIDGETEnumRequête des options de saisie semi-automatique du texte du widget.

SelectionInput

Méthodes

MéthodeType renvoyéBrève description
addItem(text, value, selected)SelectionInputAjoute un nouvel élément pouvant être sélectionné.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputAjoute un nouvel élément pouvant être sélectionné pour les menus à sélection multiple.
setExternalDataSource(action)SelectionInputDéfinit une source de données externe, telle qu'une base de données relationnelle.
setFieldName(fieldName)SelectionInputDéfinit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré lors d'une interaction avec l'UI.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputDéfinit le nombre maximal d'éléments qu'un utilisateur peut sélectionner.
setMultiSelectMinQueryLength(queryLength)SelectionInputDéfinit le nombre de caractères de texte qu'un utilisateur saisit avant que l'application interroge la saisie semi-automatique et affiche les éléments suggérés sur la fiche.
setOnChangeAction(action)SelectionInputDéfinit une Action à exécuter chaque fois que l'entrée de sélection change.
setPlatformDataSource(platformDataSource)SelectionInputDéfinit une source de données à partir de Google Workspace.
setTitle(title)SelectionInputDéfinit le titre à afficher avant le champ de saisie.
setType(type)SelectionInputDéfinit le type de cette entrée.

SelectionInputType

Propriétés

PropriétéTypeDescription
CHECK_BOXEnumStyle de saisie de la case à cocher.
RADIO_BUTTONEnumStyle de saisie de la case d'option.
DROPDOWNEnumStyle d'entrée de sélection du menu déroulant.
SWITCHEnumUn ensemble de commutateurs.
MULTI_SELECTEnumMenu à sélection multiple pour les données statiques ou dynamiques.
OVERFLOW_MENUEnumÉlément d'interface utilisateur qui contient des options supplémentaires qui ne tiennent pas dans l'interface principale.

Status

Propriétés

PropriétéTypeDescription
OKEnumMise en correspondance HTTP : 200 OK
CANCELLEDEnumMise en correspondance HTTP : 499 Le client a fermé la requête
UNKNOWNEnumErreur inconnue.
INVALID_ARGUMENTEnumLe client a spécifié un argument non valide.
DEADLINE_EXCEEDEDEnumMappage HTTP : 504 Passerelle hors délai
NOT_FOUNDEnumMise en correspondance HTTP : 404 Page introuvable
ALREADY_EXISTSEnumL'entité qu'un client a essayé de créer existe déjà.
PERMISSION_DENIEDEnumMise en correspondance HTTP : 403 Accès interdit
UNAUTHENTICATEDEnumMise en correspondance HTTP : 401 Accès non autorisé
RESOURCE_EXHAUSTEDEnumMise en correspondance HTTP : 429 Requêtes trop nombreuses
FAILED_PRECONDITIONEnumL'opération a été rejetée car le système n'est pas dans un état requis pour exécuter l'opération.
ABORTEDEnumL'opération a été abandonnée, généralement en raison d'un problème de simultanéité, tel qu'un échec de vérification du séquenceur ou un abandon de transaction.
OUT_OF_RANGEEnumL'opération a été tentée au-delà de la plage valide.
UNIMPLEMENTEDEnumMise en correspondance HTTP : 501 Non implémenté
INTERNALEnumErreurs internes.
UNAVAILABLEEnumMise en correspondance HTTP : 503 Service non disponible
DATA_LOSSEnumPerte ou corruption de données irrécupérable.

Suggestions

Méthodes

MéthodeType renvoyéBrève description
addSuggestion(suggestion)SuggestionsAjoutez une suggestion de texte.
addSuggestions(suggestions)SuggestionsAjoutez une liste de suggestions de texte.

SuggestionsResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

SuggestionsResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()SuggestionsResponseCrée la réponse aux suggestions actuelles et la valide.
setSuggestions(suggestions)SuggestionsResponseBuilderDéfinit les suggestions utilisées dans la saisie semi-automatique dans les champs de texte.

Switch

Méthodes

MéthodeType renvoyéBrève description
setControlType(controlType)SwitchDéfinit le type de sélecteur du bouton bascule.
setFieldName(fieldName)SwitchDéfinit la clé qui identifie ce commutateur dans l'objet d'événement généré en cas d'interaction avec l'UI.
setOnChangeAction(action)SwitchDéfinit l'action à effectuer lorsque le commutateur est activé ou désactivé.
setSelected(selected)SwitchIndique si ce bouton bascule doit être sélectionné ou non au démarrage.
setValue(value)SwitchDéfinit la valeur qui est envoyée en tant qu'entrée de formulaire lorsque ce bouton est activé.

SwitchControlType

Propriétés

PropriétéTypeDescription
SWITCHEnumContrôle de style bascule pour un widget de commutateur.
CHECK_BOXEnumContrôle de style case à cocher pour un widget de bouton bascule.

TextButton

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)TextButtonDéfinit le texte alternatif du bouton pour l'accessibilité.
setAuthorizationAction(action)TextButtonDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setBackgroundColor(backgroundColor)TextButtonDéfinit la couleur d'arrière-plan du bouton TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setDisabled(disabled)TextButtonIndique si le bouton est désactivé.
setIcon(icon)TextButtonDéfinit un Icon prédéfini à afficher sur le bouton.
setIconUrl(url)TextButtonDéfinit l'URL d'une image à utiliser comme icône de ce bouton.
setMaterialIcon(icon)TextButtonDéfinit l'icône Material Design.
setOnClickAction(action)TextButtonDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)TextButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)TextButtonDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setOverflowMenu(menu)TextButtonDéfinit un menu pop-up à ouvrir lorsque l'objet est cliqué.
setText(text)TextButtonDéfinit le texte qui s'affiche sur le bouton.
setTextButtonStyle(textButtonStyle)TextButtonDéfinit le style du bouton.

TextButtonStyle

Propriétés

PropriétéTypeDescription
OUTLINEDEnumBouton avec texte normal et arrière-plan transparent.
TEXTEnumNE PAS UTILISER.
FILLEDEnumBouton de texte avec un arrière-plan coloré.
FILLED_TONALEnumBouton de texte normal avec une alternative intermédiaire entre les boutons pleins et ceux avec un contour.
BORDERLESSEnumBouton de texte normal sans bordure.

TextInput

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)TextInputDéfinit la clé qui identifie cette entrée de texte dans l'objet événement généré lors d'une interaction avec l'UI.
setHint(hint)TextInputDéfinit un indice pour la saisie de texte.
setHostAppDataSource(hostAppDataSource)TextInputDéfinit une source de données à partir des applications Google Workspace.
setMultiline(multiline)TextInputIndique si le texte saisi s'affiche sur une ou plusieurs lignes.
setOnChangeAction(action)TextInputDéfinit une action à effectuer chaque fois que le texte saisi change.
setSuggestions(suggestions)TextInputDéfinit les suggestions de saisie semi-automatique dans le champ de texte.
setSuggestionsAction(suggestionsAction)TextInputDéfinit l'action de rappel pour récupérer les suggestions en fonction de la saisie de l'utilisateur pour la saisie semi-automatique.
setTitle(title)TextInputDéfinit le titre à afficher au-dessus du champ de saisie.
setValidation(validation)TextInputDéfinit la règle de validation pour ce widget.
setValue(value)TextInputDéfinit la valeur préremplie à définir dans le champ de saisie.

TextParagraph

Méthodes

MéthodeType renvoyéBrève description
setMaxLines(maxLines)TextParagraphDéfinit le nombre maximal de lignes de texte affichées dans le widget.
setText(text)TextParagraphDéfinit le texte du paragraphe.

TimePicker

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)TimePickerDéfinit le nom du champ qui identifie ce sélecteur dans l'objet d'événement généré en cas d'interaction avec l'UI.
setHours(hours)TimePickerDéfinit la valeur des heures préremplies à définir dans le champ de saisie.
setMinutes(minutes)TimePickerDéfinit la valeur en minutes préremplie dans le champ de saisie.
setOnChangeAction(action)TimePickerDéfinit un Action que le script exécute chaque fois que l'entrée du sélecteur change.
setTitle(title)TimePickerDéfinit le titre affiché au-dessus du champ de saisie.

Trigger

Méthodes

MéthodeType renvoyéBrève description
setActionRuleId(actionRuleId)TriggerDéfinit l'ID de la règle d'action pour le déclencheur.

UniversalActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

UniversalActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()UniversalActionResponseCrée la réponse d'action universelle actuelle et la valide.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderAffiche le module complémentaire avec les fiches spécifiées.
setOpenLink(openLink)UniversalActionResponseBuilderDéfinit l'URL à ouvrir lorsque l'action universelle est sélectionnée.

UpdateDraftActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

UpdateDraftActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()UpdateDraftActionResponseCrée la réponse à l'action de mise à jour actuelle et la valide.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires en copie cachée d'un brouillon d'e-mail.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDéfinissez une action qui met à jour le corps d'un brouillon d'e-mail.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires en copie conforme d'un brouillon.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour la ligne d'objet d'un brouillon.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires "À" d'un brouillon.

UpdateDraftBccRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionMet à jour les destinataires en copie cachée d'un brouillon d'e-mail.

UpdateDraftBodyAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateContent(content, contentType)UpdateDraftBodyActionAjoute le contenu spécifié au corps du brouillon.
setUpdateType(updateType)UpdateDraftBodyActionDéfinit le UpdateDraftBodyType de cette action de mise à jour sur le corps du brouillon.

UpdateDraftBodyType

Propriétés

PropriétéTypeDescription
IN_PLACE_INSERTEnumPar défaut.
INSERT_AT_STARTEnumLes actions de mise à jour insèrent du contenu au début du corps du message.
INSERT_AT_ENDEnumLes actions de mise à jour insèrent du contenu à la fin du corps du message.

UpdateDraftCcRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionMet à jour les destinataires en copie d'un brouillon d'e-mail.

UpdateDraftSubjectAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateSubject(subject)UpdateDraftSubjectActionCette action met à jour la ligne d'objet d'un brouillon d'e-mail.

UpdateDraftToRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionCette action met à jour les destinataires "À" d'un brouillon d'e-mail.

UpdateVisibilityAction

Méthodes

MéthodeType renvoyéBrève description
setVisibility(visibility)UpdateVisibilityActionDéfinit la visibilité des widgets sur "visible" ou "masqué".

UpdatedWidget

Méthodes

MéthodeType renvoyéBrève description
addItem(text, value, selected, startIconUri, bottomText)UpdatedWidgetAjoute un nouvel élément pouvant être sélectionné.

Validation

Méthodes

MéthodeType renvoyéBrève description
setCharacterLimit(characterLimit)ValidationDéfinit la limite de caractères du widget.
setInputType(inputType)ValidationDéfinit le type d'entrée du widget.

VariableButtonSize

Propriétés

PropriétéTypeDescription
UNSPECIFIEDEnumSélectionne automatiquement COMPACT pour le panneau latéral et FULL_SIZE dans les autres cas.
COMPACTEnumPour les boutons portant le libellé "+"
FULL_SIZEEnumPour les boutons libellés "+ variable"

VerticalAlignment

Propriétés

PropriétéTypeDescription
CENTEREnumPlace le contenu verticalement au centre du conteneur.
TOPEnumPlace le contenu en haut du conteneur.
BOTTOMEnumPlace le contenu verticalement en bas du conteneur.

Visibility

Propriétés

PropriétéTypeDescription
VISIBLEEnumL'élément d'interface utilisateur est visible.
HIDDENEnumL'élément d'interface utilisateur est invisible.
VISIBILITY_UNSPECIFIEDEnumL'élément d'interface utilisateur n'est pas spécifié.

Widget

WorkflowDataSource

Méthodes

MéthodeType renvoyéBrève description
setIncludeVariables(includeVariables)WorkflowDataSourceIndique si les variables de l'étape précédente doivent être incluses dans la source de données.
setType(type)WorkflowDataSourceDéfinit le type de source de données du workflow.
setVariableButtonLabel(variableButtonLabel)WorkflowDataSourceDéfinit le libellé du bouton du sélecteur de variables, qui s'affiche après le signe "+" dans la taille de bouton FULL_SIZE.
setVariableButtonSize(variableButtonSize)WorkflowDataSourceDéfinit la taille du bouton du sélecteur de variables. Si UNSPECIFIED est sélectionné, le workflow utilisera automatiquement COMPACT dans le panneau latéral et FULL_SIZE dans les autres cas.

WorkflowDataSourceType

Propriétés

PropriétéTypeDescription
UNKNOWNEnumValeur par défaut.
USEREnumLa source de données correspond aux données d'un utilisateur.
SPACEEnumLa source de données est un espace Google Chat.
USER_WITH_FREE_FORMEnumLa source de données correspond aux données d'un utilisateur. Les utilisateurs peuvent choisir d'afficher et de sélectionner des membres existants de leur organisation Google Workspace, ou saisir manuellement une adresse e-mail ou un domaine valide.

WrapStyle

Propriétés

PropriétéTypeDescription
NOWRAPEnumAucun habillage.
WRAPEnumEncapsule le contenu de tous les widgets d'une colonne.