CardService consente di creare carte generiche utilizzate su diverse piattaforme Google prodotti di estensibilità come i componenti aggiuntivi di Google Workspace.
Di seguito è riportato un esempio di scheda dei componenti aggiuntivi.
return CardService.newCardBuilder() .setHeader(CardService.newCardHeader().setTitle("CardTitle")) .build();
In alternativa, puoi restituire più carte, ad esempio:
return [ CardService.newCardBuilder().build(), CardService.newCardBuilder().build(), CardService.newCardBuilder().build() ]
Di seguito viene illustrato come definire una scheda con un'intestazione, del testo, un'immagine e una voce di 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(); }
Esempio di una scheda App di 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();
Proprietà
Proprietà | Tipo | Descrizione |
---|---|---|
BorderType | BorderType | L'enumerazione BorderType . |
ComposedEmailType | ComposedEmailType | L'enumerazione ComposedEmailType . |
ContentType | ContentType | L'enumerazione ContentType . |
GridItemLayout | GridItemLayout | L'enumerazione GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | L'enumerazione HorizontalAlignment . |
Icon | Icon | L'enumerazione Icon . |
ImageCropType | ImageCropType | L'enumerazione ImageCropType . |
ImageStyle | ImageStyle | L'enumerazione ImageStyle . |
LoadIndicator | LoadIndicator | L'enumerazione LoadIndicator . |
OnClose | OnClose | L'enumerazione OnClose . |
OpenAs | OpenAs | L'enumerazione OpenAs . |
SelectionInputType | SelectionInputType | L'enumerazione SelectionInputType . |
TextButtonStyle | TextButtonStyle | L'enumerazione TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | L'enumerazione UpdateDraftBodyType . |
Metodi
Documentazione dettagliata
newActionResponseBuilder()
newActionStatus()
Crea un nuovo ActionStatus
.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di Google Workspace.
const actionStatus = CardService.newActionStatus() .setStatusCode(CardService.Status.OK) .setUserFacingMessage('Success');
Invio
ActionStatus
: un valore ActionStatus vuoto.
newAttachment()
newAuthorizationAction()
newAuthorizationException()
Crea un nuovo AuthorizationException
.
Invio
AuthorizationException
: un'eccezione di autorizzazione vuota.
newBorderStyle()
newCalendarEventActionResponseBuilder()
Crea un nuovo CalendarEventActionResponseBuilder
.
Invio
CalendarEventActionResponseBuilder
: un valore CalendarEventActionResponseBuilder
vuoto.
newCardAction()
newCardBuilder()
newCardHeader()
newCardSection()
newCardWithId()
Crea un nuovo CardWithId
. Viene utilizzato per inviare una scheda in un messaggio di Google Chat. ID carta
è un identificatore univoco di una scheda in un messaggio quando vengono inviate più carte.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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);
Invio
CardWithId
: un valore CardWithId
vuoto.
newChatActionResponse()
Crea un nuovo ChatActionResponse
.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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);
Invio
ChatActionResponse
: un valore ChatActionResponse
vuoto.
newChatResponseBuilder()
Crea un nuovo ChatResponseBuilder
.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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();
Invio
ChatResponseBuilder
: un messaggio ChatResponseBuilder vuoto.
newColumn()
Crea un nuovo Column
.
Disponibile per le app Google Chat e i componenti aggiuntivi di 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
: colonna vuota.
newColumns()
Crea un nuovo insieme di Columns
.
Disponibile per le app Google Chat e i componenti aggiuntivi di 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);
Invio
Columns
: un insieme di colonne vuoto.
newComposeActionResponseBuilder()
Crea un nuovo ComposeActionResponseBuilder
.
Invio
ComposeActionResponseBuilder
: un generatore ComposeActionResponse vuoto.
newDatePicker()
newDateTimePicker()
newDecoratedText()
newDialog()
Crea un nuovo Dialog
.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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);
Invio
newDialogAction()
Crea un nuovo DialogAction
.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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)
Invio
DialogAction
: un valore DialogAction
vuoto.
newDivider()
Crea un nuovo Divider
. Il seguente esempio crea una semplice scheda con due paragrafi
separate da un divisore.
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; }
Invio
Divider
: un divisore.
newDriveItemsSelectedActionResponseBuilder()
Crea un nuovo DriveItemsSelectedActionResponseBuilder
.
Invio
DriveItemsSelectedActionResponseBuilder
: un valore DriveItemsSelectedActionResponseBuilder
vuoto.
newEditorFileScopeActionResponseBuilder()
Crea un nuovo EditorFileScopeActionResponseBuilder
.
Invio
EditorFileScopeActionResponseBuilder
: un valore EditorFileScopeActionResponseBuilder
vuoto.
newImageButton()
newImageComponent()
newImageCropStyle()
newLinkPreview()
Crea un nuovo 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');
Invio
LinkPreview
: un'anteprima Link vuota.
newNotification()
newSelectionInput()
newSuggestions()
newSuggestionsResponseBuilder()
Crea un nuovo SuggestionsResponseBuilder
.
Invio
SuggestionsResponseBuilder
: un generatore SuggestionsResponse vuoto.
newTextButton()
newTextParagraph()
newTimePicker()
newUniversalActionResponseBuilder()
Crea un nuovo UniversalActionResponseBuilder
.
Invio
UniversalActionResponseBuilder
: un builder UniversalActionResponse vuoto.
newUpdateDraftActionResponseBuilder()
Crea un nuovo UpdateDraftActionResponseBuilder
.
Invio
UpdateDraftActionResponseBuilder
: un UpdateDraftActionResponseBuilder vuoto.
newUpdateDraftBccRecipientsAction()
Crea un nuovo UpdateDraftBccRecipientsAction
;
Invio
UpdateDraftBccRecipientsAction
: un valore UpdateDraftBccRecipientsAction vuoto.
newUpdateDraftBodyAction()
Crea un nuovo UpdateDraftBodyAction
.
Invio
UpdateDraftBodyAction
: un valore UpdateDraftBodyAction vuoto.
newUpdateDraftCcRecipientsAction()
Crea un nuovo UpdateDraftCcRecipientsAction
.
Invio
UpdateDraftCcRecipientsAction
: un'azione UpdateDraftCcRecipientsAction vuota.
newUpdateDraftSubjectAction()
Crea un nuovo UpdateDraftSubjectAction
.
Invio
UpdateDraftSubjectAction
: un valore UpdateDraftSubjectAction vuoto.
newUpdateDraftToRecipientsAction()
Crea un nuovo UpdateDraftToRecipientsAction
.
Invio
UpdateDraftToRecipientsAction
: un valore UpdateDraftToRecipientsAction vuoto.
newValidation()
Crea un nuovo Validation
.
Disponibile per le app Google Chat e i componenti aggiuntivi di Google Workspace.
const validation = CardService.newValidation() .setCharacterLimit(5) .setInputType(CardService.InputType.EMAIL);
Invio
Validation
: una convalida vuota.