此页面由 Cloud Translation API 翻译。

Class CardService

借助 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();

属性

属性	类型	说明
`BorderType`	`BorderType`	`BorderType` 枚举。
`ChipListLayout`	`ChipListLayout`	`ChipListLayout` 枚举。
`ComposedEmailType`	`ComposedEmailType`	`ComposedEmailType` 枚举。
`ContentType`	`ContentType`	`ContentType` 枚举。
`GridItemLayout`	`GridItemLayout`	`GridItemLayout` 枚举。
`HorizontalAlignment`	`HorizontalAlignment`	`HorizontalAlignment` 枚举。
`Icon`	`Icon`	`Icon` 枚举。
`ImageButtonStyle`	`ImageButtonStyle`	`ImageButtonStyle` 枚举。
`ImageCropType`	`ImageCropType`	`ImageCropType` 枚举。
`ImageStyle`	`ImageStyle`	`ImageStyle` 枚举。
`InputType`	`InputType`	`InputType` 枚举。
`LoadIndicator`	`LoadIndicator`	`LoadIndicator` 枚举。
`OnClose`	`OnClose`	`OnClose` 枚举。
`OpenAs`	`OpenAs`	`OpenAs` 枚举。
`SelectionInputType`	`SelectionInputType`	`SelectionInputType` 枚举。
`TextButtonStyle`	`TextButtonStyle`	`TextButtonStyle` 枚举。
`UpdateDraftBodyType`	`UpdateDraftBodyType`	`UpdateDraftBodyType` 枚举。

方法

方法	返回类型	简介
`newAction()`	`Action`	创建新的 `Action`。
`newActionResponseBuilder()`	`ActionResponseBuilder`	创建新的 `ActionResponseBuilder`。
`newActionStatus()`	`ActionStatus`	创建新的 `ActionStatus`。
`newAttachment()`	`Attachment`	创建新的 `Attachment`。
`newAuthorizationAction()`	`AuthorizationAction`	创建新的 `AuthorizationAction`。
`newAuthorizationException()`	`AuthorizationException`	创建新的 `AuthorizationException`。
`newBorderStyle()`	`BorderStyle`	创建新的 `BorderStyle`。
`newButtonSet()`	`ButtonSet`	创建新的 `ButtonSet`。
`newCalendarEventActionResponseBuilder()`	`CalendarEventActionResponseBuilder`	创建新的 `CalendarEventActionResponseBuilder`。
`newCardAction()`	`CardAction`	创建新的 `CardAction`。
`newCardBuilder()`	`CardBuilder`	创建新的卡片制作工具。
`newCardHeader()`	`CardHeader`	创建新的 `CardHeader`。
`newCardSection()`	`CardSection`	创建新的 `CardSection`。
`newCardWithId()`	`CardWithId`	创建新的 `CardWithId`。
`newChatActionResponse()`	`ChatActionResponse`	创建新的 `ChatActionResponse`。
`newChatResponseBuilder()`	`ChatResponseBuilder`	创建新的 `ChatResponseBuilder`。
`newChip()`	`Chip`	创建新的 `Chip`。
`newChipList()`	`ChipList`	创建新的 `ChipList`。
`newCollapseControl()`	`CollapseControl`	创建新的 `CollapseControl`。
`newColumn()`	`Column`	创建新的 `Column`。
`newColumns()`	`Columns`	创建一组新的 `Columns`。
`newComposeActionResponseBuilder()`	`ComposeActionResponseBuilder`	创建新的 `ComposeActionResponseBuilder`。
`newDatePicker()`	`DatePicker`	创建新的 `DatePicker`。
`newDateTimePicker()`	`DateTimePicker`	创建新的 `DateTimePicker`。
`newDecoratedText()`	`DecoratedText`	创建新的 `DecoratedText`。
`newDialog()`	`Dialog`	创建新的 `Dialog`。
`newDialogAction()`	`DialogAction`	创建新的 `DialogAction`。
`newDivider()`	`Divider`	创建新的 `Divider`。
`newDriveItemsSelectedActionResponseBuilder()`	`DriveItemsSelectedActionResponseBuilder`	创建新的 `DriveItemsSelectedActionResponseBuilder`。
`newEditorFileScopeActionResponseBuilder()`	`EditorFileScopeActionResponseBuilder`	创建新的 `EditorFileScopeActionResponseBuilder`。
`newFixedFooter()`	`FixedFooter`	创建新的 `FixedFooter`。
`newGrid()`	`Grid`	创建新的 `Grid`。
`newGridItem()`	`GridItem`	创建新的 `GridItem`。
`newIconImage()`	`IconImage`	创建新的 `IconImage`。
`newImage()`	`Image`	创建新的 `Image`。
`newImageButton()`	`ImageButton`	创建新的 `ImageButton`。
`newImageComponent()`	`ImageComponent`	创建新的 `ImageComponent`。
`newImageCropStyle()`	`ImageCropStyle`	创建新的 `ImageCropStyle`。
`newKeyValue()`	`KeyValue`	创建新的 `KeyValue`。
`newLinkPreview()`	`LinkPreview`	创建新的 `LinkPreview`。
`newMaterialIcon()`	`MaterialIcon`	创建新的 `MaterialIcon`。
`newNavigation()`	`Navigation`	创建新的 `Navigation`。
`newNotification()`	`Notification`	创建新的 `Notification`。
`newOpenLink()`	`OpenLink`	创建新的 `OpenLink`。
`newOverflowMenu()`	`OverflowMenu`	创建新的 `OverflowMenu`。
`newOverflowMenuItem()`	`OverflowMenuItem`	创建新的 `OverflowMenuItem`。
`newSelectionInput()`	`SelectionInput`	创建新的 `SelectionInput`。
`newSuggestions()`	`Suggestions`	创建新的 `Suggestions`。
`newSuggestionsResponseBuilder()`	`SuggestionsResponseBuilder`	创建新的 `SuggestionsResponseBuilder`。
`newSwitch()`	`Switch`	创建新的 `Switch`。
`newTextButton()`	`TextButton`	创建新的 `TextButton`。
`newTextInput()`	`TextInput`	创建新的 `TextInput`。
`newTextParagraph()`	`TextParagraph`	创建新的 `TextParagraph`。
`newTimePicker()`	`TimePicker`	创建新的 `TimePicker`。
`newUniversalActionResponseBuilder()`	`UniversalActionResponseBuilder`	创建新的 `UniversalActionResponseBuilder`。
`newUpdateDraftActionResponseBuilder()`	`UpdateDraftActionResponseBuilder`	创建新的 `UpdateDraftActionResponseBuilder`。
`newUpdateDraftBccRecipientsAction()`	`UpdateDraftBccRecipientsAction`	创建新的 `UpdateDraftBccRecipientsAction`；
`newUpdateDraftBodyAction()`	`UpdateDraftBodyAction`	创建新的 `UpdateDraftBodyAction`。
`newUpdateDraftCcRecipientsAction()`	`UpdateDraftCcRecipientsAction`	创建新的 `UpdateDraftCcRecipientsAction`。
`newUpdateDraftSubjectAction()`	`UpdateDraftSubjectAction`	创建新的 `UpdateDraftSubjectAction`。
`newUpdateDraftToRecipientsAction()`	`UpdateDraftToRecipientsAction`	创建新的 `UpdateDraftToRecipientsAction`。
`newValidation()`	`Validation`	创建新的 `Validation`。

详细文档

`newAction()`

创建新的 Action。

Action - 一个空的 Action。

`newActionResponseBuilder()`

创建新的 ActionResponseBuilder。

ActionResponseBuilder - 一个空的 ActionResponse 构建器。

`newActionStatus()`

创建新的 ActionStatus。

仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

const actionStatus = CardService.newActionStatus()
                         .setStatusCode(CardService.Status.OK)
                         .setUserFacingMessage('Success');

ActionStatus - 空 ActionStatus。

`newAttachment()`

创建新的 Attachment。

Attachment - 空附件。

`newAuthorizationAction()`

创建新的 AuthorizationAction。

AuthorizationAction - 一个空 AuthorizationAction。

`newAuthorizationException()`

创建新的 AuthorizationException。

AuthorizationException - 一个空的 AuthorizationException。

`newBorderStyle()`

创建新的 BorderStyle。

BorderStyle - 空 BorderStyle。

`newButtonSet()`

创建新的 ButtonSet。

ButtonSet - 一个空的 ButtonSet。

`newCalendarEventActionResponseBuilder()`

创建新的 CalendarEventActionResponseBuilder。

CalendarEventActionResponseBuilder - 一个空的 CalendarEventActionResponseBuilder。

`newCardAction()`

创建新的 CardAction。

CardAction - 空的 CardAction。

`newCardBuilder()`

创建新的卡片制作工具。

CardBuilder - 空白卡片制作工具。

`newCardHeader()`

创建新的 CardHeader。

CardHeader - 空的 CardHeader。

`newCardSection()`

创建新的 CardSection。

CardSection - 空白的 CardSection。

`newCardWithId()`

创建新 CardWithId。用于在 Google Chat 消息中发送卡片。当发送多张卡片时，卡片 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。

`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()`

创建新的 Chip。

仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Chip - 空白条状标签。

`newChipList()`

创建新的 ChipList。

仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

const chip = CardService.newChip();
// Finish building the text chip...

const chipList = CardService.newChipList()
                     .setLayout(CardService.ChipListLayout.WRAPPED)
                     .addChip(chip);

ChipList - 一个空的 ChipList。

`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 - 一组空列。

`newComposeActionResponseBuilder()`

创建新的 ComposeActionResponseBuilder。

ComposeActionResponseBuilder - 一个空的 ComposeActionResponse 构建器。

`newDatePicker()`

创建新的 DatePicker。

DatePicker - 空的 DatePicker。

`newDateTimePicker()`

创建新的 DateTimePicker。

DateTimePicker - 空的 DateTimePicker。

`newDecoratedText()`

创建新的 DecoratedText。

DecoratedText - 空的 DecoratedText。

`newDialog()`

创建新的 Dialog。

仅适用于 Google Chat 应用。不适用于 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);

Dialog - 一个空的 Dialog。

`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 - 分隔符。

`newDriveItemsSelectedActionResponseBuilder()`

创建新的 DriveItemsSelectedActionResponseBuilder。

DriveItemsSelectedActionResponseBuilder - 一个空的 DriveItemsSelectedActionResponseBuilder。

`newEditorFileScopeActionResponseBuilder()`

创建新的 EditorFileScopeActionResponseBuilder。

EditorFileScopeActionResponseBuilder - 一个空的 EditorFileScopeActionResponseBuilder。

`newFixedFooter()`

创建新的 FixedFooter。

FixedFooter - 空的 FixedFooter。

`newGrid()`

创建新的 Grid。

Grid - 空网格。

`newGridItem()`

创建新的 GridItem。

GridItem - 一个空的 GridItem。

`newIconImage()`

创建新的 IconImage。

IconImage - 空白图标图片。

`newImage()`

创建新的 Image。

Image - 空图片。

`newImageButton()`

创建新的 ImageButton。

ImageButton - 一个空的 ImageButton。

`newImageComponent()`

创建新的 ImageComponent。

ImageComponent - 一个空的 ImageComponent。

`newImageCropStyle()`

创建新的 ImageCropStyle。

ImageCropStyle - 一个空的 ImageCropStyle。

`newKeyValue()`

创建新的 KeyValue。

KeyValue - 空的 KeyValue。

`newLinkPreview()`

创建新的 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');

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。

`newNavigation()`

创建新的 Navigation。

Navigation - 空的 Navigation。

`newNotification()`

创建新的 Notification。

Notification - 空通知。

`newOpenLink()`

创建新的 OpenLink。

OpenLink - 空的 OpenLink。

`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。

`newSelectionInput()`

创建新的 SelectionInput。

SelectionInput - 一个空的 SelectionInput。

`newSuggestions()`

创建新的 Suggestions。

Suggestions - 空的“建议”。

`newSuggestionsResponseBuilder()`

创建新的 SuggestionsResponseBuilder。

SuggestionsResponseBuilder - 一个空的 SuggestionsResponse 构建器。

`newSwitch()`

创建新的 Switch。

Switch - 空开关。

`newTextButton()`

创建新的 TextButton。

TextButton - 一个空的 TextButton。

`newTextInput()`

创建新的 TextInput。

TextInput - 一个空的 TextInput。

`newTextParagraph()`

创建新的 TextParagraph。

TextParagraph - 空的 TextParagraph。

`newTimePicker()`

创建新的 TimePicker。

TimePicker - 一个空的 TimePicker。

`newUniversalActionResponseBuilder()`

创建新的 UniversalActionResponseBuilder。

UniversalActionResponseBuilder - 一个空的 UniversalActionResponse 构建器。

`newUpdateDraftActionResponseBuilder()`

创建新的 UpdateDraftActionResponseBuilder。

UpdateDraftActionResponseBuilder - 一个空的 UpdateDraftActionResponseBuilder。

`newUpdateDraftBccRecipientsAction()`

创建新的 UpdateDraftBccRecipientsAction；

UpdateDraftBccRecipientsAction - 一个空的 UpdateDraftBccRecipientsAction。

`newUpdateDraftBodyAction()`

创建新的 UpdateDraftBodyAction。

UpdateDraftBodyAction - 一个空的 UpdateDraftBodyAction。

`newUpdateDraftCcRecipientsAction()`

创建新的 UpdateDraftCcRecipientsAction。

UpdateDraftCcRecipientsAction - 一个空的 UpdateDraftCcRecipientsAction。

`newUpdateDraftSubjectAction()`

创建新的 UpdateDraftSubjectAction。

UpdateDraftSubjectAction - 一个空的 UpdateDraftSubjectAction。

`newUpdateDraftToRecipientsAction()`

创建新的 UpdateDraftToRecipientsAction。

UpdateDraftToRecipientsAction - 一个空的 UpdateDraftToRecipientsAction。

`newValidation()`

创建新的 Validation。

适用于 Google Chat 应用和 Google Workspace 插件。

const validation =
    CardService.newValidation().setCharacterLimit(5).setInputType(
        CardService.InputType.EMAIL);

Validation - 空验证。