באמצעות 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();
תכונות
מאפיין (property) | סוג | תיאור |
---|---|---|
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()
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
חדש. בדוגמה הבאה נוצר כרטיס פשוט עם שתי פסקאות שמופרדות באמצעות מחיצה.
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
– תצוגה מקדימה ריקה של קישור.
newNotification()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
ייווצר UniversalActionResponseBuilder
חדש.
החזרות
UniversalActionResponseBuilder
– כלי לבניית UniversalActionResponse ריק.
newUpdateDraftActionResponseBuilder()
ייווצר UpdateDraftActionResponseBuilder
חדש.
החזרות
UpdateDraftActionResponseBuilder
— קובץ UpdateUploadActionResponseBuilder ריק.
newUpdateDraftBccRecipientsAction()
ייווצר UpdateDraftBccRecipientsAction
חדש;
החזרות
UpdateDraftBccRecipientsAction
— השדה UpdateUploadBccRecipientsAction ריק.
newUpdateDraftBodyAction()
newUpdateDraftCcRecipientsAction()
ייווצר UpdateDraftCcRecipientsAction
חדש.
החזרות
UpdateDraftCcRecipientsAction
— השדה UpdateUploadCcRecipientsAction ריק.
newUpdateDraftSubjectAction()
ייווצר UpdateDraftSubjectAction
חדש.
החזרות
UpdateDraftSubjectAction
– השדה UpdateUploadSubjectAction ריק.
newUpdateDraftToRecipientsAction()
ייווצר UpdateDraftToRecipientsAction
חדש.
החזרות
UpdateDraftToRecipientsAction
— השדה UpdateUploadToRecipientsAction ריק.
newValidation()
ייווצר Validation
חדש.
אפשר להשתמש בהן באפליקציות של Google Chat ובתוספים של Google Workspace.
const validation = CardService.newValidation() .setCharacterLimit(5) .setInputType(CardService.InputType.EMAIL);
החזרות
Validation
– אימות ריק.