Usługa CardService umożliwia tworzenie ogólnych kart używanych w różnych usługach Google, takich jak dodatki Google Workspace.
Poniżej znajduje się przykładowa karta dodatków.
function createCard() { return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('CardTitle')) .build(); }
Możesz też zwrócić większą liczbę kart w ten sposób:
function createCards() { return [ CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), ]; }
Poniżej przedstawiamy, jak zdefiniować kartę z nagłówkiem, tekstem, obrazem i elementem menu:
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(); }
Przykład karty aplikacji 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();
Właściwości
Właściwość | Typ | Opis |
---|---|---|
BorderType | BorderType | Wyliczenie BorderType . |
ChipListLayout | ChipListLayout | Wyliczenie ChipListLayout . |
ComposedEmailType | ComposedEmailType | Wyliczenie ComposedEmailType . |
ContentType | ContentType | Wyliczenie ContentType . |
GridItemLayout | GridItemLayout | Wyliczenie GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | Wyliczenie HorizontalAlignment . |
Icon | Icon | Wyliczenie Icon . |
ImageButtonStyle | ImageButtonStyle | Wyliczenie ImageButtonStyle . |
ImageCropType | ImageCropType | Wyliczenie ImageCropType . |
ImageStyle | ImageStyle | Wyliczenie ImageStyle . |
InputType | InputType | Wyliczenie InputType . |
LoadIndicator | LoadIndicator | Wyliczenie LoadIndicator . |
OnClose | OnClose | Wyliczenie OnClose . |
OpenAs | OpenAs | Wyliczenie OpenAs . |
SelectionInputType | SelectionInputType | Wyliczenie SelectionInputType . |
TextButtonStyle | TextButtonStyle | Wyliczenie TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | Wyliczenie UpdateDraftBodyType . |
Metody
Szczegółowa dokumentacja
newActionResponseBuilder()
Tworzy nowy element typu ActionResponseBuilder
.
Powrót
ActionResponseBuilder
– pusty kreator ActionResponse.
newActionStatus()
Tworzy nowy element ActionStatus
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
Powrót
ActionStatus
– pusty stan działania.
newAttachment()
newAuthorizationAction()
Tworzy nowy element typu AuthorizationAction
.
Powrót
AuthorizationAction
– pusta wartość AuthorizationAction.
newAuthorizationException()
Tworzy nowy element typu AuthorizationException
.
Powrót
AuthorizationException
– pusty wyjątek AuthorizationException.
newBorderStyle()
newCalendarEventActionResponseBuilder()
Tworzy nowy element typu CalendarEventActionResponseBuilder
.
Powrót
CalendarEventActionResponseBuilder
– pusty element CalendarEventActionResponseBuilder
.
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
Tworzy nowy element typu CardWithId
. Służy on do wysyłania karty w wiadomości Google Chat. Identyfikator karty to unikalny identyfikator karty w wiadomości przesyłanej wielu kart.
Dostępne tylko w przypadku aplikacji Google Chat. Opcja niedostępna w przypadku dodatków do 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);
Powrót
CardWithId
– pusty element CardWithId
.
newChatActionResponse()
Tworzy nowy element typu ChatActionResponse
.
Dostępne tylko w aplikacjach Google Chat. Niedostępne w przypadku dodatków 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);
Powrót
ChatActionResponse
– puste pole ChatActionResponse
.
newChatResponseBuilder()
Tworzy nowy element typu ChatResponseBuilder
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków 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();
Powrót
ChatResponseBuilder
– pusty obiekt ChatResponseBuilder.
newChip()
newChipList()
Tworzy nowy element typu ChipList
.
Dostępne tylko w przypadku aplikacji Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
const chip = CardService.newChip(); // Finish building the text chip... const chipList = CardService.newChipList() .setLayout(CardService.ChipListLayout.WRAPPED) .addChip(chip);
Powrót
ChipList
– pusta lista elementów.
newCollapseControl()
Tworzy nowy element typu CollapseControl
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
Powrót
CollapseControl
– pusty element CollapseControl.
newColumn()
Tworzy nowy element typu Column
.
Dostępny w przypadku aplikacji Google Chat i dodatków do 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);
Powrót
Column
– pusta kolumna.
newColumns()
Tworzy nowy zbiór Columns
.
Dostępne dla aplikacji Google Chat i dodatków do 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);
Powrót
Columns
– pusty zestaw kolumn.
newComposeActionResponseBuilder()
Tworzy nowy element typu ComposeActionResponseBuilder
.
Powrót
ComposeActionResponseBuilder
– pusty kreator ComposeActionResponse.
newDatePicker()
newDateTimePicker()
newDecoratedText()
newDialog()
Tworzy nowy element typu Dialog
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków 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);
Powrót
newDialogAction()
Tworzy nowy element typu DialogAction
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków 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);
Powrót
DialogAction
– pusty element DialogAction
.
newDivider()
Tworzy nowy element typu Divider
. W tym przykładzie tworzymy prostą kartę z 2 akapitami rozdzielonymi separatorem.
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; }
Powrót
Divider
– separator.
newDriveItemsSelectedActionResponseBuilder()
Tworzy nowy element DriveItemsSelectedActionResponseBuilder
.
Powrót
DriveItemsSelectedActionResponseBuilder
– pusty element DriveItemsSelectedActionResponseBuilder
.
newEditorFileScopeActionResponseBuilder()
Tworzy nowy element typu EditorFileScopeActionResponseBuilder
.
Powrót
EditorFileScopeActionResponseBuilder
– puste pole EditorFileScopeActionResponseBuilder
.
newImageButton()
newImageComponent()
newImageCropStyle()
newLinkPreview()
Tworzy nowy element typu 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');
Powrót
LinkPreview
– pusty podgląd linku.
newMaterialIcon()
Tworzy nowy element typu MaterialIcon
.
Dostępne dla aplikacji Google Chat i dodatków do 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();
Powrót
MaterialIcon
– pusta ikona MaterialIcon.
newNotification()
newOverflowMenu()
Tworzy nowy element OverflowMenu
.
Dostępne tylko w przypadku aplikacji Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
Powrót
OverflowMenu
– puste rozszerzone menu.
newOverflowMenuItem()
Tworzy nowy element OverflowMenuItem
.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków 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'));
Powrót
OverflowMenuItem
– pusty element OverflowMenuItem.
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
Tworzy nowy element typu SuggestionsResponseBuilder
.
Powrót
SuggestionsResponseBuilder
– pusty kreator SuggestionsResponse.
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
Tworzy nowy element typu UniversalActionResponseBuilder
.
Powrót
UniversalActionResponseBuilder
– pusty kreator UniversalActionResponse.
newUpdateDraftActionResponseBuilder()
Tworzy nowy element UpdateDraftActionResponseBuilder
.
Powrót
UpdateDraftActionResponseBuilder
– pusty element UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()
tworzy nową firmę UpdateDraftBccRecipientsAction
;
Powrót
UpdateDraftBccRecipientsAction
– pusta akcja UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()
Tworzy nowy element typu UpdateDraftBodyAction
.
Powrót
UpdateDraftBodyAction
– pusta akcja UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()
Tworzy nowy element typu UpdateDraftCcRecipientsAction
.
Powrót
UpdateDraftCcRecipientsAction
– pusta akcja UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()
Tworzy nowy element typu UpdateDraftSubjectAction
.
Powrót
UpdateDraftSubjectAction
– pusta akcja UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()
Tworzy nowy element typu UpdateDraftToRecipientsAction
.
Powrót
UpdateDraftToRecipientsAction
— pusta akcja UpdateDraftToRecipientsAction.
newValidation()
Tworzy nowy element typu Validation
.
Dostępny w przypadku aplikacji Google Chat i dodatków do Google Workspace.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
Powrót
Validation
– pusta walidacja.