CardService предоставляет возможность создавать общие карты, используемые в различных продуктах расширения Google, таких как надстройки 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(); }
Образец карточки приложения 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 . |
ChipListLayout | ChipListLayout | Перечисление ChipListLayout . |
ComposedEmailType | ComposedEmailType | Перечисление ComposedEmailType . |
ContentType | ContentType | Перечисление ContentType . |
GridItemLayout | GridItemLayout | Перечисление GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | Перечисление HorizontalAlignment . |
Icon | Icon | Перечисление Icon . |
ImageButtonStyle | ImageButtonStyle | Перечисление ImageButtonStyle . |
ImageCropType | ImageCropType | Перечисление ImageCropType . |
ImageStyle | ImageStyle | Перечисление ImageStyle . |
InputType | InputType | Перечисление InputType . |
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
— пустое исключение AuthorizationException.
newBorderStyle()
newCalendarEventActionResponseBuilder()
Создает новый CalendarEventActionResponseBuilder
.
Возвращаться
CalendarEventActionResponseBuilder
— пустой CalendarEventActionResponseBuilder
.
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
Создает новый CardWithId
. Используется для отправки карточки в сообщении Google Chat. ID карты — уникальный идентификатор карты в сообщении при отправке нескольких карт.
Доступно только для приложений 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.
newChip()
newChipList()
Создает новый ChipList
.
Доступно только для приложений Google Chat. Недоступно для дополнений 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 Chat. Недоступно для дополнений 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
— пустой набор столбцов.
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() { 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
— Делитель.
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.
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 Chat. Недоступно для дополнений Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
Возвращаться
OverflowMenu
— пустое OverflowMenu.
newOverflowMenuItem()
Создает новый OverflowMenuItem
.
Доступно только для приложений 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'));
Возвращаться
OverflowMenuItem
— пустой OverflowMenuItem.
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
Создает новый объект SuggestionsResponseBuilder
.
Возвращаться
SuggestionsResponseBuilder
— пустой конструктор OffersResponse.
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
— пустая проверка.