Card Service امکان ایجاد کارتهای عمومی مورد استفاده در محصولات مختلف توسعهپذیری 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 Apps.
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 Type | Border Type | شمارش Border Type . |
Chip List Layout | Chip List Layout | Chip List Layout . |
Composed Email Type | Composed Email Type | شمارش Composed Email Type . |
Content Type | Content Type | شمارش Content Type |
Grid Item Layout | Grid Item Layout | شمارش Grid Item Layout . |
Horizontal Alignment | Horizontal Alignment | شمارش Horizontal Alignment . |
Icon | Icon | شمارش Icon |
Image Button Style | Image Button Style | شمارش Image Button Style . |
Image Crop Type | Image Crop Type | شمارش Image Crop Type . |
Image Style | Image Style | شمارش Image Style . |
Input Type | Input Type | شمارش Input Type |
Load Indicator | Load Indicator | شمارش Load Indicator . |
On Close | On Close | شمارش On Close . |
Open As | Open As | شمارش Open As . |
Selection Input Type | Selection Input Type | Selection Input Type . |
Text Button Style | Text Button Style | شمارش Text Button Style . |
Update Draft Body Type | Update Draft Body Type | Update Draft Body Type . |
روش ها
مستندات دقیق
new Action Response Builder()
یک Action Response Builder
جدید ایجاد می کند.
بازگشت
Action Response Builder
- سازنده ActionResponse خالی.
new Action Status()
یک Action Status
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
بازگشت
Action Status
- یک ActionStatus خالی.
new Attachment()
new Authorization Action()
یک Authorization Action
جدید ایجاد می کند.
بازگشت
Authorization Action
- یک AuthorizationAction خالی.
new Authorization Exception()
یک Authorization Exception
جدید ایجاد می کند.
بازگشت
Authorization Exception
- یک استثنای مجوز خالی.
new Border Style()
new Button Set()
new Calendar Event Action Response Builder()
یک Calendar Event Action Response Builder
جدید ایجاد می کند.
بازگشت
Calendar Event Action Response Builder
— یک Calendar Event Action Response Builder
خالی.
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
یک Card With Id
ایجاد می کند. این برای ارسال کارت در پیام Google Chat استفاده می شود. شناسه کارت یک شناسه منحصر به فرد برای یک کارت در پیام هنگام ارسال چند کارت است.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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 With Id
- یک Card With Id
.
new Chat Action Response()
یک Chat Action Response
ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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 Response Builder
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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 Response Builder
- ChatResponseBuilder خالی.
new Chip()
new Chip List()
یک Chip List
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const chip = CardService.newChip(); // Finish building the text chip... const chipList = CardService.newChipList() .setLayout(CardService.ChipListLayout.WRAPPED) .addChip(chip);
بازگشت
Chip List
- یک ChipList خالی.
new Collapse Control()
یک Collapse Control
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
بازگشت
Collapse Control
- یک 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 Action Response Builder
جدید ایجاد می کند.
بازگشت
Compose Action Response Builder
- سازنده ComposeActionResponse خالی.
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
یک Dialog
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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);
بازگشت
new Dialog Action()
یک Dialog Action
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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 Action
- یک Dialog Action
خالی.
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()
یک Drive Items Selected Action Response Builder
جدید ایجاد می کند.
بازگشت
Drive Items Selected Action Response Builder
— یک Drive Items Selected Action Response Builder
.
new Editor File Scope Action Response Builder()
یک Editor File Scope Action Response Builder
ایجاد می کند.
بازگشت
Editor File Scope Action Response Builder
— یک Editor File Scope Action Response Builder
.
new Icon Image()
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
یک Link Preview
جدید ایجاد می کند.
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 Preview
- یک پیشنمایش لینک خالی.
new Material Icon()
یک Material Icon
جدید ایجاد می کند.
برای برنامههای 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 Icon
- یک MaterialIcon خالی.
new Notification()
new Overflow Menu()
یک Overflow Menu
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
بازگشت
Overflow Menu
- یک منوی سرریز خالی.
new Overflow Menu Item()
یک Overflow Menu Item
جدید ایجاد می کند.
فقط برای برنامههای گپ Google در دسترس است. برای افزونههای 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 Menu Item
- یک آیتم منوی سرریز خالی.
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
یک Suggestions Response Builder
جدید ایجاد می کند.
بازگشت
Suggestions Response Builder
- یک سازنده پیشنهادات پاسخ خالی.
new Text Button()
new Text Input()
new Text Paragraph()
new Time Picker()
new Universal Action Response Builder()
یک Universal Action Response Builder
جدید ایجاد می کند.
بازگشت
Universal Action Response Builder
- یک سازنده UniversalActionResponse خالی.
new Update Draft Action Response Builder()
یک Update Draft Action Response Builder
جدید ایجاد می کند.
بازگشت
Update Draft Action Response Builder
- یک UpdateDraftActionResponseBuilder خالی.
new Update Draft Bcc Recipients Action()
یک Update Draft Bcc Recipients Action
ایجاد می کند.
بازگشت
Update Draft Bcc Recipients Action
— یک UpdateDraftBccRecipientsAction خالی.
new Update Draft Body Action()
یک Update Draft Body Action
جدید ایجاد می کند.
بازگشت
Update Draft Body Action
- یک UpdateDraftBodyAction خالی.
new Update Draft Cc Recipients Action()
یک Update Draft Cc Recipients Action
ایجاد میکند.
بازگشت
Update Draft Cc Recipients Action
— یک بهروزرسانی خالی پیشنویسCcRecipientsAction.
new Update Draft Subject Action()
یک Update Draft Subject Action
جدید ایجاد میکند.
بازگشت
Update Draft Subject Action
- یک UpdateDraftSubjectAction خالی.
new Update Draft To Recipients Action()
یک Update Draft To Recipients Action
ایجاد می کند.
بازگشت
Update Draft To Recipients Action
- یک UpdateDraftToRecipientsAction خالی.
new Validation()
یک Validation
جدید ایجاد می کند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
بازگشت
Validation
- اعتبار سنجی خالی.