Le service Card
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 |
---|---|---|
Border | Border | Énumération Border . |
Chip | Chip | Énumération Chip . |
Composed | Composed | Énumération Composed . |
Content | Content | Énumération Content . |
Grid | Grid | Énumération Grid . |
Horizontal | Horizontal | Énumération Horizontal . |
Icon | Icon | Énumération Icon . |
Image | Image | Énumération Image . |
Image | Image | Énumération Image . |
Image | Image | Énumération Image . |
Input | Input | Énumération Input . |
Load | Load | Énumération Load . |
On | On | Énumération On . |
Open | Open | Énumération Open . |
Selection | Selection | Énumération Selection . |
Text | Text | Énumération Text . |
Update | Update | Énumération Update . |
Méthodes
Documentation détaillée
new Action Response Builder()
new Action Status()
crée un objet Action
;
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
Action
: ActionStatus vide.
new Attachment()
new Authorization Action()
new Authorization Exception()
crée un objet Authorization
;
Renvois
Authorization
: exception AuthorizationException vide.
new Border Style()
new Calendar Event Action Response Builder()
crée un objet Calendar
;
Renvois
Calendar
: Calendar
vide.
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
crée un objet Card
; Il permet d'envoyer une fiche dans un message Google Chat. L'ID de fiche est un identifiant unique d'une fiche dans un message lorsque vous envoyez plusieurs fiches.
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
Card
: Card
vide.
new Chat Action Response()
crée un objet Chat
;
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
Chat
: Chat
vide.
new Chat Response Builder()
crée un objet Chat
;
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
Chat
: ChatResponseBuilder vide.
new Chip()
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.
new Chip List()
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(); // Finish building the text chip... const chipList = CardService.newChipList() .setLayout(CardService.ChipListLayout.WRAPPED) .addChip(chip);
Renvois
Chip
: ChipList vide.
new Collapse Control()
crée un objet Collapse
;
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
Collapse
: CollapseControl vide.
new Column()
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.
new Columns()
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(firstColumn) .addColumn(secondColumn) .setWrapStyle(CardService.WrapStyle.WRAP);
Renvois
Columns
: ensemble vide de colonnes.
new Compose Action Response Builder()
crée un objet Compose
;
Renvois
Compose
: compilateur ComposeActionResponse vide.
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
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
new Dialog Action()
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(); const dialog = CardService.newDialog().setBody(card); const dialogAction = CardService.newDialogAction().setDialog(dialog);
Renvois
Dialog
: Dialog
vide.
new Divider()
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.
new Drive Items Selected Action Response Builder()
crée un objet Drive
;
Renvois
Drive
: Drive
vide.
new Editor File Scope Action Response Builder()
crée un objet Editor
;
Renvois
Editor
: Editor
vide.
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
crée un objet Link
;
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
Link
: LinkPreview vide.
new Material Icon()
crée un objet Material
;
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
Material
: MaterialIcon vide.
new Notification()
new Overflow Menu()
crée un objet Overflow
;
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
Overflow
: menu à développer vide.
new Overflow MenuItem()
crée un objet Overflow
;
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
Overflow
: OverflowMenuItem vide.
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
crée un objet Suggestions
;
Renvois
Suggestions
: générateur SuggestionsResponse vide.
new Text Button()
new Text Paragraph()
new Time Picker()
new Universal Action Response Builder()
crée un objet Universal
;
Renvois
Universal
: générateur UniversalActionResponse vide.
new Update Draft Action Response Builder()
crée un objet Update
;
Renvois
Update
: UpdateDraftActionResponseBuilder vide.
new Update Draft Bcc Recipients Action()
crée un Update
;
Renvois
Update
: UpdateDraftBccRecipientsAction vide.
new Update Draft Body Action()
new Update Draft Cc Recipients Action()
crée un objet Update
;
Renvois
Update
: UpdateDraftCcRecipientsAction vide.
new Update Draft Subject Action()
crée un objet Update
;
Renvois
Update
: UpdateDraftSubjectAction vide.
new Update Draft To Recipients Action()
crée un objet Update
;
Renvois
Update
: UpdateDraftToRecipientsAction vide.
new Validation()
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.