Card
以下にアドオン カードの例を示します。
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();
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
Border | Border | Border 列挙型。 |
Chip | Chip | Chip 列挙型。 |
Composed | Composed | Composed 列挙型。 |
Content | Content | Content 列挙型。 |
Grid | Grid | Grid 列挙型。 |
Horizontal | Horizontal | Horizontal 列挙型。 |
Icon | Icon | Icon 列挙型。 |
Image | Image | Image 列挙型。 |
Image | Image | Image 列挙型。 |
Image | Image | Image 列挙型。 |
Input | Input | Input 列挙型。 |
Load | Load | Load 列挙型。 |
On | On | On 列挙型。 |
Open | Open | Open 列挙型。 |
Selection | Selection | Selection 列挙型。 |
Text | Text | Text 列挙型。 |
Update | Update | Update 列挙型。 |
メソッド
詳細なドキュメント
new Action Response Builder()
new Action Status()
新しい Action
を作成します。
Google Chat アプリでのみ使用できます。Google Workspace アドオンには使用できません。
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
戻る
Action
- 空の ActionStatus。
new Attachment()
new Authorization Action()
new Authorization Exception()
new Border Style()
new Calendar Event Action Response Builder()
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
新しい Card
を作成します。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);
戻る
Card
- 空の Card
。
new Chat Action Response()
新しい Chat
を作成します。
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);
戻る
new Chat Response Builder()
新しい Chat
を作成します。
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();
戻る
Chat
- 空の ChatResponseBuilder。
new Chip()
new Chip List()
new Collapse Control()
新しい Collapse
を作成します。
Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビュー版。
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
戻る
Collapse
- 空の CollapseControl。
new Column()
新しい 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
- 空の列。
new Columns()
新しい 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
- 空の列セット。
new Compose Action Response Builder()
新しい Compose
を作成します。
戻る
Compose
- 空の ComposeActionResponse ビルダー。
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
new Dialog Action()
新しい Dialog
を作成します。
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);
戻る
Dialog
- 空の Dialog
。
new Divider()
新しい 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
- 区切り線。
new Drive Items Selected Action Response Builder()
new Editor File Scope Action Response Builder()
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
新しい 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');
戻る
Link
- 空の LinkPreview。
new Material Icon()
新しい Material
を作成します。
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();
戻る
Material
- 空の MaterialIcon。
new Notification()
new Overflow Menu()
新しい Overflow
を作成します。
Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビュー版。
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
戻る
Overflow
- 空の OverflowMenu。
new Overflow Menu Item()
新しい Overflow
を作成します。
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'));
戻る
Overflow
- 空の OverflowMenuItem。
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
new Text Button()
new Text Paragraph()
new Time Picker()
new Universal Action Response Builder()
新しい Universal
を作成します。
戻る
Universal
- 空の UniversalActionResponse ビルダー。
new Update Draft Action Response Builder()
新しい Update
を作成します。
戻る
Update
- 空の UpdateDraftActionResponseBuilder。
new Update Draft Bcc Recipients Action()
新しい Update
を作成します。
戻る
Update
- 空の UpdateDraftBccRecipientsAction。
new Update Draft Body Action()
new Update Draft Cc Recipients Action()
新しい Update
を作成します。
戻る
Update
- 空の UpdateDraftCcRecipientsAction。
new Update Draft Subject Action()
new Update Draft To Recipients Action()
新しい Update
を作成します。
戻る
Update
- 空の UpdateDraftToRecipientsAction。
new Validation()
新しい Validation
を作成します。
Google Chat アプリと Google Workspace アドオンで利用できます。
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
戻る
Validation
- 空の検証。