CardService امکان ایجاد کارتهای عمومی مورد استفاده در محصولات توسعهپذیر مختلف گوگل، مانند افزونههای 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(); }
نمونه برای کارت برنامه چت.
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();
خواص
روشها
مستندات دقیق
newActionResponseBuilder()
یک ActionResponseBuilder جدید ایجاد میکند.
بازگشت
ActionResponseBuilder — یک سازندهی ActionResponse خالی.
newActionStatus()
یک ActionStatus جدید ایجاد میکند.
فقط برای برنامههای Google Chat در دسترس است. برای افزونههای Google Workspace در دسترس نیست.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
بازگشت
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 خالی.
newCarousel()
یک Carousel ایجاد میکند.
const carousel = CardService.newCarousel() .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The first text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The second text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The third text paragraph in carousel')))
بازگشت
Carousel — یک چرخ و فلک خالی.
newCarouselCard()
یک CarouselCard جدید ایجاد میکند.
const carouselCard = CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('Text paragraph in carousel'));
بازگشت
CarouselCard - یک چیپ خالی.
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 خالی.
newChip()
newChipList()
یک ChipList جدید ایجاد میکند.
برای برنامههای چت گوگل موجود است. در پیشنمایش توسعهدهندگان برای افزونههای 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 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 — مجموعهای خالی از ستونها.
newCommonWidgetAction()
newComposeActionResponseBuilder()
یک ComposeActionResponseBuilder جدید ایجاد میکند.
بازگشت
ComposeActionResponseBuilder — یک سازندهی خالی ComposeActionResponse.
newCondition()
newDataSourceConfig()
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() { 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 - جداکننده.
newDriveDataSourceSpec()
newDriveItemsSelectedActionResponseBuilder()
یک DriveItemsSelectedActionResponseBuilder جدید ایجاد میکند.
بازگشت
DriveItemsSelectedActionResponseBuilder — یک DriveItemsSelectedActionResponseBuilder خالی.
newEditorFileScopeActionResponseBuilder()
یک EditorFileScopeActionResponseBuilder جدید ایجاد میکند.
بازگشت
EditorFileScopeActionResponseBuilder — یک EditorFileScopeActionResponseBuilder خالی.
newEventAction()
یک EventAction جدید ایجاد میکند که برای اعتبارسنجی سمت کلاینت استفاده میشود.
بازگشت
EventAction — یک EventAction خالی.
newExpressionData()
یک ExpressionData جدید ایجاد میکند که برای اعتبارسنجی سمت کلاینت استفاده میشود.
بازگشت
ExpressionData — یک ExpressionData خالی.
newExpressionDataAction()
یک ExpressionDataAction جدید ایجاد میکند که برای اعتبارسنجی سمت کلاینت استفاده میشود.
بازگشت
ExpressionDataAction — یک ExpressionDataAction خالی.
newExpressionDataCondition()
یک ExpressionDataCondition جدید ایجاد میکند که برای اعتبارسنجی سمت کلاینت استفاده میشود.
بازگشت
ExpressionDataCondition — یک ExpressionDataCondition خالی.
newHostAppDataSource()
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(); return 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 Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
بازگشت
OverflowMenu — یک منوی سرریز خالی.
newOverflowMenuItem()
یک OverflowMenuItem جدید ایجاد میکند.
برای برنامههای چت گوگل موجود است. در پیشنمایش توسعهدهندگان برای افزونههای 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 خالی.
newPlatformDataSource()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
یک SuggestionsResponseBuilder جدید ایجاد میکند.
بازگشت
SuggestionsResponseBuilder — یک سازندهی خالی SuggestionsResponse.
newTextButton()
newTextParagraph()
newTimePicker()
newTrigger()
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 خالی.
newUpdateVisibilityAction()
یک UpdateVisibilityAction جدید ایجاد میکند.
بازگشت
UpdateVisibilityAction — یک UpdateVisibilityAction خالی.
newValidation()
یک Validation جدید ایجاد میکند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
بازگشت
Validation — یک اعتبارسنجی خالی.