Usługa Card
Poniżej znajdziesz przykład karty dodatków.
function createCard() { return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle('CardTitle')) .build(); }
Możesz też zwrócić kilka kart w ten sposób:
function createCards() { return [ CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), ]; }
Poniżej pokazujemy, 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ładowa karta aplikacji do obsługi czatu.
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
Metody
Szczegółowa dokumentacja
new Action Response Builder()
Tworzy nowy element Action.
Powrót
Action – pusty konstruktor ActionResponse.
new Action Status()
Tworzy nowy element Action.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków do Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
Powrót
Action – pusty stan ActionStatus.
new Attachment()
new Authorization Action()
Tworzy nowy element Authorization.
Powrót
Authorization – pusta wartość AuthorizationAction.
new Authorization Exception()
Tworzy nowy element Authorization.
Powrót
Authorization – pusty wyjątek AuthorizationException.
new Border Style()
new Calendar Event Action Response Builder()
Tworzy nowy element Calendar.
Powrót
Calendar – pusty Calendar.
new Card Action()
new Card Builder()
new Card Header()
new Card Section()
new Card With Id()
Tworzy nowy element Card. Służy do wysyłania karty w wiadomości Google Chat. Identyfikator karty
to unikalny identyfikator karty w wiadomości podczas wysyłania wielu kart.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne 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
Card – pusty Card.
new Carousel()
Tworzy Carousel.
const carousel = CardService.newCarousel() .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The first text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The second text paragraph in carousel'))) .addCarouselCard(CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('The third text paragraph in carousel')))
Powrót
Carousel – pusta karuzela.
new Carousel Card()
Tworzy nowy element Carousel.
const carouselCard = CardService.newCarouselCard().addWidget( CardService.newTextParagraph().setText('Text paragraph in carousel'));
Powrót
Carousel – pusty element.
new Chat Action Response()
Tworzy nowy element Chat.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków do 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 Chat.
new Chat Response Builder()
Tworzy nowy element Chat.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne 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); const chatResponse = CardService.newChatResponseBuilder().addCardsV2(cardWithId).build();
Powrót
Chat – pusty obiekt ChatResponseBuilder.
new Chip()
Tworzy nowy element Chip.
Dostępne w przypadku aplikacji Google Chat. W wersji przedpremierowej dla programistów dodatków do Google Workspace.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Powrót
Chip – pusty element.
new Chip List()
Tworzy nowy element Chip.
Dostępne w przypadku aplikacji Google Chat. W wersji przedpremierowej dla programistó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 ChipList.
new Collapse Control()
Tworzy nowy element Collapse.
Dostępne w przypadku aplikacji Google Chat. W wersji przedpremierowej dla programistó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 Column.
Dostępne 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.
new Columns()
Tworzy nowy zestaw Columns.
Dostępne w przypadku 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 Common Widget Action()
new Compose Action Response Builder()
Tworzy nowy element Compose.
Powrót
Compose – pusty konstruktor ComposeActionResponse.
new Condition()
new Data Source Config()
new Date Picker()
new Date Time Picker()
new Decorated Text()
new Dialog()
Tworzy nowy element Dialog.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków do 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 Dialog.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków do 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 Dialog.
new Divider()
Tworzy nowy element Divider. Poniższy przykład tworzy prostą kartę z 2 akapitami oddzielonymi 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 Data Source Spec()
new Drive Items Selected Action Response Builder()
Tworzy nowy element Drive.
Powrót
Drive – pusty Drive.
new Editor File Scope Action Response Builder()
Tworzy nowy element Editor.
Powrót
Editor – pusty Editor.
new Event Action()
Tworzy nowy obiekt Event używany do weryfikacji po stronie klienta.
Powrót
Event – pusty Event.
new Expression Data()
Tworzy nowy obiekt Expression używany do weryfikacji po stronie klienta.
Powrót
Expression – pusty Expression.
new Expression Data Action()
Tworzy nowy obiekt Expression używany do weryfikacji po stronie klienta.
Powrót
Expression – pusty Expression.
new Expression Data Condition()
Tworzy nowy obiekt Expression używany do weryfikacji po stronie klienta.
Powrót
new Host App Data Source()
new Image Button()
new Image Component()
new Image Crop Style()
new Link Preview()
Tworzy nowy element 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 obiekt LinkPreview.
new Material Icon()
Tworzy nowy element Material.
Dostępne w przypadku 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 Overflow.
Dostępne w przypadku aplikacji Google Chat. W wersji przedpremierowej dla programistó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 Overflow.
Dostępne w przypadku aplikacji Google Chat. W wersji przedpremierowej dla programistó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 OverflowMenuItem.
new Platform Data Source()
new Selection Input()
new Suggestions()
new Suggestions Response Builder()
Tworzy nowy element Suggestions.
Powrót
Suggestions – pusty konstruktor SuggestionsResponse.
new Text Button()
new Text Paragraph()
new Time Picker()
new Trigger()
new Universal Action Response Builder()
Tworzy nowy element Universal.
Powrót
Universal – pusty konstruktor UniversalActionResponse.
new Update Draft Action Response Builder()
Tworzy nowy element Update.
Powrót
Update – pusty obiekt UpdateDraftActionResponseBuilder.
new Update Draft Bcc Recipients Action()
tworzy nowy element Update;
Powrót
Update – pusta wartość UpdateDraftBccRecipientsAction.
new Update Draft Body Action()
Tworzy nowy element Update.
Powrót
Update – pusta wartość UpdateDraftBodyAction.
new Update Draft Cc Recipients Action()
Tworzy nowy element Update.
Powrót
Update – Empty UpdateDraftCcRecipientsAction.
new Update Draft Subject Action()
Tworzy nowy element Update.
Powrót
Update – pusta wartość UpdateDraftSubjectAction.
new Update Draft To Recipients Action()
Tworzy nowy element Update.
Powrót
Update – pusty obiekt UpdateDraftToRecipientsAction.
new Update Visibility Action()
Tworzy nowy element Update.
Powrót
new Validation()
Tworzy nowy element Validation.
Dostępne 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 weryfikacja.