Class CardService

CardService

O CardService permite criar cards genéricos usados em diferentes produtos de extensibilidade do Google, como os Complementos do Google Workspace.

Abaixo está um exemplo de cartão de complementos.

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

Também é possível retornar vários cards como os seguintes:

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

Confira a seguir como definir um card com cabeçalho, texto, imagem e um item de 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();
}

Exemplo de card de apps de 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();

Propriedades

PropriedadeTipoDescrição
BorderTypeBorderTypeA enumeração BorderType.
ComposedEmailTypeComposedEmailTypeA enumeração ComposedEmailType.
ContentTypeContentTypeA enumeração ContentType.
GridItemLayoutGridItemLayoutA enumeração GridItemLayout.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
IconIconA enumeração Icon.
ImageCropTypeImageCropTypeA enumeração ImageCropType.
ImageStyleImageStyleA enumeração ImageStyle.
LoadIndicatorLoadIndicatorA enumeração LoadIndicator.
OnCloseOnCloseA enumeração OnClose.
OpenAsOpenAsA enumeração OpenAs.
SelectionInputTypeSelectionInputTypeA enumeração SelectionInputType.
TextButtonStyleTextButtonStyleA enumeração TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeA enumeração UpdateDraftBodyType.

Métodos

MétodoTipo de retornoBreve descrição
newAction()ActionCrie um novo Action.
newActionResponseBuilder()ActionResponseBuilderCrie um novo ActionResponseBuilder.
newActionStatus()ActionStatusCrie um novo ActionStatus.
newAttachment()AttachmentCrie um novo Attachment.
newAuthorizationAction()AuthorizationActionCrie um novo AuthorizationAction.
newAuthorizationException()AuthorizationExceptionCrie um novo AuthorizationException.
newBorderStyle()BorderStyleCrie um novo BorderStyle.
newButtonSet()ButtonSetCrie um novo ButtonSet.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCrie um novo CalendarEventActionResponseBuilder.
newCardAction()CardActionCrie um novo CardAction.
newCardBuilder()CardBuilderCrie um novo CardBuilder.
newCardHeader()CardHeaderCrie um novo CardHeader.
newCardSection()CardSectionCrie um novo CardSection.
newCardWithId()CardWithIdCrie um novo CardWithId.
newChatActionResponse()ChatActionResponseCrie um novo ChatActionResponse.
newChatResponseBuilder()ChatResponseBuilderCrie um novo ChatResponseBuilder.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrie um novo ComposeActionResponseBuilder.
newDatePicker()DatePickerCrie um novo DatePicker.
newDateTimePicker()DateTimePickerCrie um novo DateTimePicker.
newDecoratedText()DecoratedTextCrie um novo DecoratedText.
newDialog()DialogCrie um novo Dialog.
newDialogAction()DialogActionCrie um novo DialogAction.
newDivider()DividerCrie um novo Divider.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCrie um novo DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCrie um novo EditorFileScopeActionResponseBuilder.
newFixedFooter()FixedFooterCrie um novo FixedFooter.
newGrid()GridCrie um novo Grid.
newGridItem()GridItemCrie um novo GridItem.
newIconImage()IconImageCrie um novo IconImage.
newImage()ImageCrie um novo Image.
newImageButton()ImageButtonCrie um novo ImageButton.
newImageComponent()ImageComponentCrie um novo ImageComponent.
newImageCropStyle()ImageCropStyleCrie um novo ImageCropStyle.
newKeyValue()KeyValueCrie um novo KeyValue.
newNavigation()NavigationCrie um novo Navigation.
newNotification()NotificationCrie um novo Notification.
newOpenLink()OpenLinkCrie um novo OpenLink.
newSelectionInput()SelectionInputCrie um novo SelectionInput.
newSuggestions()SuggestionsCrie um novo Suggestions.
newSuggestionsResponseBuilder()SuggestionsResponseBuilderCrie um novo SuggestionsResponseBuilder.
newSwitch()SwitchCrie um novo Switch.
newTextButton()TextButtonCrie um novo TextButton.
newTextInput()TextInputCrie um novo TextInput.
newTextParagraph()TextParagraphCrie um novo TextParagraph.
newTimePicker()TimePickerCrie um novo TimePicker.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCrie um novo UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCrie um novo UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCria um novo UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()UpdateDraftBodyActionCrie um novo UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCrie um novo UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCrie um novo UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCrie um novo UpdateDraftToRecipientsAction.

Documentação detalhada

newAction()

Crie um novo Action.

Retorno

Action: uma ação vazia.


newActionResponseBuilder()

Crie um novo ActionResponseBuilder.

Retorno

ActionResponseBuilder: um builder ActionResponse vazio.


newActionStatus()

Crie um novo ActionStatus.

Disponível apenas nos apps do Google Chat. Indisponível para complementos do Google Workspace.

const actionStatus = CardService.newActionStatus()
    .setStatusCode(CardService.Status.OK)
    .setUserFacingMessage('Success');

Retorno

ActionStatus: um ActionStatus vazio.


newAttachment()

Crie um novo Attachment.

Retorno

Attachment: um anexo vazio.


newAuthorizationAction()

Crie um novo AuthorizationAction.

Retorno

AuthorizationAction: uma AuthorizationAction vazia.


newAuthorizationException()

Crie um novo AuthorizationException.

Retorno

AuthorizationException: uma AuthorizationException vazia.


newBorderStyle()

Crie um novo BorderStyle.

Retorno

BorderStyle: um BorderStyle vazio.


newButtonSet()

Crie um novo ButtonSet.

Retorno

ButtonSet: um ButtonSet vazio.


newCalendarEventActionResponseBuilder()


newCardAction()

Crie um novo CardAction.

Retorno

CardAction: uma CardAction vazia.


newCardBuilder()

Crie um novo CardBuilder.

Retorno

CardBuilder: um criador de cards vazio.


newCardHeader()

Crie um novo CardHeader.

Retorno

CardHeader: um CardHeader vazio.


newCardSection()

Crie um novo CardSection.

Retorno

CardSection: uma CardSection vazia.


newCardWithId()

Crie um novo CardWithId. Ele é usado para enviar um cartão em uma mensagem do Google Chat. O ID do cartão é um identificador exclusivo de um cartão em uma mensagem ao enviar vários cartões.

Disponível apenas nos apps do Google Chat. Indisponível para complementos 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);

Retorno

CardWithId: uma CardWithId vazia.


newChatActionResponse()

Crie um novo ChatActionResponse.

Disponível apenas nos apps do Google Chat. Indisponível para complementos 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);

Retorno

ChatActionResponse: uma ChatActionResponse vazia.


newChatResponseBuilder()

Crie um novo ChatResponseBuilder.

Disponível apenas nos apps do Google Chat. Indisponível para complementos 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();

Retorno

ChatResponseBuilder: um ChatResponseBuilder vazio.


newComposeActionResponseBuilder()

Crie um novo ComposeActionResponseBuilder.

Retorno

ComposeActionResponseBuilder: um builder ComposeActionResponse vazio.


newDatePicker()

Crie um novo DatePicker.

Retorno

DatePicker: um DatePicker vazio.


newDateTimePicker()

Crie um novo DateTimePicker.

Retorno

DateTimePicker: um DateTimePicker vazio.


newDecoratedText()

Crie um novo DecoratedText.

Retorno

DecoratedText: um DecoratedText vazio.


newDialog()

Crie um novo Dialog.

Disponível apenas nos apps do Google Chat. Indisponível para complementos 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);

Retorno

Dialog: uma Dialog vazia.


newDialogAction()

Crie um novo DialogAction.

Disponível apenas nos apps do Google Chat. Indisponível para complementos 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)

Retorno

DialogAction: uma DialogAction vazia.


newDivider()

Crie um novo Divider. O exemplo a seguir cria um card simples com dois parágrafos separados por um divisor.

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

Retorno

Divider: um divisor.


newDriveItemsSelectedActionResponseBuilder()


newEditorFileScopeActionResponseBuilder()


newFixedFooter()

Crie um novo FixedFooter.

Retorno

FixedFooter: um Rodapé fixo vazio.


newGrid()

Crie um novo Grid.

Retorno

Grid: uma grade vazia.


newGridItem()

Crie um novo GridItem.

Retorno

GridItem: um GridItem vazio.


newIconImage()

Crie um novo IconImage.

Retorno

IconImage: uma imagem de ícone vazia.


newImage()

Crie um novo Image.

Retorno

Image: uma imagem vazia.


newImageButton()

Crie um novo ImageButton.

Retorno

ImageButton: um ImageButton vazio.


newImageComponent()

Crie um novo ImageComponent.

Retorno

ImageComponent: um ImageComponent vazio.


newImageCropStyle()

Crie um novo ImageCropStyle.

Retorno

ImageCropStyle: um ImageCropStyle vazio.


newKeyValue()

Crie um novo KeyValue.

Retorno

KeyValue: um KeyValue vazio.


newNavigation()

Crie um novo Navigation.

Retorno

Navigation: uma navegação vazia.


newNotification()

Crie um novo Notification.

Retorno

Notification: uma notificação vazia.


Crie um novo OpenLink.

Retorno

OpenLink: um OpenLink vazio.


newSelectionInput()

Crie um novo SelectionInput.

Retorno

SelectionInput: um SelectionInput vazio.


newSuggestions()

Crie um novo Suggestions.

Retorno

Suggestions: uma sugestão vazia.


newSuggestionsResponseBuilder()

Crie um novo SuggestionsResponseBuilder.

Retorno

SuggestionsResponseBuilder: um builder SuggestionsResponse vazio.


newSwitch()

Crie um novo Switch.

Retorno

Switch: um interruptor vazio.


newTextButton()

Crie um novo TextButton.

Retorno

TextButton: um TextButton vazio.


newTextInput()

Crie um novo TextInput.

Retorno

TextInput: um TextInput vazio.


newTextParagraph()

Crie um novo TextParagraph.

Retorno

TextParagraph: um Textparagraph vazio.


newTimePicker()

Crie um novo TimePicker.

Retorno

TimePicker: um TimePicker vazio.


newUniversalActionResponseBuilder()

Crie um novo UniversalActionResponseBuilder.

Retorno

UniversalActionResponseBuilder: um builder UniversalActionResponse vazio.


newUpdateDraftActionResponseBuilder()

Crie um novo UpdateDraftActionResponseBuilder.

Retorno

UpdateDraftActionResponseBuilder: um UpdateRascunhoActionResponseBuilder vazio.


newUpdateDraftBccRecipientsAction()

Cria um novo UpdateDraftBccRecipientsAction;

Retorno

UpdateDraftBccRecipientsAction: uma UpdateDraftBccRecipientsAction vazia.


newUpdateDraftBodyAction()

Crie um novo UpdateDraftBodyAction.

Retorno

UpdateDraftBodyAction: uma UpdateDraftBodyAction vazia.


newUpdateDraftCcRecipientsAction()

Crie um novo UpdateDraftCcRecipientsAction.

Retorno

UpdateDraftCcRecipientsAction: uma UpdateRascunhoCcRecipientsAction vazio.


newUpdateDraftSubjectAction()

Crie um novo UpdateDraftSubjectAction.

Retorno

UpdateDraftSubjectAction: uma UpdateDraftSubjectAction vazia.


newUpdateDraftToRecipientsAction()

Crie um novo UpdateDraftToRecipientsAction.

Retorno

UpdateDraftToRecipientsAction: uma UpdateDraftToRecipientsAction vazia.