Class CardService

CardService

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àTipoDescrizione
BorderTypeBorderTypeL'enumerazione BorderType.
ComposedEmailTypeComposedEmailTypeL'enumerazione ComposedEmailType.
ContentTypeContentTypeL'enumerazione ContentType.
GridItemLayoutGridItemLayoutL'enumerazione GridItemLayout.
HorizontalAlignmentHorizontalAlignmentL'enumerazione HorizontalAlignment.
IconIconL'enumerazione Icon.
ImageCropTypeImageCropTypeL'enumerazione ImageCropType.
ImageStyleImageStyleL'enumerazione ImageStyle.
LoadIndicatorLoadIndicatorL'enumerazione LoadIndicator.
OnCloseOnCloseL'enumerazione OnClose.
OpenAsOpenAsL'enumerazione OpenAs.
SelectionInputTypeSelectionInputTypeL'enumerazione SelectionInputType.
TextButtonStyleTextButtonStyleL'enumerazione TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeL'enumerazione UpdateDraftBodyType.

Metodi

MetodoTipo restituitoBreve descrizione
newAction()ActionCrea un nuovo Action.
newActionResponseBuilder()ActionResponseBuilderCrea un nuovo ActionResponseBuilder.
newActionStatus()ActionStatusCrea un nuovo ActionStatus.
newAttachment()AttachmentCrea un nuovo Attachment.
newAuthorizationAction()AuthorizationActionCrea un nuovo AuthorizationAction.
newAuthorizationException()AuthorizationExceptionCrea un nuovo AuthorizationException.
newBorderStyle()BorderStyleCrea un nuovo BorderStyle.
newButtonSet()ButtonSetCrea un nuovo ButtonSet.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCrea un nuovo CalendarEventActionResponseBuilder.
newCardAction()CardActionCrea un nuovo CardAction.
newCardBuilder()CardBuilderCrea un nuovo CardBuilder.
newCardHeader()CardHeaderCrea un nuovo CardHeader.
newCardSection()CardSectionCrea un nuovo CardSection.
newCardWithId()CardWithIdCrea un nuovo CardWithId.
newChatActionResponse()ChatActionResponseCrea un nuovo ChatActionResponse.
newChatResponseBuilder()ChatResponseBuilderCrea un nuovo ChatResponseBuilder.
newColumn()ColumnCrea un nuovo Column.
newColumns()ColumnsCrea un nuovo insieme di Columns.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrea un nuovo ComposeActionResponseBuilder.
newDatePicker()DatePickerCrea un nuovo DatePicker.
newDateTimePicker()DateTimePickerCrea un nuovo DateTimePicker.
newDecoratedText()DecoratedTextCrea un nuovo DecoratedText.
newDialog()DialogCrea un nuovo Dialog.
newDialogAction()DialogActionCrea un nuovo DialogAction.
newDivider()DividerCrea un nuovo Divider.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCrea un nuovo DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCrea un nuovo EditorFileScopeActionResponseBuilder.
newFixedFooter()FixedFooterCrea un nuovo FixedFooter.
newGrid()GridCrea un nuovo Grid.
newGridItem()GridItemCrea un nuovo GridItem.
newIconImage()IconImageCrea un nuovo IconImage.
newImage()ImageCrea un nuovo Image.
newImageButton()ImageButtonCrea un nuovo ImageButton.
newImageComponent()ImageComponentCrea un nuovo ImageComponent.
newImageCropStyle()ImageCropStyleCrea un nuovo ImageCropStyle.
newKeyValue()KeyValueCrea un nuovo KeyValue.
newLinkPreview()LinkPreviewCrea un nuovo LinkPreview.
newNavigation()NavigationCrea un nuovo Navigation.
newNotification()NotificationCrea un nuovo Notification.
newOpenLink()OpenLinkCrea un nuovo OpenLink.
newSelectionInput()SelectionInputCrea un nuovo SelectionInput.
newSuggestions()SuggestionsCrea un nuovo Suggestions.
newSuggestionsResponseBuilder()SuggestionsResponseBuilderCrea un nuovo SuggestionsResponseBuilder.
newSwitch()SwitchCrea un nuovo Switch.
newTextButton()TextButtonCrea un nuovo TextButton.
newTextInput()TextInputCrea un nuovo TextInput.
newTextParagraph()TextParagraphCrea un nuovo TextParagraph.
newTimePicker()TimePickerCrea un nuovo TimePicker.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCrea un nuovo UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCrea un nuovo UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCrea un nuovo UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()UpdateDraftBodyActionCrea un nuovo UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCrea un nuovo UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCrea un nuovo UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCrea un nuovo UpdateDraftToRecipientsAction.
newValidation()ValidationCrea un nuovo Validation.

Documentazione dettagliata

newAction()

Crea un nuovo Action.

Invio

Action: un'azione vuota.


newActionResponseBuilder()

Crea un nuovo ActionResponseBuilder.

Invio

ActionResponseBuilder: un builder ActionResponse vuoto.


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

Crea un nuovo Attachment.

Invio

Attachment: un allegato vuoto.


newAuthorizationAction()

Crea un nuovo AuthorizationAction.

Invio

AuthorizationAction: un'azione di autorizzazione vuota.


newAuthorizationException()

Crea un nuovo AuthorizationException.

Invio

AuthorizationException: un'eccezione di autorizzazione vuota.


newBorderStyle()

Crea un nuovo BorderStyle.

Invio

BorderStyle: un BorderStyle vuoto.


newButtonSet()

Crea un nuovo ButtonSet.

Invio

ButtonSet: un set di pulsanti vuoto.


newCalendarEventActionResponseBuilder()


newCardAction()

Crea un nuovo CardAction.

Invio

CardAction: una CardAction vuota.


newCardBuilder()

Crea un nuovo CardBuilder.

Invio

CardBuilder: un generatore di schede vuoto.


newCardHeader()

Crea un nuovo CardHeader.

Invio

CardHeader: una CardHeader vuota.


newCardSection()

Crea un nuovo CardSection.

Invio

CardSection: una CardSezione vuota.


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

Crea un nuovo DatePicker.

Invio

DatePicker: un selettore della data vuoto.


newDateTimePicker()

Crea un nuovo DateTimePicker.

Invio

DateTimePicker: un selettore di data/ora vuoto.


newDecoratedText()

Crea un nuovo DecoratedText.

Invio

DecoratedText: un DecorText vuoto.


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

Dialog: un valore Dialog vuoto.


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


newEditorFileScopeActionResponseBuilder()


newFixedFooter()

Crea un nuovo FixedFooter.

Invio

FixedFooter: un piè di pagina fisso vuoto.


newGrid()

Crea un nuovo Grid.

Invio

Grid: una griglia vuota.


newGridItem()

Crea un nuovo GridItem.

Invio

GridItem: un elemento GridItem vuoto.


newIconImage()

Crea un nuovo IconImage.

Invio

IconImage: immagine di un'icona vuota.


newImage()

Crea un nuovo Image.

Invio

Image: un'immagine vuota.


newImageButton()

Crea un nuovo ImageButton.

Invio

ImageButton: un elemento ImageButton vuoto.


newImageComponent()

Crea un nuovo ImageComponent.

Invio

ImageComponent: un elemento ImageComponent vuoto.


newImageCropStyle()

Crea un nuovo ImageCropStyle.

Invio

ImageCropStyle: un elemento ImageRitagliaStyle vuoto.


newKeyValue()

Crea un nuovo KeyValue.

Invio

KeyValue: una coppia chiave-valore vuota.


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.


newNavigation()

Crea un nuovo Navigation.

Invio

Navigation: un riquadro di navigazione vuoto.


newNotification()

Crea un nuovo Notification.

Invio

Notification: una notifica vuota.


Crea un nuovo OpenLink.

Invio

OpenLink: un OpenLink vuoto.


newSelectionInput()

Crea un nuovo SelectionInput.

Invio

SelectionInput: un valore SelectionInput vuoto.


newSuggestions()

Crea un nuovo Suggestions.

Invio

Suggestions: un suggerimento vuoto.


newSuggestionsResponseBuilder()

Crea un nuovo SuggestionsResponseBuilder.

Invio

SuggestionsResponseBuilder: un generatore SuggestionsResponse vuoto.


newSwitch()

Crea un nuovo Switch.

Invio

Switch: un sensore vuoto.


newTextButton()

Crea un nuovo TextButton.

Invio

TextButton: un TextButton vuoto.


newTextInput()

Crea un nuovo TextInput.

Invio

TextInput: un TextInput vuoto.


newTextParagraph()

Crea un nuovo TextParagraph.

Invio

TextParagraph: un TextParagraph vuoto.


newTimePicker()

Crea un nuovo TimePicker.

Invio

TimePicker: un selettore temporale vuoto.


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.