Card Service

Service de carte

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

Classes

NomBrève description
ActionAction qui active l'interactivité dans les éléments de l'interface utilisateur.
ActionResponseObjet de réponse pouvant être renvoyé par une fonction de rappel (par exemple, un gestionnaire de réponses à un formulaire) pour effectuer une ou plusieurs actions sur le client.
ActionResponseBuilderCompilateur pour les objets ActionResponse.
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 auprès de l'utilisateur.
BorderStyleClasse représentant 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 ligne.
CalendarEventActionResponseReprésente une réponse qui modifie l'événement d'agenda en cours de modification par l'utilisateur en réaction à une action effectuée dans l'interface utilisateur, comme un clic sur un bouton.
CalendarEventActionResponseBuilderCompilateur pour les objets CalendarEventActionResponse.
CardUne fiche de contexte qui représente une seule vue de l'interface utilisateur.
CardActionÉlément de menu cliquable ajouté au menu de l'en-tête de la carte.
CardBuilderCompilateur pour les objets Card.
CardHeaderEn-tête d'un élément Card.
CardSectionUne section de fiche contient des groupes de widgets et permet de les séparer visuellement.
CardServiceCardService permet 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.
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 d'énumération qui indique si l'e-mail composé est autonome ou sous forme de brouillon de réponse.
ContentTypeValeur d'énumération qui spécifie le type de contenu du 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 affichant du texte avec des décorations facultatives.
DisplayStyleÉnumération qui définit le style d'affichage de la carte.
DividerSéparateur horizontal.
DriveItemsSelectedActionResponseReprésente une réponse qui apporte des modifications à Drive lorsque des éléments Drive sont sélectionnés et en réaction à une action effectuée dans l'interface utilisateur (un clic sur un bouton, par exemple).
DriveItemsSelectedActionResponseBuilderCompilateur pour les objets DriveItemsSelectedActionResponse.
EditorFileScopeActionResponseApporte des modifications à un éditeur, tel que Google Docs, Sheets ou Slides en réponse à une action effectuée dans l'interface utilisateur.
EditorFileScopeActionResponseBuilderCompilateur pour les objets EditorFileScopeActionResponse.
FixedFooterPied de page fixe affiché en bas d'un Card de module complémentaire.
GridGrille organisée pour 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 élément GridItem.
HorizontalAlignmentÉnumération spécifiant l'alignement horizontal d'un widget.
IconDes icônes prédéfinies pouvant être utilisées dans divers objets d'interface utilisateur, tels que les widgets ImageButton ou DecoratedText.
IconImageUne icône prédéfinie ou une icône provenant d'une URL avec un style de recadrage personnalisable.
ImageWidget qui affiche une seule image.
ImageButtonImageButton avec une image affichée dessus.
ImageComponentComposant image qui peut être ajouté aux éléments de la grille.
ImageCropStyleClasse qui représente un style de recadrage pouvant être appliqué aux composants d'une image.
ImageCropTypeÉnumération représentant les styles de recadrage appliqués aux composants de l'image.
ImageStyleÉnumération qui définit un style de recadrage d'image.
KeyValueCette classe est obsolète.
LoadIndicatorType d'énumération qui spécifie le type de chargement ou d'indicateur de progression à afficher pendant le traitement d'une Action.
NavigationObjet d'assistance qui contrôle la navigation dans les fiches.
NotificationNotification présentée à l'utilisateur en réponse à son interaction avec un élément d'interface utilisateur.
OnCloseÉnumération spécifiant l'action à effectuer lorsqu'une URL ouverte via un OpenLink est fermée.
OpenAsÉnumération spécifiant comment ouvrir une URL.
OpenLinkReprésente une action permettant d'ouvrir un lien avec certaines options.
SelectionInputChamp de saisie permettant de choisir entre différentes options prédéfinies
SelectionInputTypeType d'entrée de sélection.
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 pouvant être activé ou désactivé.
SwitchControlTypeType de commande de widget Switch.
TextButtonUne TextButton avec un libellé de texte.
TextButtonStyleÉnumération spécifiant le style de TextButton.
TextInputWidget de champ de saisie qui accepte la saisie de texte
TextParagraphWidget qui affiche le texte et accepte la mise en forme HTML de base.
TimePickerChamp de saisie permettant aux utilisateurs de saisir une heure.
UniversalActionResponseObjet de réponse pouvant être renvoyé par une méthode créant une action universelle.
UniversalActionResponseBuilderCompilateur pour les objets UniversalActionResponse.
UpdateDraftActionResponseReprésente une action qui met à jour le brouillon d'e-mail en cours de modification par l'utilisateur.
UpdateDraftActionResponseBuilderCompilateur pour les objets UpdateDraftActionResponse.
UpdateDraftBccRecipientsActionMet à jour les destinataires en Cci d'un brouillon d'e-mail.
UpdateDraftBodyActionMet à jour le corps du brouillon de l'e-mail.
UpdateDraftBodyTypeValeur d'énumération qui spécifie le type d'un UpdateDraftBodyAction.
UpdateDraftCcRecipientsActionMet à jour les destinataires en Cc d'un brouillon d'e-mail.
UpdateDraftSubjectActionMet à jour la ligne d'objet d'un brouillon d'e-mail.
UpdateDraftToRecipientsActionMet à jour le champ "À" des destinataires d'un brouillon d'e-mail.
WidgetClasse de base pour tous les widgets pouvant être ajoutés à un Card.

Action

Méthodes

MéthodeType renvoyéBrève description
setFunctionName(functionName)ActionDéfinit le nom de la fonction de rappel à appeler.
setLoadIndicator(loadIndicator)ActionDéfinit l'indicateur de chargement qui s'affiche pendant l'exécution de l'action.
setParameters(parameters)ActionPermet de transmettre des paramètres personnalisés à la fonction de rappel.

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 d'action actuelle 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.

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 le rattachement.
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 que l'utilisateur voit lorsqu'il demande une autorisation.
throwException()voidDéclenche cette exception.

BorderStyle

Méthodes

MéthodeType renvoyéBrève description
setCornerRadius(radius)BorderStyleDéfinit l'arrondi 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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setOnClickAction(action)ButtonDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)ButtonDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

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 associée dans l'interface utilisateur est effectuée.
addAttendees(emails)CalendarEventActionResponseBuilderIndique que la réponse doit ajouter les participants indiqués à l'événement d'agenda lorsque l'action associée dans l'interface utilisateur est effectuée.
build()CalendarEventActionResponseCrée la réponse d'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 associée dans l'interface utilisateur 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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setOnClickAction(action)CardActionDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)CardActionDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)CardActionDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
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 fiche.
addSection(section)CardBuilderAjoute une section à cette fiche.
build()CardCrée la carte 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 fiche.
setHeader(cardHeader)CardBuilderDéfinit l'en-tête de cette fiche.
setName(name)CardBuilderDéfinit le nom de cette carte.
setPeekCardHeader(peekCardHeader)CardBuilderDéfinit l'en-tête de la fiche d'aperçu.

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 fiche.
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.
setCollapsible(collapsible)CardSectionDétermine 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.
ComposedEmailTypeComposedEmailTypeÉnumération ComposedEmailType.
ContentTypeContentTypeÉnumération ContentType.
GridItemLayoutGridItemLayoutÉnumération GridItemLayout.
HorizontalAlignmentHorizontalAlignmentÉnumération HorizontalAlignment.
IconIconÉnumération Icon.
ImageCropTypeImageCropTypeÉnumération ImageCropType.
ImageStyleImageStyleÉnumération ImageStyle.
LoadIndicatorLoadIndicatorÉnumération LoadIndicator.
OnCloseOnCloseÉnumération OnClose.
OpenAsOpenAsÉnumération OpenAs.
SelectionInputTypeSelectionInputTypeÉnumération SelectionInputType.
TextButtonStyleTextButtonStyleÉnumération TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeÉnumération UpdateDraftBodyType.

Méthodes

MéthodeType renvoyéBrève description
newAction()Actioncrée un objet Action ;
newActionResponseBuilder()ActionResponseBuildercrée un objet ActionResponseBuilder ;
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 objet CardBuilder ;
newCardHeader()CardHeadercrée un objet CardHeader ;
newCardSection()CardSectioncrée un objet CardSection ;
newComposeActionResponseBuilder()ComposeActionResponseBuildercrée un objet ComposeActionResponseBuilder ;
newDatePicker()DatePickercrée un objet DatePicker ;
newDateTimePicker()DateTimePickercrée un objet DateTimePicker ;
newDecoratedText()DecoratedTextcrée un objet DecoratedText ;
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 ;
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 ;
newNavigation()Navigationcrée un objet Navigation ;
newNotification()Notificationcrée un objet Notification ;
newOpenLink()OpenLinkcrée un objet OpenLink ;
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 ;

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 d'action Compose 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 de réponse à un autre message
STANDALONE_DRAFTEnumBrouillon de message autonome.

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 création.

DatePicker

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)DatePickerDéfinit le nom de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur.
setOnChangeAction(action)DatePickerDéfinit une 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 de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur.
setOnChangeAction(action)DateTimePickerDéfinit une 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 à 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 s'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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setEndIcon(endIcon)DecoratedTextDéfinit la IconImage facultative qui s'affiche à droite du contenu.
setOnClickAction(action)DecoratedTextDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)DecoratedTextDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)DecoratedTextDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setStartIcon(startIcon)DecoratedTextDéfinit la IconImage facultative à afficher avant le contenu textuel.
setSwitchControl(switchToSet)DecoratedTextDéfinit l'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 s'affiche au-dessus du contenu textuel.
setWrapText(wrapText)DecoratedTextDétermine si le texte de la valeur doit être affiché sur une ou plusieurs lignes.

DisplayStyle

Propriétés

PropriétéTypeDescription
PEEKEnumAffichez l'en-tête de la fiche en bas du contenu complémentaire par-dessus le 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 d'action Drive actuelle.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderIndique que la réponse demande une portée du fichier pour l'élément contextuel 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 d'action Editor actuelle.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderDemande le niveau d'accès drive.file pour le document Editor actif actuel.

FixedFooter

Méthodes

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

Grid

Méthodes

MéthodeType renvoyéBrève description
addItem(gridItem)GridAjoute un nouvel élément à 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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setNumColumns(numColumns)GridNombre de colonnes à afficher dans la grille.
setOnClickAction(action)GridDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)GridDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)GridDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
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 des images pour l'élément de la grille.
setSubtitle(subtitle)GridItemDéfinit le sous-titre de l'élément de la grille.
setTextAlignment(alignment)GridItemDéfinit l'alignement horizontal de l'élément de grille.
setTitle(title)GridItemDéfinit le titre de l'élément de la grille.

GridItemLayout

Propriétés

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

HorizontalAlignment

Propriétés

PropriétéTypeDescription
STARTEnumAlignez le widget au début du côté de la phrase.
CENTEREnumAlignez le widget au centre.
ENDEnumAlignez le widget à la fin de la phrase.

Icon

Propriétés

PropriétéTypeDescription
NONEEnumAucune icône.
AIRPLANEEnumIcône représentant un avion en vol
BOOKMARKEnumIcône Favori
BUSEnumIcône du bus
CAREnumIcône de votre voiture
CLOCKEnumIcône 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 siège pour un événement
FLIGHT_ARRIVALEnumIcône d'arrivée du vol
FLIGHT_DEPARTUREEnumIcône de départ du vol
HOTELEnumIcône Hôtel
HOTEL_ROOM_TYPEEnumIcône Hôtel
INVITEEnumIcône Inviter
MAP_PINEnumIcône de punaise sur la carte
MEMBERSHIPEnumIcône Adhésion
MULTIPLE_PEOPLEEnumIcône Plusieurs personnes
OFFEREnumIcône d'offre
PERSONEnumIcône représentant une personne
PHONEEnumIcône de téléphone
RESTAURANT_ICONEnumIcône du restaurant
SHOPPING_CARTEnumIcône Panier d'achat
STAREnumIcône de favoris
STOREEnumIcône de magasin
TICKETEnumIcône de billet
TRAINEnumIcône Train
VIDEO_CAMERAEnumIcône en forme de caméra vidéo
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ée 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 celle-ci n'est pas définie.
setImageCropType(imageCropType)IconImageDéfinit le style de recadrage de l'image.

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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
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'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ImageDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)ImageDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setIcon(icon)ImageButtonDéfinit une Icon prédéfinie à afficher sur le bouton.
setIconUrl(url)ImageButtonDéfinit l'URL d'une image à utiliser comme icône de ce bouton.
setOnClickAction(action)ImageButtonDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ImageButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)ImageButtonDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

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 de forme rectangulaire avec ratio personnalisé
RECTANGLE_4_3EnumStyle de recadrage de forme rectangulaire au format 4:3

ImageStyle

Propriétés

PropriétéTypeDescription
SQUAREEnumPas de recadrage.
CIRCLEEnumRecadrez l'image pour lui donner un cercle.

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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setOnClickAction(action)KeyValueDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)KeyValueDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)KeyValueDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

LoadIndicator

Propriétés

PropriétéTypeDescription
SPINNEREnumUtilisez une icône de chargement.
NONEEnumN'utilisez pas d'indicateur.

Méthodes

MéthodeType renvoyéBrève description
popCard()NavigationAffiche une carte de la pile de navigation.
popToNamedCard(cardName)NavigationAffiche la carte spécifiée à partir de son nom.
popToRoot()NavigationAjoute la pile de cartes à la carte racine.
printJson()StringAffiche la représentation JSON de cet objet.
pushCard(card)NavigationTransfère la carte donnée dans la pile.
updateCard(card)NavigationRemplacement sur place de 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
RELOADEnumIl actualise le module complémentaire lorsque la fenêtre se ferme.

OpenAs

Propriétés

PropriétéTypeDescription
FULL_SIZEEnumOuvrir dans une fenêtre ou un onglet complet.
OVERLAYEnumLa bannière s'ouvre en superposition, par exemple dans une fenêtre 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 est fermé.
setOpenAs(openAs)OpenLinkDéfinit le comportement de l'URL lorsqu'elle est ouverte.
setUrl(url)OpenLinkDéfinit l'URL à ouvrir.

SelectionInput

Méthodes

MéthodeType renvoyéBrève description
addItem(text, value, selected)SelectionInputAjoute un nouvel élément pouvant être sélectionné.
setFieldName(fieldName)SelectionInputDéfinit la clé qui identifie cette entrée de sélection dans l'objet événement généré en cas d'interaction avec l'interface utilisateur.
setOnChangeAction(action)SelectionInputDéfinit une Action à exécuter chaque fois que l'entrée de sélection change.
setTitle(title)SelectionInputDéfinit le titre à afficher devant 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 d'entrée via bouton radio.
DROPDOWNEnumStyle d'entrée pour la sélection du menu déroulant

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 de suggestion actuelle et la valide.
setSuggestions(suggestions)SuggestionsResponseBuilderDéfinit les suggestions utilisées pour 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 commande du contacteur.
setFieldName(fieldName)SwitchDéfinit la clé qui identifie ce contacteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur.
setOnChangeAction(action)SwitchDéfinit l'action à effectuer lorsque le bouton est activé.
setSelected(selected)SwitchDétermine si ce bouton bascule doit être sélectionné ou non au départ.
setValue(value)SwitchDéfinit la valeur envoyée en tant que saisie de formulaire lorsque ce bouton est activé.

SwitchControlType

Propriétés

PropriétéTypeDescription
SWITCHEnumCommande d'activation/désactivation stylisée pour un widget de commutateur.
CHECK_BOXEnumCommande de style case à cocher pour un widget Switch (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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setDisabled(disabled)TextButtonDétermine si le bouton est désactivé.
setOnClickAction(action)TextButtonDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)TextButtonDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)TextButtonDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setText(text)TextButtonDéfinit le texte à afficher sur le bouton.
setTextButtonStyle(textButtonStyle)TextButtonDéfinit le style du bouton.

TextButtonStyle

Propriétés

PropriétéTypeDescription
TEXTEnumBouton de texte normal sur fond clair.
FILLEDEnumBouton de texte sur fond coloré.

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é en cas d'interaction avec l'interface utilisateur.
setHint(hint)TextInputDéfinit une indication pour le texte saisi.
setMultiline(multiline)TextInputDétermine si le texte d'entrée s'affiche sur une ou plusieurs lignes.
setOnChangeAction(action)TextInputDéfinit une action à exécuter chaque fois que l'entrée de texte 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 des suggestions basées sur l'entrée utilisateur pour la saisie semi-automatique.
setTitle(title)TextInputDéfinit le titre à afficher au-dessus du champ de saisie.
setValue(value)TextInputDéfinit la valeur préremplie à définir dans le champ de saisie.

TextParagraph

Méthodes

MéthodeType renvoyéBrève description
setText(text)TextParagraphDéfinit le texte du paragraphe.

TimePicker

Méthodes

MéthodeType renvoyéBrève description
setFieldName(fieldName)TimePickerDéfinit le nom de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur.
setHours(hours)TimePickerDéfinit la valeur des heures préremplies à définir dans le champ de saisie.
setMinutes(minutes)TimePickerDéfinit la valeur préremplie du nombre de minutes à définir dans le champ de saisie.
setOnChangeAction(action)TimePickerDéfinit une 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.

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 brouillon de mise à jour actuelle et la valide.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires d'un brouillon en Cci.
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 Cc d'un brouillon.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour l'objet d'un brouillon.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour le champ "À" des destinataires d'un brouillon.

UpdateDraftBccRecipientsAction

Méthodes

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

UpdateDraftBodyAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateContent(content, contentType)UpdateDraftBodyActionAjoute le contenu spécifié au brouillon du corps du texte.
setUpdateType(updateType)UpdateDraftBodyActionDéfinit l'élément UpdateDraftBodyType de cette action de mise à jour dans 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 Cc d'un brouillon d'e-mail.

UpdateDraftSubjectAction

Méthodes

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

UpdateDraftToRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionMet à jour le champ "À" des destinataires d'un brouillon d'e-mail.

Widget