توفّر خدمة Card
في ما يلي نموذج لبطاقة إضافات.
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();
الخصائص
الطُرق
مستندات تفصيلية
new Action Response Builder()
تنشئ هذه الدالة Action جديدة.
الإرجاع
Action: أداة إنشاء ActionResponse فارغة.
new Action Status()
تنشئ هذه الدالة Action جديدة.
لا تتوفّر هذه الميزة إلا لتطبيقات Google Chat. لا يتوفّر هذا الخيار لإضافات Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
الإرجاع
Action: تمثّل هذه السمة قيمة فارغة لـ ActionStatus.
new Attachment()
new Authorization Action()
تنشئ هذه الدالة Authorization جديدة.
الإرجاع
Authorization: تمثّل هذه السمة قيمة فارغة من نوع AuthorizationAction.
new Authorization Exception()
تنشئ هذه الدالة Authorization جديدة.
الإرجاع
Authorization — An empty AuthorizationException.
new Border Style()
new Calendar Event Action Response Builder()
تنشئ هذه الدالة Calendar جديدة.
الإرجاع
Calendar: Calendar فارغ
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
تنشئ هذه الدالة Card جديدة. يُستخدَم هذا الحقل لإرسال بطاقة في رسالة 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);
الإرجاع
Card: Card فارغ
new Carousel()
تنشئ هذه الدالة 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: لوحة عرض دوّارة فارغة
new Carousel Card()
تنشئ هذه الدالة Carousel جديدة.
const carouselCard = CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('Text paragraph in carousel'));
الإرجاع
Carousel: شريحة فارغة
new Chat Action Response()
تنشئ هذه الدالة Chat جديدة.
لا تتوفّر هذه الميزة إلا لتطبيقات 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);
الإرجاع
new Chat Response Builder()
تنشئ هذه الدالة 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); const chatResponse = CardService.newChatResponseBuilder().addCardsV2(cardWithId).build();
الإرجاع
Chat: يمثّل هذا الرمز ChatResponseBuilder فارغًا.
new Chip()
new Chip List()
تنشئ هذه الدالة Chip جديدة.
متاحة لتطبيقات Google Chat. في الإصدار التجريبي من إضافات Google Workspace
const chip = CardService.newChip(); // Finish building the text chip... const chipList = CardService.newChipList() .setLayout(CardService.ChipListLayout.WRAPPED) .addChip(chip);
الإرجاع
Chip: تمثّل ChipList فارغة.
new Collapse Control()
تنشئ هذه الدالة Collapse جديدة.
متاحة لتطبيقات Google Chat. في الإصدار التجريبي من إضافات Google Workspace
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
الإرجاع
Collapse: عنصر 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 جديدة.
الإرجاع
Compose: أداة إنشاء ComposeActionResponse فارغة.
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
تنشئ هذه الدالة 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);
الإرجاع
new Dialog Action()
تنشئ هذه الدالة Dialog جديدة.
لا تتوفّر هذه الميزة إلا لتطبيقات 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);
الإرجاع
Dialog: Dialog فارغ
new Divider()
تنشئ هذه الدالة 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: فاصل
new Drive Items Selected Action Response Builder()
تنشئ هذه الدالة Drive جديدة.
الإرجاع
Drive: Drive فارغ
new Editor File Scope Action Response Builder()
تنشئ هذه الدالة Editor جديدة.
الإرجاع
Editor: Editor فارغ
new Host App Data Source()
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
تنشئ هذه الدالة Link جديدة.
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: تمثّل LinkPreview فارغًا.
new Material Icon()
تنشئ هذه الدالة Material جديدة.
متاحة لتطبيقات 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: يمثّل MaterialIcon فارغًا.
new Notification()
new Overflow Menu()
تنشئ هذه الدالة Overflow جديدة.
متاحة لتطبيقات Google Chat. في الإصدار التجريبي من إضافات Google Workspace
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
الإرجاع
Overflow: قائمة OverflowMenu فارغة
new Overflow Menu Item()
تنشئ هذه الدالة Overflow جديدة.
متاحة لتطبيقات 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'));
الإرجاع
Overflow: OverflowMenuItem فارغ
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
تنشئ هذه الدالة Suggestions جديدة.
الإرجاع
Suggestions: أداة إنشاء SuggestionsResponse فارغة.
new Text Button()
new Text Paragraph()
new Time Picker()
new Universal Action Response Builder()
تنشئ هذه الدالة Universal جديدة.
الإرجاع
Universal: أداة إنشاء UniversalActionResponse فارغة.
new Update Draft Action Response Builder()
تنشئ هذه الدالة Update جديدة.
الإرجاع
Update: يمثّل UpdateDraftActionResponseBuilder فارغًا.
new Update Draft Bcc Recipients Action()
تُنشئ هذه السمة Update جديدًا.
الإرجاع
Update: تمثّل هذه السمة إجراء UpdateDraftBccRecipientsAction فارغًا.
new Update Draft Body Action()
تنشئ هذه الدالة Update جديدة.
الإرجاع
Update: تمثّل UpdateDraftBodyAction فارغًا.
new Update Draft Cc Recipients Action()
تنشئ هذه الدالة Update جديدة.
الإرجاع
Update: Empty UpdateDraftCcRecipientsAction
new Update Draft Subject Action()
تنشئ هذه الدالة Update جديدة.
الإرجاع
Update: تمثّل هذه السمة UpdateDraftSubjectAction فارغة.
new Update Draft To Recipients Action()
تنشئ هذه الدالة Update جديدة.
الإرجاع
Update: تمثّل هذه السمة UpdateDraftToRecipientsAction فارغة.
new Validation()
تنشئ هذه الدالة Validation جديدة.
متاحة لتطبيقات Google Chat وإضافات Google Workspace.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
الإرجاع
Validation: عملية تحقّق فارغة.