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

תכונות

מאפיין (property)סוגתיאור
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 – השדה AuthorizationAction ריק.

newAuthorizationException()

ייווצר AuthorizationException חדש.

החזרות

AuthorizationException – חריגת הרשאה ריקה.

newBorderStyle()

ייווצר BorderStyle חדש.

החזרות

BorderStyle – סגנון BorderStyle ריק.

newButtonSet()

ייווצר ButtonSet חדש.

החזרות

ButtonSet – השדה 'הגדרת לחצן' ריק.

newCalendarEventActionResponseBuilder()

newCardAction()

ייווצר CardAction חדש.

החזרות

CardAction – CardAction ריק.

newCardBuilder()

ייווצר CardBuilder חדש.

החזרות

CardBuilder – בונה הכרטיסים ריק.

newCardHeader()

ייווצר 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 — השדה DatePicker ריק.

newDateTimePicker()

ייווצר DateTimePicker חדש.

החזרות

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 — כותרת קבועה (FixFooter) ריקה.

newGrid()

ייווצר Grid חדש.

החזרות

Grid – רשת ריקה.

newGridItem()

ייווצר GridItem חדש.

החזרות

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 – תצוגה מקדימה ריקה של קישור.

newNavigation()

ייווצר Navigation חדש.

החזרות

Navigation - ניווט ריק.

newNotification()

ייווצר Notification חדש.

החזרות

Notification – התראה ריקה.

ייווצר OpenLink חדש.

החזרות

OpenLink — OpenLink ריק.

newSelectionInput()

ייווצר SelectionInput חדש.

החזרות

SelectionInput – קלט בחירה ריק.

newSuggestions()

ייווצר Suggestions חדש.

החזרות

Suggestions – הצעות ריקות.

newSuggestionsResponseBuilder()

ייווצר SuggestionsResponseBuilder חדש.

החזרות

SuggestionsResponseBuilder - כלי ריק לתגובת הצעות.

newSwitch()

ייווצר Switch חדש.

החזרות

Switch – מתג ריק.

newTextButton()

ייווצר TextButton חדש.

החזרות

TextButton - TextButton ריק.

newTextInput()

ייווצר TextInput חדש.

החזרות

TextInput – קלט טקסט ריק.

newTextParagraph()

ייווצר TextParagraph חדש.

החזרות

TextParagraph - פסקה עם טקסט ריק.

newTimePicker()

ייווצר TimePicker חדש.

החזרות

TimePicker — TimePicker ריק.

newUniversalActionResponseBuilder()

ייווצר UniversalActionResponseBuilder חדש.

החזרות

UniversalActionResponseBuilder – כלי לבניית UniversalActionResponse ריק.

newUpdateDraftActionResponseBuilder()

ייווצר UpdateDraftActionResponseBuilder חדש.

החזרות

UpdateDraftActionResponseBuilder — קובץ UpdateUploadActionResponseBuilder ריק.

newUpdateDraftBccRecipientsAction()

ייווצר UpdateDraftBccRecipientsAction חדש;

החזרות

UpdateDraftBccRecipientsAction — השדה UpdateUploadBccRecipientsAction ריק.

newUpdateDraftBodyAction()

ייווצר UpdateDraftBodyAction חדש.

החזרות

UpdateDraftBodyAction – השדה UpdateUploadBodyAction ריק.

newUpdateDraftCcRecipientsAction()

ייווצר UpdateDraftCcRecipientsAction חדש.

החזרות

UpdateDraftCcRecipientsAction — השדה UpdateUploadCcRecipientsAction ריק.

newUpdateDraftSubjectAction()

ייווצר UpdateDraftSubjectAction חדש.

החזרות

UpdateDraftSubjectAction – השדה UpdateUploadSubjectAction ריק.

newUpdateDraftToRecipientsAction()

ייווצר UpdateDraftToRecipientsAction חדש.

החזרות

UpdateDraftToRecipientsAction — השדה UpdateUploadToRecipientsAction ריק.