本頁面由 Cloud Translation API 翻譯而成。

Class CardService

CardService 可讓您建立在不同 Google 服務中使用的通用卡片擴充性產品，例如 Google Workspace 外掛程式。

以下是外掛程式資訊卡的範例。

return CardService.newCardBuilder()
         .setHeader(CardService.newCardHeader().setTitle("CardTitle"))
         .build();

或者傳回多張卡片，如下所示：

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();
}

「即時通訊應用程式」資訊卡範例。

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` 列舉。
`ComposedEmailType`	`ComposedEmailType`	`ComposedEmailType` 列舉。
`ContentType`	`ContentType`	`ContentType` 列舉。
`GridItemLayout`	`GridItemLayout`	`GridItemLayout` 列舉。
`HorizontalAlignment`	`HorizontalAlignment`	`HorizontalAlignment` 列舉。
`Icon`	`Icon`	`Icon` 列舉。
`ImageCropType`	`ImageCropType`	`ImageCropType` 列舉。
`ImageStyle`	`ImageStyle`	`ImageStyle` 列舉。
`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`	建立新的 `CardBuilder`。
`newCardHeader()`	`CardHeader`	建立新的 `CardHeader`。
`newCardSection()`	`CardSection`	建立新的 `CardSection`。
`newCardWithId()`	`CardWithId`	建立新的 `CardWithId`。
`newChatActionResponse()`	`ChatActionResponse`	建立新的 `ChatActionResponse`。
`newChatResponseBuilder()`	`ChatResponseBuilder`	建立新的 `ChatResponseBuilder`。
`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`。
`newNavigation()`	`Navigation`	建立新的 `Navigation`。
`newNotification()`	`Notification`	建立新的 `Notification`。
`newOpenLink()`	`OpenLink`	建立新的 `OpenLink`。
`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 - 空白動作。

`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：空白的框線樣式。

`newButtonSet()`

建立新的 ButtonSet。

回攻員

ButtonSet — 空白的 ButtonSet。

`newCalendarEventActionResponseBuilder()`

建立新的 CalendarEventActionResponseBuilder。

回攻員

CalendarEventActionResponseBuilder - 空白的 CalendarEventActionResponseBuilder。

`newCardAction()`

建立新的 CardAction。

回攻員

CardAction - 空白的 CardAction。

`newCardBuilder()`

建立新的 CardBuilder。

回攻員

CardBuilder — 空白的卡片建立工具。

`newCardHeader()`

建立新的 CardHeader。

回攻員

CardHeader — 空白的 CardHeader。

`newCardSection()`

建立新的 CardSection。

回攻員

CardSection — 空白的 CardSection。

`newCardWithId()`

建立新的 CardWithId。這會用於透過 Google Chat 訊息傳送卡片。卡片 ID 是訊息中卡片的專屬 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。

`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(column)
    .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() {
    let cardSection1TextParagraph1 = CardService.newTextParagraph()
        .setText('Hello world!');

    let cardSection1Divider1 = CardService.newDivider();

    let cardSection1TextParagraph2 = CardService.newTextParagraph()
        .setText('Hello world!');

    let cardSection1 = CardService.newCardSection()
        .addWidget(cardSection1TextParagraph1)
        .addWidget(cardSection1Divider1)
        .addWidget(cardSection1TextParagraph2);

    let card = CardService.newCardBuilder()
        .addSection(cardSection1)
        .build();

   return card;
}

回攻員

Divider — 分隔線。

`newFixedFooter()`

建立新的 FixedFooter。

回攻員

FixedFooter：空白的 FixFooter。

`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 — 空白的鍵/值。

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

`newNavigation()`

建立新的 Navigation。

回攻員

Navigation：空白的導覽。

`newNotification()`

建立新的 Notification。

回攻員

Notification：空白通知。

`newOpenLink()`

建立新的 OpenLink。

回攻員

OpenLink：空白的 OpenLink。

`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 - Empty 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 - 空白的驗證。

Class CardService

屬性

方法

內容詳盡的說明文件

newAction()

回攻員

newActionResponseBuilder()

回攻員

newActionStatus()

回攻員

newAttachment()

回攻員

newAuthorizationAction()

回攻員

newAuthorizationException()

回攻員

newBorderStyle()

回攻員

newButtonSet()

回攻員

newCalendarEventActionResponseBuilder()

回攻員

newCardAction()

回攻員

newCardBuilder()

回攻員

newCardHeader()

回攻員

newCardSection()

回攻員

newCardWithId()

回攻員

newChatActionResponse()

回攻員

newChatResponseBuilder()

回攻員

newColumn()

newColumns()

回攻員

newComposeActionResponseBuilder()

回攻員

newDatePicker()

回攻員

newDateTimePicker()

回攻員

newDecoratedText()

回攻員

newDialog()

回攻員

newDialogAction()

回攻員

newDivider()

回攻員

newDriveItemsSelectedActionResponseBuilder()

回攻員

newEditorFileScopeActionResponseBuilder()

回攻員

newFixedFooter()

回攻員

newGrid()

回攻員

newGridItem()

回攻員

newIconImage()

回攻員

newImage()

回攻員

newImageButton()

回攻員

newImageComponent()

回攻員

newImageCropStyle()

回攻員

newKeyValue()

回攻員

newLinkPreview()

回攻員

newNavigation()

回攻員

newNotification()

`newAction()`

`newActionResponseBuilder()`

`newActionStatus()`

`newAttachment()`

`newAuthorizationAction()`

`newAuthorizationException()`

`newBorderStyle()`

`newButtonSet()`

`newCalendarEventActionResponseBuilder()`

`newCardAction()`

`newCardBuilder()`

`newCardHeader()`

`newCardSection()`

`newCardWithId()`

`newChatActionResponse()`

`newChatResponseBuilder()`

`newColumn()`

`newColumns()`

`newComposeActionResponseBuilder()`

`newDatePicker()`

`newDateTimePicker()`

`newDecoratedText()`

`newDialog()`

`newDialogAction()`

`newDivider()`

`newDriveItemsSelectedActionResponseBuilder()`

`newEditorFileScopeActionResponseBuilder()`

`newFixedFooter()`

`newGrid()`

`newGridItem()`

`newIconImage()`

`newImage()`

`newImageButton()`

`newImageComponent()`

`newImageCropStyle()`

`newKeyValue()`

`newLinkPreview()`

`newNavigation()`

`newNotification()`

`newOpenLink()`

`newSelectionInput()`

`newSuggestions()`

`newSuggestionsResponseBuilder()`

`newSwitch()`

`newTextButton()`

`newTextInput()`

`newTextParagraph()`

`newTimePicker()`

`newUniversalActionResponseBuilder()`

`newUpdateDraftActionResponseBuilder()`

`newUpdateDraftBccRecipientsAction()`

`newUpdateDraftBodyAction()`

`newUpdateDraftCcRecipientsAction()`

`newUpdateDraftSubjectAction()`

`newUpdateDraftToRecipientsAction()`

`newValidation()`