CardService permet de créer des fiches génériques utilisées dans différents produits d'extensibilité Google, tels que les modules complémentaires Google Workspace.
Vous trouverez ci-dessous un exemple de fiche d'add-on.
function createCard() { return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('CardTitle')) .build(); }
Vous pouvez également renvoyer plusieurs cartes comme suit:
function createCards() { return [ CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), ]; }
Voici comment définir une fiche avec un en-tête, du texte, une image et un élément de menu:
function createWidgetDemoCard() { return CardService.newCardBuilder() .setHeader( CardService.newCardHeader() .setTitle('Widget demonstration') .setSubtitle('Check out these widgets') .setImageStyle(CardService.ImageStyle.SQUARE) .setImageUrl('https://www.example.com/images/headerImage.png'), ) .addSection( CardService.newCardSection() .setHeader('Simple widgets') // optional .addWidget( CardService.newTextParagraph().setText( 'These widgets are display-only. ' + 'A text paragraph can have multiple lines and ' + 'formatting.', ), ) .addWidget( CardService.newImage().setImageUrl( 'https://www.example.com/images/mapsImage.png', ), ), ) .addCardAction( CardService.newCardAction().setText('Gmail').setOpenLink( CardService.newOpenLink().setUrl('https://mail.google.com/mail'), ), ) .build(); }
Exemple de fiche pour les applications Chat
const cardHeader = CardService.newCardHeader() .setTitle('Sasha') .setSubtitle('Software Engineer') .setImageUrl( 'https://developers.google.com/chat/images/quickstart-app-avatar.png', ) .setImageStyle(CardService.ImageStyle.CIRCLE) .setImageAltText('Avatar for Sasha'); const cardSection = CardService.newCardSection() .setHeader('Contact Info') .setCollapsible(true) .setNumUncollapsibleWidgets(1) .addWidget( CardService.newDecoratedText() .setStartIcon( CardService.newIconImage().setIcon(CardService.Icon.EMAIL)) .setText('sasha@example.com'), ) .addWidget( CardService.newDecoratedText() .setStartIcon( CardService.newIconImage().setIcon(CardService.Icon.PERSON)) .setText('<font color="#80e27e">Online</font>'), ) .addWidget( CardService.newDecoratedText() .setStartIcon( CardService.newIconImage().setIcon(CardService.Icon.PHONE)) .setText('+1 (555) 555-1234'), ) .addWidget( CardService.newButtonSet() .addButton( CardService.newTextButton().setText('Share').setOpenLink( CardService.newOpenLink().setUrl( 'https://example.com/share'), ), ) .addButton( CardService.newTextButton() .setText('Edit') .setOnClickAction( CardService.newAction() .setFunctionName('goToView') .setParameters({viewType: 'EDIT'}), ), ), ); const card = CardService.newCardBuilder() .setHeader(cardHeader) .addSection(cardSection) .build();
Propriétés
Propriété | Type | Description |
---|---|---|
BorderType | BorderType | Énumération BorderType . |
ChipListLayout | ChipListLayout | Énumération ChipListLayout . |
ComposedEmailType | ComposedEmailType | Énumération ComposedEmailType . |
ContentType | ContentType | Énumération ContentType . |
GridItemLayout | GridItemLayout | Énumération GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | L'énumération HorizontalAlignment . |
Icon | Icon | L'énumération Icon . |
ImageButtonStyle | ImageButtonStyle | Énumération ImageButtonStyle . |
ImageCropType | ImageCropType | Énumération ImageCropType . |
ImageStyle | ImageStyle | Énumération ImageStyle . |
InputType | InputType | Énumération InputType . |
LoadIndicator | LoadIndicator | Énumération LoadIndicator . |
OnClose | OnClose | Énumération OnClose . |
OpenAs | OpenAs | Énumération OpenAs . |
SelectionInputType | SelectionInputType | Énumération SelectionInputType . |
TextButtonStyle | TextButtonStyle | Énumération TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | Énumération UpdateDraftBodyType . |
Méthodes
Documentation détaillée
newActionResponseBuilder()
crée un objet ActionResponseBuilder
;
Renvois
ActionResponseBuilder
: compilateur ActionResponse vide.
newActionStatus()
crée un objet ActionStatus
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
Renvois
ActionStatus
: un champ ActionStatus vide.
newAttachment()
newAuthorizationAction()
newAuthorizationException()
crée un objet AuthorizationException
;
Renvois
AuthorizationException
: exception AuthorizationException vide.
newBorderStyle()
newCalendarEventActionResponseBuilder()
crée un objet CalendarEventActionResponseBuilder
;
Renvois
CalendarEventActionResponseBuilder
: CalendarEventActionResponseBuilder
vide.
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
crée un objet CardWithId
; Permet d'envoyer une carte dans un message Google Chat. L'ID de carte est un identifiant unique associé à une carte dans un message lors de l'envoi de plusieurs cartes.
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const cardSection = CardService.newCardSection(); cardSection.addWidget( CardService.newTextParagraph().setText('This is a text paragraph widget.'), ); const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card title')) .addSection(cardSection) .build(); const cardWithId = CardService.newCardWithId().setCardId('card_id').setCard(card);
Renvois
CardWithId
: CardWithId
vide.
newChatActionResponse()
crée un objet ChatActionResponse
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card title')) .build(); const dialog = CardService.newDialog().setBody(card); const dialogAction = CardService.newDialogAction().setDialog(dialog); const chatActionResponse = CardService.newChatActionResponse() .setResponseType(CardService.ResponseType.DIALOG) .setDialogAction(dialogAction);
Renvois
ChatActionResponse
: ChatActionResponse
vide.
newChatResponseBuilder()
crée un objet ChatResponseBuilder
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const cardSection = CardService.newCardSection(); cardSection.addWidget( CardService.newTextParagraph().setText('This is a text paragraph widget.'), ); const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card title')) .addSection(cardSection) .build(); const cardWithId = CardService.newCardWithId().setCardId('card_id').setCard(card); const chatResponse = CardService.newChatResponseBuilder().addCardsV2(cardWithId).build();
Renvois
ChatResponseBuilder
: ChatResponseBuilder vide.
newChip()
crée un objet Chip
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Renvois
Chip
: chip vide.
newChipList()
crée un objet ChipList
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const chip = CardService.newChip(); // Finish building the text chip... const chipList = CardService.newChipList() .setLayout(CardService.ChipListLayout.WRAPPED) .addChip(chip);
Renvois
ChipList
: ChipList vide.
newCollapseControl()
crée un objet CollapseControl
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
Renvois
CollapseControl
: un élément RepliControl vide.
newColumn()
crée un objet Column
;
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
const columnWidget = CardService.newTextParagraph(); const column = CardService.newColumn() .setHorizontalSizeStyle( CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE) .setHorizontalAlignment(CardService.HorizontalAlignment.CENTER) .setVerticalAlignment(CardService.VerticalAlignment.CENTER) .addWidget(columnWidget);
Renvois
Column
: colonne vide.
newColumns()
Crée un ensemble de Columns
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
const firstColumn = CardService.newColumn() .setHorizontalSizeStyle( CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE) .setHorizontalAlignment(CardService.HorizontalAlignment.CENTER) .setVerticalAlignment(CardService.VerticalAlignment.CENTER); const secondColumn = CardService.newColumn() .setHorizontalSizeStyle( CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE) .setHorizontalAlignment(CardService.HorizontalAlignment.CENTER) .setVerticalAlignment(CardService.VerticalAlignment.CENTER); const columns = CardService.newColumns() .addColumn(column) .addColumn(secondColumn) .setWrapStyle(CardService.WrapStyle.WRAP);
Renvois
Columns
: ensemble vide de colonnes.
newComposeActionResponseBuilder()
crée un objet ComposeActionResponseBuilder
;
Renvois
ComposeActionResponseBuilder
: compilateur ComposeActionResponse vide.
newDatePicker()
newDateTimePicker()
newDecoratedText()
newDialog()
crée un objet Dialog
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card title')) .build(); // Sets the card of the dialog. const dialog = CardService.newDialog().setBody(card);
Renvois
newDialogAction()
crée un objet DialogAction
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card title')) .build(); const dialog = CardService.newDialog().setBody(card); const dialogAction = CardService.newDialogAction().setDialog(dialog);
Renvois
DialogAction
: DialogAction
vide.
newDivider()
crée un objet Divider
; L'exemple suivant crée une fiche simple avec deux paragraphes séparés par un séparateur.
function buildCard() { const cardSection1TextParagraph1 = CardService.newTextParagraph().setText('Hello world!'); const cardSection1Divider1 = CardService.newDivider(); const cardSection1TextParagraph2 = CardService.newTextParagraph().setText('Hello world!'); const cardSection1 = CardService.newCardSection() .addWidget(cardSection1TextParagraph1) .addWidget(cardSection1Divider1) .addWidget(cardSection1TextParagraph2); const card = CardService.newCardBuilder().addSection(cardSection1).build(); return card; }
Renvois
Divider
: séparateur.
newDriveItemsSelectedActionResponseBuilder()
crée un objet DriveItemsSelectedActionResponseBuilder
;
Renvois
DriveItemsSelectedActionResponseBuilder
: DriveItemsSelectedActionResponseBuilder
vide.
newEditorFileScopeActionResponseBuilder()
crée un objet EditorFileScopeActionResponseBuilder
;
Renvois
EditorFileScopeActionResponseBuilder
: EditorFileScopeActionResponseBuilder
vide.
newImageButton()
newImageComponent()
newImageCropStyle()
newLinkPreview()
crée un objet LinkPreview
;
const decoratedText = CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!'); const cardSection = CardService.newCardSection().addWidget(decoratedText); const card = CardService.newCardBuilder().addSection(cardSection).build(); const linkPreview = CardService.newLinkPreview().setPreviewCard(card).setTitle( 'Smart chip title');
Renvois
LinkPreview
: LinkPreview vide.
newMaterialIcon()
crée un objet MaterialIcon
;
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
const materialIcon = CardService.newMaterialIcon().setName('check_box').setFill(true); const cardSection = CardService.newCardSection(); cardSection.addWidget( CardService.newDecoratedText() .setStartIcon(CardService.newIconImage().setMaterialIcon(materialIcon)) .setText('sasha@example.com'), ); const card = CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('Card Title')) .addSection(cardSection) .build();
Renvois
MaterialIcon
: MaterialIcon vide.
newNotification()
newOverflowMenu()
crée un objet OverflowMenu
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
Renvois
OverflowMenu
: menu à développer vide.
newOverflowMenuItem()
crée un objet OverflowMenuItem
;
Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com'));
Renvois
OverflowMenuItem
: un élément OverflowMenuItem vide.
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
crée un objet SuggestionsResponseBuilder
;
Renvois
SuggestionsResponseBuilder
: générateur SuggestionsResponse vide.
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
crée un objet UniversalActionResponseBuilder
;
Renvois
UniversalActionResponseBuilder
: générateur UniversalActionResponse vide.
newUpdateDraftActionResponseBuilder()
crée un objet UpdateDraftActionResponseBuilder
;
Renvois
UpdateDraftActionResponseBuilder
: UpdateDraftActionResponseBuilder vide.
newUpdateDraftBccRecipientsAction()
crée un UpdateDraftBccRecipientsAction
;
Renvois
UpdateDraftBccRecipientsAction
: UpdateDraftBccRecipientsAction vide.
newUpdateDraftBodyAction()
newUpdateDraftCcRecipientsAction()
crée un objet UpdateDraftCcRecipientsAction
;
Renvois
UpdateDraftCcRecipientsAction
: action UpdateDraftCcRecipientsAction vide.
newUpdateDraftSubjectAction()
crée un objet UpdateDraftSubjectAction
;
Renvois
UpdateDraftSubjectAction
: UpdateDraftSubjectAction vide.
newUpdateDraftToRecipientsAction()
crée un objet UpdateDraftToRecipientsAction
;
Renvois
UpdateDraftToRecipientsAction
: une valeur UpdateDraftToRecipientsAction vide.
newValidation()
crée un objet Validation
;
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
Renvois
Validation
: validation vide.