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 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();
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای 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 در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
بازگشت
OverflowMenu
- یک منوی سرریز خالی.
newOverflowMenuItem()
یک OverflowMenuItem
جدید ایجاد می کند.
فقط برای برنامههای گپ 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'));
بازگشت
OverflowMenuItem
- یک OverflowMenuItem خالی.
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
یک SuggestionsResponseBuilder
جدید ایجاد می کند.
بازگشت
SuggestionsResponseBuilder
- سازنده SuggestionsResponse خالی.
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 خالی.
newValidation()
یک Validation
جدید ایجاد می کند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
بازگشت
Validation
- اعتبار سنجی خالی.