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 |
วิธีการ
เอกสารโดยละเอียด
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()
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 ที่ว่างเปล่า
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()
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() { 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
— ตัวแบ่ง
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 ที่ว่างเปล่า
newNotification()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
สร้าง SuggestionsResponseBuilder
ใหม่
รีเทิร์น
SuggestionsResponseBuilder
— เครื่องมือสร้าง FAQsResponse ที่ว่างเปล่า
newTextButton()
newTextParagraph()
newTimePicker()
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 ที่ว่างเปล่า