Class CardService

CardService

CardService offre la possibilità di creare schede generiche utilizzate in diversi prodotti di estensibilità di Google, come i componenti aggiuntivi di Google Workspace.

Di seguito è riportato un esempio di scheda relativa ai componenti aggiuntivi.

return CardService.newCardBuilder()
         .setHeader(CardService.newCardHeader().setTitle("CardTitle"))
         .build();

In alternativa, puoi restituire più carte in questo modo:

return [
  CardService.newCardBuilder().build(),
  CardService.newCardBuilder().build(),
  CardService.newCardBuilder().build()
]

Di seguito viene illustrato come definire una scheda con intestazione, testo, immagine e 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("[e-mail]"))
    .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("[phone]"))
    .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

Metodo	Tipo restituito	Breve descrizione
newAction()	Action	Viene creato un nuovo Action.
newActionResponseBuilder()	ActionResponseBuilder	Viene creato un nuovo ActionResponseBuilder.
newActionStatus()	ActionStatus	Viene creato un nuovo ActionStatus.
newAttachment()	Attachment	Viene creato un nuovo Attachment.
newAuthorizationAction()	AuthorizationAction	Viene creato un nuovo AuthorizationAction.
newAuthorizationException()	AuthorizationException	Viene creato un nuovo AuthorizationException.
newBorderStyle()	BorderStyle	Viene creato un nuovo BorderStyle.
newButtonSet()	ButtonSet	Viene creato un nuovo ButtonSet.
newCalendarEventActionResponseBuilder()	CalendarEventActionResponseBuilder	Viene creato un nuovo CalendarEventActionResponseBuilder.
newCardAction()	CardAction	Viene creato un nuovo CardAction.
newCardBuilder()	CardBuilder	Viene creato un nuovo CardBuilder.
newCardHeader()	CardHeader	Viene creato un nuovo CardHeader.
newCardSection()	CardSection	Viene creato un nuovo CardSection.
newCardWithId()	CardWithId	Viene creato un nuovo CardWithId.
newChatActionResponse()	ChatActionResponse	Viene creato un nuovo ChatActionResponse.
newChatResponseBuilder()	ChatResponseBuilder	Viene creato un nuovo ChatResponseBuilder.
newColumn()	Column	Viene creato un nuovo Column.
newColumns()	Columns	Crea un nuovo insieme di Columns.
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	Viene creato un nuovo ComposeActionResponseBuilder.
newDatePicker()	DatePicker	Viene creato un nuovo DatePicker.
newDateTimePicker()	DateTimePicker	Viene creato un nuovo DateTimePicker.
newDecoratedText()	DecoratedText	Viene creato un nuovo DecoratedText.
newDialog()	Dialog	Viene creato un nuovo Dialog.
newDialogAction()	DialogAction	Viene creato un nuovo DialogAction.
newDivider()	Divider	Viene creato un nuovo Divider.
newDriveItemsSelectedActionResponseBuilder()	DriveItemsSelectedActionResponseBuilder	Viene creato un nuovo DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()	EditorFileScopeActionResponseBuilder	Viene creato un nuovo EditorFileScopeActionResponseBuilder.
newFixedFooter()	FixedFooter	Viene creato un nuovo FixedFooter.
newGrid()	Grid	Viene creato un nuovo Grid.
newGridItem()	GridItem	Viene creato un nuovo GridItem.
newIconImage()	IconImage	Viene creato un nuovo IconImage.
newImage()	Image	Viene creato un nuovo Image.
newImageButton()	ImageButton	Viene creato un nuovo ImageButton.
newImageComponent()	ImageComponent	Viene creato un nuovo ImageComponent.
newImageCropStyle()	ImageCropStyle	Viene creato un nuovo ImageCropStyle.
newKeyValue()	KeyValue	Viene creato un nuovo KeyValue.
newLinkPreview()	LinkPreview	Viene creato un nuovo LinkPreview.
newNavigation()	Navigation	Viene creato un nuovo Navigation.
newNotification()	Notification	Viene creato un nuovo Notification.
newOpenLink()	OpenLink	Viene creato un nuovo OpenLink.
newSelectionInput()	SelectionInput	Viene creato un nuovo SelectionInput.
newSuggestions()	Suggestions	Viene creato un nuovo Suggestions.
newSuggestionsResponseBuilder()	SuggestionsResponseBuilder	Viene creato un nuovo SuggestionsResponseBuilder.
newSwitch()	Switch	Viene creato un nuovo Switch.
newTextButton()	TextButton	Viene creato un nuovo TextButton.
newTextInput()	TextInput	Viene creato un nuovo TextInput.
newTextParagraph()	TextParagraph	Viene creato un nuovo TextParagraph.
newTimePicker()	TimePicker	Viene creato un nuovo TimePicker.
newUniversalActionResponseBuilder()	UniversalActionResponseBuilder	Viene creato un nuovo UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()	UpdateDraftActionResponseBuilder	Viene creato un nuovo UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()	UpdateDraftBccRecipientsAction	Crea un nuovo UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()	UpdateDraftBodyAction	Viene creato un nuovo UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()	UpdateDraftCcRecipientsAction	Viene creato un nuovo UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()	UpdateDraftSubjectAction	Viene creato un nuovo UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()	UpdateDraftToRecipientsAction	Viene creato un nuovo UpdateDraftToRecipientsAction.

Documentazione dettagliata

newAction()

Viene creato un nuovo Action.

Ritorni

Action - Un'azione vuota.

---

newActionResponseBuilder()

Viene creato un nuovo ActionResponseBuilder.

Ritorni

ActionResponseBuilder - Un generatore di ActionResponse vuoto.

---

newActionStatus()

Viene creato 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');

Ritorni

ActionStatus - Un ActionStatus vuoto.

---

newAttachment()

Viene creato un nuovo Attachment.

Ritorni

Attachment: un allegato vuoto.

---

newAuthorizationAction()

Viene creato un nuovo AuthorizationAction.

Ritorni

AuthorizationAction: un'autorizzazione AuthorizationAction vuota.

---

newAuthorizationException()

Viene creato un nuovo AuthorizationException.

Ritorni

AuthorizationException: un'eccezione AuthorizationException

---

newBorderStyle()

Viene creato un nuovo BorderStyle.

Ritorni

BorderStyle: un BorderStyle vuoto.

---

newButtonSet()

Viene creato un nuovo ButtonSet.

Ritorni

ButtonSet: un ButtonSet vuoto.

---

newCalendarEventActionResponseBuilder()

Viene creato un nuovo CalendarEventActionResponseBuilder.

Ritorni

CalendarEventActionResponseBuilder: CalendarEventActionResponseBuilder vuoto.

---

newCardAction()

Viene creato un nuovo CardAction.

Ritorni

CardAction: una CardAction vuota.

---

newCardBuilder()

Viene creato un nuovo CardBuilder.

Ritorni

CardBuilder — Un generatore di carte vuoto.

---

newCardHeader()

Viene creato un nuovo CardHeader.

Ritorni

CardHeader: CardHeader vuoto.

---

newCardSection()

Viene creato un nuovo CardSection.

Ritorni

CardSection: una CardSezione vuota.

---

newCardWithId()

Viene creato un nuovo CardWithId. Viene utilizzato per inviare una scheda in un messaggio di Google Chat. L'ID carta è l'identificatore univoco di una scheda in un messaggio quando invii più schede.

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);

Ritorni

CardWithId: CardWithId vuoto.

---

newChatActionResponse()

Viene creato 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);

Ritorni

ChatActionResponse: ChatActionResponse vuoto.

---

newChatResponseBuilder()

Viene creato 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();

Ritorni

ChatResponseBuilder - Un ChatResponseBuilder vuoto.

---

newColumn()

Viene creato 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);

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, che concede l'accesso in anteprima a determinate funzionalità.

Ritorni

Column: una 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);

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, che concede l'accesso in anteprima a determinate funzionalità.

Ritorni

Columns: un insieme vuoto di colonne.

---

newComposeActionResponseBuilder()

Viene creato un nuovo ComposeActionResponseBuilder.

Ritorni

ComposeActionResponseBuilder - Un generatore di ComposeActionResponse vuoto.

---

newDatePicker()

Viene creato un nuovo DatePicker.

Ritorni

DatePicker: un selettore della data vuoto.

---

newDateTimePicker()

Viene creato un nuovo DateTimePicker.

Ritorni

DateTimePicker: un DateTimeSelecter vuoto.

---

newDecoratedText()

Viene creato un nuovo DecoratedText.

Ritorni

DecoratedText: un valore decorato vuoto.

---

newDialog()

Viene creato 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);

Ritorni

Dialog: Dialog vuoto.

---

newDialogAction()

Viene creato 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)

Ritorni

DialogAction: DialogAction vuoto.

---

newDivider()

Viene creato un nuovo Divider. L'esempio seguente crea una scheda semplice con 2 paragrafi separati 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;
}

Ritorni

Divider: un divisore.

---

newDriveItemsSelectedActionResponseBuilder()

Viene creato un nuovo DriveItemsSelectedActionResponseBuilder.

Ritorni

DriveItemsSelectedActionResponseBuilder: DriveItemsSelectedActionResponseBuilder vuoto.

---

newEditorFileScopeActionResponseBuilder()

Viene creato un nuovo EditorFileScopeActionResponseBuilder.

Ritorni

EditorFileScopeActionResponseBuilder: EditorFileScopeActionResponseBuilder vuoto.

---

newFixedFooter()

Viene creato un nuovo FixedFooter.

Ritorni

FixedFooter: un FixedPiè di pagina vuoto.

---

newGrid()

Viene creato un nuovo Grid.

Ritorni

Grid — Una griglia vuota.

---

newGridItem()

Viene creato un nuovo GridItem.

Ritorni

GridItem: un GridItem vuoto.

---

newIconImage()

Viene creato un nuovo IconImage.

Ritorni

IconImage: un'immagine dell'icona vuota.

---

newImage()

Viene creato un nuovo Image.

Ritorni

Image: un'immagine vuota.

---

newImageButton()

Viene creato un nuovo ImageButton.

Ritorni

ImageButton: un pulsante ImageButton vuoto.

---

newImageComponent()

Viene creato un nuovo ImageComponent.

Ritorni

ImageComponent: un ImageComponente vuoto.

---

newImageCropStyle()

Viene creato un nuovo ImageCropStyle.

Ritorni

ImageCropStyle: un ImageRitagliaStyle vuoto.

---

newKeyValue()

Viene creato un nuovo KeyValue.

Ritorni

KeyValue: un valore chiave vuoto.

---

newLinkPreview()

Viene creato 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');

Ritorni

LinkPreview: un campo LinkPreview vuoto.

---

newNavigation()

Viene creato un nuovo Navigation.

Ritorni

Navigation - Una navigazione vuota.

---

newNotification()

Viene creato un nuovo Notification.

Ritorni

Notification - Una notifica vuota.

---

newOpenLink()

Viene creato un nuovo OpenLink.

Ritorni

OpenLink: un OpenLink vuoto.

---

newSelectionInput()

Viene creato un nuovo SelectionInput.

Ritorni

SelectionInput: un valore SelectionInput vuoto.

---

newSuggestions()

Viene creato un nuovo Suggestions.

Ritorni

Suggestions - Un suggerimento vuoto.

---

newSuggestionsResponseBuilder()

Viene creato un nuovo SuggestionsResponseBuilder.

Ritorni

SuggestionsResponseBuilder - Un generatore di SuggestionsResponse vuoto.

---

newSwitch()

Viene creato un nuovo Switch.

Ritorni

Switch: un sensore vuoto.

---

newTextButton()

Viene creato un nuovo TextButton.

Ritorni

TextButton: un TextButton vuoto.

---

newTextInput()

Viene creato un nuovo TextInput.

Ritorni

TextInput: un valore TextInput vuoto.

---

newTextParagraph()

Viene creato un nuovo TextParagraph.

Ritorni

TextParagraph: un TextParagraph vuoto.

---

newTimePicker()

Viene creato un nuovo TimePicker.

Ritorni

TimePicker: un selettore temporale vuoto.

---

newUniversalActionResponseBuilder()

Viene creato un nuovo UniversalActionResponseBuilder.

Ritorni

UniversalActionResponseBuilder - Un generatore di UniversalActionResponse vuoto.

---

newUpdateDraftActionResponseBuilder()

Viene creato un nuovo UpdateDraftActionResponseBuilder.

Ritorni

UpdateDraftActionResponseBuilder - Un oggetto UpdateDraftActionResponseBuilder vuoto.

---

newUpdateDraftBccRecipientsAction()

Crea un nuovo UpdateDraftBccRecipientsAction;

Ritorni

UpdateDraftBccRecipientsAction: un oggetto UpdateDraftBccRecipientsAction vuoto.

---

newUpdateDraftBodyAction()

Viene creato un nuovo UpdateDraftBodyAction.

Ritorni

UpdateDraftBodyAction: un oggetto UpdateDraftBodyAction vuoto.

---

newUpdateDraftCcRecipientsAction()

Viene creato un nuovo UpdateDraftCcRecipientsAction.

Ritorni

UpdateDraftCcRecipientsAction: un'azione UpdateDraftCcRecipients vuota.

---

newUpdateDraftSubjectAction()

Viene creato un nuovo UpdateDraftSubjectAction.

Ritorni

UpdateDraftSubjectAction - Un oggetto UpdateDraftSubjectAction vuoto.

---

newUpdateDraftToRecipientsAction()

Viene creato un nuovo UpdateDraftToRecipientsAction.

Ritorni

UpdateDraftToRecipientsAction: un oggetto UpdateDraftToRecipientsAction vuoto.