Usługa Card
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 |
---|---|---|
Border | Border | Wyliczenie Border . |
Chip | Chip | Wyliczenie Chip . |
Composed | Composed | Wyliczenie Composed . |
Content | Content | Wyliczenie Content . |
Grid | Grid | Wyliczenie Grid . |
Horizontal | Horizontal | Wyliczenie Horizontal . |
Icon | Icon | Wyliczenie Icon . |
Image | Image | Wyliczenie Image . |
Image | Image | Wyliczenie Image . |
Image | Image | Wyliczenie Image . |
Input | Input | Wyliczenie Input . |
Load | Load | Wyliczenie Load . |
On | On | Wyliczenie On . |
Open | Open | Wyliczenie Open . |
Selection | Selection | Wyliczenie Selection . |
Text | Text | Wyliczenie Text . |
Update | Update | Wyliczenie Update . |
Metody
Szczegółowa dokumentacja
new Action Response Builder()
Tworzy nowy element typu Action
.
Powrót
Action
– pusty kreator ActionResponse.
new Action Status()
Tworzy nowy element typu Action
.
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
Action
– pusty stan działania.
new Attachment()
new Authorization Action()
Tworzy nowy element typu Authorization
.
Powrót
Authorization
– pusta wartość AuthorizationAction.
new Authorization Exception()
Tworzy nowy element typu Authorization
.
Powrót
Authorization
– pusta klasa AuthorizationException.
new Border Style()
new Calendar Event Action Response Builder()
Tworzy nowy element typu Calendar
.
Powrót
Calendar
– pusty element Calendar
.
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
Tworzy nowy element typu Card
. Służy on do wysyłania karty w wiadomości Google Chat. card ID (identyfikator karty) to unikalny identyfikator karty w wiadomości, gdy wysyłasz wiele kart.
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);
Powrót
Card
– pusty element Card
.
new Chat Action Response()
Tworzy nowy element typu Chat
.
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); const chatActionResponse = CardService.newChatActionResponse() .setResponseType(CardService.ResponseType.DIALOG) .setDialogAction(dialogAction);
Powrót
Chat
– pusty element Chat
.
new Chat Response Builder()
Tworzy nowy element typu Chat
.
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
Chat
– pusty obiekt ChatResponseBuilder.
new Chip()
new Chip List()
Tworzy nowy element typu Chip
.
Dostępne w przypadku aplikacji Google Chat. W wersji dla deweloperów 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
Chip
– pusta lista elementów.
new Collapse Control()
Tworzy nowy element typu Collapse
.
Dostępne w przypadku aplikacji Google Chat. W wersji dla deweloperów dodatków do Google Workspace.
const collapseControl = CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.START) .setExpandButton(CardService.newTextButton().setText('Expand')) .setCollapseButton(CardService.newTextButton().setText('Collapse'));
Powrót
Collapse
– pusty element CollapseControl.
new Column()
Tworzy nowy element typu Column
.
Dostępne dla 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.
new Columns()
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(firstColumn) .addColumn(secondColumn) .setWrapStyle(CardService.WrapStyle.WRAP);
Powrót
Columns
– pusty zestaw kolumn.
new Compose Action Response Builder()
Tworzy nowy element typu Compose
.
Powrót
Compose
– pusty konstruktor ComposeActionResponse.
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
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
new Dialog Action()
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(); const dialog = CardService.newDialog().setBody(card); const dialogAction = CardService.newDialogAction().setDialog(dialog);
Powrót
Dialog
– pusty element Dialog
.
new Divider()
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.
new Drive Items Selected Action Response Builder()
Tworzy nowy element typu Drive
.
Powrót
Drive
– pusty element Drive
.
new Editor File Scope Action Response Builder()
Tworzy nowy element typu Editor
.
Powrót
Editor
– pusty element Editor
.
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
Tworzy nowy element typu Link
.
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
Link
– pusty LinkPreview.
new Material Icon()
Tworzy nowy element typu Material
.
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
Material
– pusta ikona MaterialIcon.
new Notification()
new Overflow Menu()
Tworzy nowy element typu Overflow
.
Dostępne w przypadku aplikacji Google Chat. W wersji dla deweloperów dodatków do Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem(); // Finish building the overflow menu item... const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem);
Powrót
Overflow
– puste rozszerzone menu.
new Overflow Menu Item()
Tworzy nowy element typu Overflow
.
Dostępne w przypadku aplikacji Google Chat. W wersji dla deweloperów dodatków do 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
Overflow
– pusty element menu OverflowMenuItem.
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
Tworzy nowy element typu Suggestions
.
Powrót
Suggestions
– pusty kreator SuggestionsResponse.
new Text Button()
new Text Paragraph()
new Time Picker()
new Universal Action Response Builder()
Tworzy nowy element typu Universal
.
Powrót
Universal
– pusty kreator UniversalActionResponse.
new Update Draft Action Response Builder()
Tworzy nowy element typu Update
.
Powrót
Update
– pusty obiekt UpdateDraftActionResponseBuilder.
new Update Draft Bcc Recipients Action()
tworzy nową firmę Update
;
Powrót
Update
– pusta akcja UpdateDraftBccRecipientsAction.
new Update Draft Body Action()
Tworzy nowy element typu Update
.
Powrót
Update
– pusta akcja UpdateDraftBodyAction.
new Update Draft Cc Recipients Action()
Tworzy nowy element typu Update
.
Powrót
Update
– pusta akcja UpdateDraftCcRecipientsAction.
new Update Draft Subject Action()
Tworzy nowy element typu Update
.
Powrót
Update
– pusta akcja UpdateDraftSubjectAction.
new Update Draft To Recipients Action()
Tworzy nowy element typu Update
.
Powrót
Update
— pusta akcja UpdateDraftToRecipientsAction.
new Validation()
Tworzy nowy element typu Validation
.
Dostępne dla aplikacji Google Chat i dodatków do Google Workspace.
const validation = CardService.newValidation().setCharacterLimit(5).setInputType( CardService.InputType.EMAIL);
Powrót
Validation
– pusta walidacja.