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 |
เมธอด
เอกสารประกอบโดยละเอียด
newActionResponseBuilder()
สร้าง ActionResponseBuilder
ใหม่
รีเทิร์น
ActionResponseBuilder
— ตัวสร้าง ActionResponse ที่ว่างเปล่า
newActionStatus()
สร้าง ActionStatus
ใหม่
ใช้ได้กับแอป Google Chat เท่านั้น ไม่พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
รีเทิร์น
ActionStatus
— ActionStatus ว่างเปล่า
newAttachment()
newAuthorizationAction()
newAuthorizationException()
สร้าง AuthorizationException
ใหม่
รีเทิร์น
AuthorizationException
— AuthorizationException ว่างเปล่า
newBorderStyle()
newCalendarEventActionResponseBuilder()
สร้าง CalendarEventActionResponseBuilder
ใหม่
รีเทิร์น
CalendarEventActionResponseBuilder
— CalendarEventActionResponseBuilder
ว่างเปล่า
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
สร้าง CardWithId
ใหม่ ฟิลด์นี้ใช้สำหรับส่งการ์ดในข้อความ Google 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);
รีเทิร์น
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()
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()
newDateTimePicker()
newDecoratedText()
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);
รีเทิร์น
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
ว่างเปล่า
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(); 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 ว่าง
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 ว่าง
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
สร้าง SuggestionsResponseBuilder
ใหม่
รีเทิร์น
SuggestionsResponseBuilder
— ตัวสร้าง SuggestionsResponse ที่ว่างเปล่า
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
สร้าง UniversalActionResponseBuilder
ใหม่
รีเทิร์น
UniversalActionResponseBuilder
— ตัวสร้าง UniversalActionResponse ที่ว่างเปล่า
newUpdateDraftActionResponseBuilder()
สร้าง UpdateDraftActionResponseBuilder
ใหม่
รีเทิร์น
UpdateDraftActionResponseBuilder
— UpdateDraftActionResponseBuilder ว่างเปล่า
newUpdateDraftBccRecipientsAction()
สร้าง UpdateDraftBccRecipientsAction
ใหม่
รีเทิร์น
UpdateDraftBccRecipientsAction
— UpdateDraftBccRecipientsAction ว่างเปล่า
newUpdateDraftBodyAction()
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
— การตรวจสอบที่ว่างเปล่า