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 . |
Methods
מסמכים מפורטים
newActionResponseBuilder()
newActionStatus()
יצירת ActionStatus
חדש.
התכונה הזו זמינה רק באפליקציות של Google Chat. לא זמין לתוספים של Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
חזרה
ActionStatus
– סטטוס פעולה ריק.
newAttachment()
newAuthorizationAction()
newAuthorizationException()
newBorderStyle()
newCalendarEventActionResponseBuilder()
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);
חזרה
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
— רשימת צ'יפים ריקה.
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
— ה-builder הריק של 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()
newEditorFileScopeActionResponseBuilder()
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
— תצוגה מקדימה של קישור ריקה.
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
— תפריט Overflow ריק.
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
– ה-builder הריק של 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
— אימות ריק.