Class CardService

CardService

توفّر 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();

أماكن إقامة

الموقعالنوعالوصف
BorderTypeBorderTypeالتعداد BorderType.
ComposedEmailTypeComposedEmailTypeالتعداد ComposedEmailType.
ContentTypeContentTypeالتعداد ContentType.
GridItemLayoutGridItemLayoutالتعداد GridItemLayout.
HorizontalAlignmentHorizontalAlignmentالتعداد HorizontalAlignment.
IconIconالتعداد Icon.
ImageCropTypeImageCropTypeالتعداد ImageCropType.
ImageStyleImageStyleالتعداد ImageStyle.
LoadIndicatorLoadIndicatorالتعداد LoadIndicator.
OnCloseOnCloseالتعداد OnClose.
OpenAsOpenAsالتعداد OpenAs.
SelectionInputTypeSelectionInputTypeالتعداد SelectionInputType.
TextButtonStyleTextButtonStyleالتعداد TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeالتعداد UpdateDraftBodyType.

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
newAction()Actionتنشئ Action جديدة.
newActionResponseBuilder()ActionResponseBuilderتنشئ ActionResponseBuilder جديدة.
newActionStatus()ActionStatusتنشئ ActionStatus جديدة.
newAttachment()Attachmentتنشئ Attachment جديدة.
newAuthorizationAction()AuthorizationActionتنشئ AuthorizationAction جديدة.
newAuthorizationException()AuthorizationExceptionتنشئ AuthorizationException جديدة.
newBorderStyle()BorderStyleتنشئ BorderStyle جديدة.
newButtonSet()ButtonSetتنشئ ButtonSet جديدة.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderتنشئ CalendarEventActionResponseBuilder جديدة.
newCardAction()CardActionتنشئ CardAction جديدة.
newCardBuilder()CardBuilderتنشئ CardBuilder جديدة.
newCardHeader()CardHeaderتنشئ CardHeader جديدة.
newCardSection()CardSectionتنشئ CardSection جديدة.
newCardWithId()CardWithIdتنشئ CardWithId جديدة.
newChatActionResponse()ChatActionResponseتنشئ ChatActionResponse جديدة.
newChatResponseBuilder()ChatResponseBuilderتنشئ ChatResponseBuilder جديدة.
newColumn()Columnتنشئ Column جديدة.
newColumns()Columnsينشئ مجموعة جديدة من Columns.
newComposeActionResponseBuilder()ComposeActionResponseBuilderتنشئ ComposeActionResponseBuilder جديدة.
newDatePicker()DatePickerتنشئ DatePicker جديدة.
newDateTimePicker()DateTimePickerتنشئ DateTimePicker جديدة.
newDecoratedText()DecoratedTextتنشئ DecoratedText جديدة.
newDialog()Dialogتنشئ Dialog جديدة.
newDialogAction()DialogActionتنشئ DialogAction جديدة.
newDivider()Dividerتنشئ Divider جديدة.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderتنشئ DriveItemsSelectedActionResponseBuilder جديدة.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderتنشئ EditorFileScopeActionResponseBuilder جديدة.
newFixedFooter()FixedFooterتنشئ FixedFooter جديدة.
newGrid()Gridتنشئ Grid جديدة.
newGridItem()GridItemتنشئ GridItem جديدة.
newIconImage()IconImageتنشئ IconImage جديدة.
newImage()Imageتنشئ Image جديدة.
newImageButton()ImageButtonتنشئ ImageButton جديدة.
newImageComponent()ImageComponentتنشئ ImageComponent جديدة.
newImageCropStyle()ImageCropStyleتنشئ ImageCropStyle جديدة.
newKeyValue()KeyValueتنشئ KeyValue جديدة.
newLinkPreview()LinkPreviewتنشئ LinkPreview جديدة.
newNavigation()Navigationتنشئ Navigation جديدة.
newNotification()Notificationتنشئ Notification جديدة.
newOpenLink()OpenLinkتنشئ OpenLink جديدة.
newSelectionInput()SelectionInputتنشئ SelectionInput جديدة.
newSuggestions()Suggestionsتنشئ Suggestions جديدة.
newSuggestionsResponseBuilder()SuggestionsResponseBuilderتنشئ SuggestionsResponseBuilder جديدة.
newSwitch()Switchتنشئ Switch جديدة.
newTextButton()TextButtonتنشئ TextButton جديدة.
newTextInput()TextInputتنشئ TextInput جديدة.
newTextParagraph()TextParagraphتنشئ TextParagraph جديدة.
newTimePicker()TimePickerتنشئ TimePicker جديدة.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderتنشئ UniversalActionResponseBuilder جديدة.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderتنشئ UpdateDraftActionResponseBuilder جديدة.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionتنشئ UpdateDraftBccRecipientsAction جديدة.
newUpdateDraftBodyAction()UpdateDraftBodyActionتنشئ UpdateDraftBodyAction جديدة.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionتنشئ UpdateDraftCcRecipientsAction جديدة.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionتنشئ UpdateDraftSubjectAction جديدة.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionتنشئ UpdateDraftToRecipientsAction جديدة.

الوثائق التفصيلية

newAction()

تنشئ Action جديدة.

استرجاع الكرة

Action - إجراء فارغ.

newActionResponseBuilder()

تنشئ ActionResponseBuilder جديدة.

استرجاع الكرة

ActionResponseBuilder - أداة إنشاء ActionResponse فارغة.

newActionStatus()

تنشئ ActionStatus جديدة.

هذه الميزة متاحة فقط لتطبيقات Google Chat. غير متاحة لإضافات Google Workspace. 

const actionStatus = CardService.newActionStatus()
    .setStatusCode(CardService.Status.OK)
    .setUserFacingMessage('Success');

استرجاع الكرة

ActionStatus: حالة ActionStatus فارغة

newAttachment()

تنشئ Attachment جديدة.

استرجاع الكرة

Attachment: مرفق فارغ.

newAuthorizationAction()

تنشئ AuthorizationAction جديدة.

استرجاع الكرة

AuthorizationAction: عنصر PermissionAction فارغ.

newAuthorizationException()

تنشئ AuthorizationException جديدة.

استرجاع الكرة

AuthorizationException: حقل PermissionException فارغًا

newBorderStyle()

تنشئ BorderStyle جديدة.

استرجاع الكرة

BorderStyle: نمط BorderStyle فارغ

newButtonSet()

تنشئ ButtonSet جديدة.

استرجاع الكرة

ButtonSet — مجموعة أزرار فارغة

newCalendarEventActionResponseBuilder()

تنشئ CalendarEventActionResponseBuilder جديدة.

استرجاع الكرة

CalendarEventActionResponseBuilder: حقل CalendarEventActionResponseBuilder فارغ.

newCardAction()

تنشئ CardAction جديدة.

استرجاع الكرة

CardAction - CardAction فارغ.

newCardBuilder()

تنشئ CardBuilder جديدة.

استرجاع الكرة

CardBuilder - أداة إنشاء بطاقات فارغة

newCardHeader()

تنشئ CardHeader جديدة.

استرجاع الكرة

CardHeader - عنوان CardHeader فارغ.

newCardSection()

تنشئ CardSection جديدة.

استرجاع الكرة

CardSection - قسم بطاقة فارغ.

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()

تنشئ DatePicker جديدة.

استرجاع الكرة

DatePicker: أداة اختيار تاريخ فارغة

newDateTimePicker()

تنشئ DateTimePicker جديدة.

استرجاع الكرة

DateTimePicker - منتقي التاريخ والوقت فارغ.

newDecoratedText()

تنشئ DecoratedText جديدة.

استرجاع الكرة

DecoratedText — نص مزخرف فارغ.

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);

استرجاع الكرة

Dialog: حقل Dialog فارغ.

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()

newEditorFileScopeActionResponseBuilder()

newFixedFooter()

تنشئ FixedFooter جديدة.

استرجاع الكرة

FixedFooter: تذييل ثابت فارغ.

newGrid()

تنشئ Grid جديدة.

استرجاع الكرة

Grid: شبكة فارغة

newGridItem()

تنشئ GridItem جديدة.

استرجاع الكرة

GridItem: عنصر شبكة فارغ

newIconImage()

تنشئ IconImage جديدة.

استرجاع الكرة

IconImage - صورة رمز فارغة

newImage()

تنشئ Image جديدة.

استرجاع الكرة

Image - صورة فارغة

newImageButton()

تنشئ ImageButton جديدة.

استرجاع الكرة

ImageButton — زر صورة فارغ

newImageComponent()

تنشئ ImageComponent جديدة.

استرجاع الكرة

ImageComponent: عنصر ImageComponent فارغ.

newImageCropStyle()

تنشئ ImageCropStyle جديدة.

استرجاع الكرة

ImageCropStyle: عنصر ImageCropStyle فارغ.

newKeyValue()

تنشئ KeyValue جديدة.

استرجاع الكرة

KeyValue: قيمة KeyValue فارغة.

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 فارغة.

newNavigation()

تنشئ Navigation جديدة.

استرجاع الكرة

Navigation - شريط تنقّل فارغ.

newNotification()

تنشئ Notification جديدة.

استرجاع الكرة

Notification - إشعار فارغ.

تنشئ OpenLink جديدة.

استرجاع الكرة

OpenLink — رابط OpenLink فارغ.

newSelectionInput()

تنشئ SelectionInput جديدة.

استرجاع الكرة

SelectionInput: إدخال SelectInput فارغ.

newSuggestions()

تنشئ Suggestions جديدة.

استرجاع الكرة

Suggestions: اقتراحات فارغة

newSuggestionsResponseBuilder()

تنشئ SuggestionsResponseBuilder جديدة.

استرجاع الكرة

SuggestionsResponseBuilder: أداة إنشاء الاقتراحات فارغة.

newSwitch()

تنشئ Switch جديدة.

استرجاع الكرة

Switch - مفتاح تبديل فارغ.

newTextButton()

تنشئ TextButton جديدة.

استرجاع الكرة

TextButton - زر نصي فارغ

newTextInput()

تنشئ TextInput جديدة.

استرجاع الكرة

TextInput: إدخال نصي فارغ.

newTextParagraph()

تنشئ TextParagraph جديدة.

استرجاع الكرة

TextParagraph: فقرة نصية فارغة

newTimePicker()

تنشئ TimePicker جديدة.

استرجاع الكرة

TimePicker: أداة اختيار وقت فارغة

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 فارغ.