CardService 提供创建可在不同 Google 可扩展性产品(例如 Google Workspace 加载项)中使用的通用卡片的功能。
以下是加购项卡片的示例。
function createCard() { return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('CardTitle')) .build(); }
或者,您也可以返回多张卡片,如下所示:
function createCards() { return [ CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), ]; }
以下示例展示了如何定义包含标题、文本、图片和菜单项的卡片:
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(); }
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();
属性
方法
详细文档
newActionResponseBuilder()
newActionStatus()
创建新的 ActionStatus。
仅适用于 Google Chat 应用。不适用于 Google Workspace 加购项。
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
返回
ActionStatus - 空 ActionStatus。
newAttachment()
newAuthorizationAction()
newAuthorizationException()
newBorderStyle()
newCalendarEventActionResponseBuilder()
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
创建新 CardWithId。用于在 Google Chat 消息中发送卡片。card ID 是发送多张卡片时消息中卡片的唯一标识符。
仅适用于 Google Chat 应用。不适用于 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);
返回
CardWithId - 一个空的 CardWithId。
newCarousel()
创建 Carousel。
const carousel = CardService.newCarousel() .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The first text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The second text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The third text paragraph in carousel')))
返回
Carousel - 空轮播界面。
newCarouselCard()
创建新的 CarouselCard。
const carouselCard = CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('Text paragraph in carousel'));
返回
CarouselCard - 空 Chip。
newChatActionResponse()
创建新的 ChatActionResponse。
仅适用于 Google Chat 应用。不适用于 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);
返回
ChatActionResponse - 一个空的 ChatActionResponse。
newChatResponseBuilder()
创建新的 ChatResponseBuilder。
仅适用于 Google Chat 应用。不适用于 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();
返回
ChatResponseBuilder - 一个空的 ChatResponseBuilder。
newChip()
newChipList()
newCollapseControl()
创建新的 CollapseControl。
适用于 Google Chat 应用。在 Google Workspace 加购项的开发者预览版中。
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
返回
CollapseControl - 一个空的 CollapseControl。
newColumn()
创建新的 Column。
适用于 Google Chat 应用和 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);
返回
Column - 空列。
newColumns()
创建一组新的 Columns。
适用于 Google Chat 应用和 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);
返回
Columns - 空列集。
newCommonWidgetAction()
newComposeActionResponseBuilder()
创建新的 ComposeActionResponseBuilder。
返回
ComposeActionResponseBuilder - 一个空的 ComposeActionResponse 构建器。
newDataSourceConfig()
newDatePicker()
newDateTimePicker()
newDecoratedText()
newDialog()
newDialogAction()
创建新的 DialogAction。
仅适用于 Google Chat 应用。不适用于 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);
返回
DialogAction - 一个空的 DialogAction。
newDivider()
创建新 Divider。以下示例构建了一个简单的卡片,其中包含 2 个段落,段落之间用分隔线隔开。
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; }
返回
Divider - 分隔线。
newDriveDataSourceSpec()
newDriveItemsSelectedActionResponseBuilder()
newEditorFileScopeActionResponseBuilder()
newEventAction()
newExpressionData()
newExpressionDataAction()
newExpressionDataCondition()
newHostAppDataSource()
newImageButton()
newImageComponent()
newImageCropStyle()
newLinkPreview()
创建新的 LinkPreview。
const decoratedText = CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!'); const cardSection = CardService.newCardSection().addWidget(decoratedText); const card = CardService.newCardBuilder().addSection(cardSection).build(); return CardService.newLinkPreview().setPreviewCard(card).setTitle( 'Smart chip title');
返回
LinkPreview - 空 LinkPreview。
newMaterialIcon()
创建新的 MaterialIcon。
适用于 Google Chat 应用和 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();
返回
MaterialIcon - 一个空的 MaterialIcon。
newNotification()
newOverflowMenu()
创建新的 OverflowMenu。
适用于 Google Chat 应用。在 Google Workspace 加购项的开发者预览版中。
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
返回
OverflowMenu - 一个空的 OverflowMenu。
newOverflowMenuItem()
创建新的 OverflowMenuItem。
适用于 Google Chat 应用。在 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'));
返回
OverflowMenuItem - 一个空的 OverflowMenuItem。
newPlatformDataSource()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
创建新的 UniversalActionResponseBuilder。
返回
UniversalActionResponseBuilder - 一个空的 UniversalActionResponse 构建器。
newUpdateDraftActionResponseBuilder()
创建新的 UpdateDraftActionResponseBuilder。
返回
UpdateDraftActionResponseBuilder - 一个空的 UpdateDraftActionResponseBuilder。
newUpdateDraftBccRecipientsAction()
创建新的 UpdateDraftBccRecipientsAction;
返回
UpdateDraftBccRecipientsAction - 一个空的 UpdateDraftBccRecipientsAction。
newUpdateDraftBodyAction()
newUpdateDraftCcRecipientsAction()
创建新的 UpdateDraftCcRecipientsAction。
返回
UpdateDraftCcRecipientsAction - 一个空的 UpdateDraftCcRecipientsAction。
newUpdateDraftSubjectAction()
newUpdateDraftToRecipientsAction()
创建新的 UpdateDraftToRecipientsAction。
返回
UpdateDraftToRecipientsAction - 一个空的 UpdateDraftToRecipientsAction。
newUpdateVisibilityAction()
newValidation()
创建新的 Validation。
适用于 Google Chat 应用和 Google Workspace 插件。
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
返回
Validation - 空验证。