توفّر CardService إمكانية إنشاء بطاقات عامة يتمّ استخدامها في مختلف منتجات Google القابلة للتوسُّع، مثل إضافات Google Workspace.
في ما يلي نموذج لبطاقة الإضافات.
return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle("CardTitle")) .build();
أو يمكنك إرجاع عدة بطاقات كما يلي:
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 . |
ComposedEmailType | ComposedEmailType | التعداد ComposedEmailType . |
ContentType | ContentType | التعداد ContentType . |
GridItemLayout | GridItemLayout | التعداد GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | التعداد HorizontalAlignment . |
Icon | Icon | التعداد Icon . |
ImageCropType | ImageCropType | التعداد ImageCropType . |
ImageStyle | ImageStyle | التعداد ImageStyle . |
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 Chat. غير متاحة لإضافات Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
استرجاع الكرة
ActionStatus
: حالة ActionStatus فارغة
newAttachment()
newAuthorizationAction()
newAuthorizationException()
تنشئ AuthorizationException
جديدة.
استرجاع الكرة
AuthorizationException
: حقل PermissionException فارغًا
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
فارغ.
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 فارغ.
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(column) .addColumn(secondColumn) .setWrapStyle(CardService.WrapStyle.WRAP);
استرجاع الكرة
Columns
— مجموعة فارغة من الأعمدة.
newComposeActionResponseBuilder()
تنشئ ComposeActionResponseBuilder
جديدة.
استرجاع الكرة
ComposeActionResponseBuilder
: أداة إنشاء 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
جديدة. ينشئ النموذج التالي بطاقة بسيطة بها فقرتين مفصولتين بمقسّم.
function buildCard() { let cardSection1TextParagraph1 = CardService.newTextParagraph() .setText('Hello world!'); let cardSection1Divider1 = CardService.newDivider(); let cardSection1TextParagraph2 = CardService.newTextParagraph() .setText('Hello world!'); let cardSection1 = CardService.newCardSection() .addWidget(cardSection1TextParagraph1) .addWidget(cardSection1Divider1) .addWidget(cardSection1TextParagraph2); let 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 فارغة.
newNotification()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
تنشئ SuggestionsResponseBuilder
جديدة.
استرجاع الكرة
SuggestionsResponseBuilder
: أداة إنشاء الاقتراحات فارغة.
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
- عملية تحقّق فارغة.