このページは 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();
}

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` 列挙値。
`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 - 空の 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 複数のカードを送信する場合、メッセージ内のカードの一意の識別子です。

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 - 空の 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。

`newNavigation()`

新しい Navigation を作成します。

戻る

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