Esta página foi traduzida pela API Cloud Translation.

Class CardService

Com o CardService, é possível criar cartões genéricos usados em diferentes produtos de extensibilidade, como os complementos do Google Workspace.

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

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

Também é possível retornar vários cards, desta forma:

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

Confira abaixo como definir um card com um cabeçalho, texto, uma 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 do 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

Propriedade	Tipo	Descrição
`BorderType`	`BorderType`	A enumeração `BorderType`.
`ComposedEmailType`	`ComposedEmailType`	A enumeração `ComposedEmailType`.
`ContentType`	`ContentType`	A enumeração `ContentType`.
`GridItemLayout`	`GridItemLayout`	A enumeração `GridItemLayout`.
`HorizontalAlignment`	`HorizontalAlignment`	A enumeração `HorizontalAlignment`.
`Icon`	`Icon`	A enumeração `Icon`.
`ImageCropType`	`ImageCropType`	A enumeração `ImageCropType`.
`ImageStyle`	`ImageStyle`	A enumeração `ImageStyle`.
`LoadIndicator`	`LoadIndicator`	A enumeração `LoadIndicator`.
`OnClose`	`OnClose`	A enumeração `OnClose`.
`OpenAs`	`OpenAs`	A enumeração `OpenAs`.
`SelectionInputType`	`SelectionInputType`	A enumeração `SelectionInputType`.
`TextButtonStyle`	`TextButtonStyle`	A enumeração `TextButtonStyle`.
`UpdateDraftBodyType`	`UpdateDraftBodyType`	A enumeração `UpdateDraftBodyType`.

Métodos

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

Documentação detalhada

`newAction()`

Crie um novo Action.

Retornar

Action: uma ação vazia.

`newActionResponseBuilder()`

Crie um novo ActionResponseBuilder.

Retornar

ActionResponseBuilder: um builder ActionResponse vazio.

`newActionStatus()`

Crie um novo ActionStatus.

Disponível apenas nos apps do Google Chat. Não disponível para complementos do Google Workspace.

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

Retornar

ActionStatus: um ActionStatus vazio.

`newAttachment()`

Crie um novo Attachment.

Retornar

Attachment: um anexo vazio.

`newAuthorizationAction()`

Crie um novo AuthorizationAction.

Retornar

AuthorizationAction: uma AuthorizationAction vazia.

`newAuthorizationException()`

Crie um novo AuthorizationException.

Retornar

AuthorizationException: uma AuthorizationException vazia.

`newBorderStyle()`

Crie um novo BorderStyle.

Retornar

BorderStyle: um BorderStyle vazio.

`newButtonSet()`

Crie um novo ButtonSet.

Retornar

ButtonSet: umButtonSet vazio.

`newCalendarEventActionResponseBuilder()`

Crie um novo CalendarEventActionResponseBuilder.

Retornar

CalendarEventActionResponseBuilder: um CalendarEventActionResponseBuilder vazio.

`newCardAction()`

Crie um novo CardAction.

Retornar

CardAction: uma CardAction vazia.

`newCardBuilder()`

Crie um novo CardBuilder.

Retornar

CardBuilder: um builder de cards vazio.

`newCardHeader()`

Crie um novo CardHeader.

Retornar

CardHeader: um CardHeader vazio.

`newCardSection()`

Crie um novo CardSection.

Retornar

CardSection: uma CardSection vazia.

`newCardWithId()`

Crie um novo CardWithId. Isso é usado para enviar um card em uma mensagem do Google Chat. 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. Não disponí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);

Retornar

CardWithId: um CardWithId vazio.

`newChatActionResponse()`

Crie um novo ChatActionResponse.

Disponível apenas nos apps do Google Chat. Não disponí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);

Retornar

ChatActionResponse: um ChatActionResponse vazio.

`newChatResponseBuilder()`

Crie um novo ChatResponseBuilder.

Disponível apenas nos apps do Google Chat. Não disponí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();

Retornar

ChatResponseBuilder: um ChatResponseBuilder vazio.

`newColumn()`

Crie um novo Column.

Disponível nos apps do Google Chat e nos complementos 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);

Column: uma coluna vazia.

`newColumns()`

Cria um novo conjunto de Columns.

Disponível nos apps do Google Chat e nos complementos 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(column)
    .addColumn(secondColumn)
    .setWrapStyle(CardService.WrapStyle.WRAP);

Retornar

Columns: um conjunto vazio de colunas.

`newComposeActionResponseBuilder()`

Crie um novo ComposeActionResponseBuilder.

Retornar

ComposeActionResponseBuilder: um builder ComposeActionResponse vazio.

`newDatePicker()`

Crie um novo DatePicker.

Retornar

DatePicker: um DatePicker vazio.

`newDateTimePicker()`

Crie um novo DateTimePicker.

Retornar

DateTimePicker: um DateTimePicker vazio.

`newDecoratedText()`

Crie um novo DecoratedText.

Retornar

DecoratedText: um DecoratedText vazio.

`newDialog()`

Crie um novo Dialog.

Disponível apenas nos apps do Google Chat. Não disponí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);

Retornar

Dialog: um Dialog vazio.

`newDialogAction()`

Crie um novo DialogAction.

Disponível apenas nos apps do Google Chat. Não disponí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)

Retornar

DialogAction: um DialogAction vazio.

`newDivider()`

Crie um novo Divider. O exemplo a seguir cria um cartão simples com dois parágrafos separadas 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;
}

Retornar

Divider: um divisor.

`newFixedFooter()`

Crie um novo FixedFooter.

Retornar

FixedFooter: um rodapé fixo vazio.

`newGrid()`

Crie um novo Grid.

Retornar

Grid: uma grade vazia.

`newGridItem()`

Crie um novo GridItem.

Retornar

GridItem: um GridItem vazio.

`newIconImage()`

Crie um novo IconImage.

Retornar

IconImage: uma imagem de ícone vazia.

`newImage()`

Crie um novo Image.

Retornar

Image: uma imagem vazia.

`newImageButton()`

Crie um novo ImageButton.

Retornar

ImageButton: um ImageButton vazio.

`newImageComponent()`

Crie um novo ImageComponent.

Retornar

ImageComponent: um ImageComponent vazio.

`newImageCropStyle()`

Crie um novo ImageCropStyle.

Retornar

ImageCropStyle: um ImageCropStyle vazio.

`newKeyValue()`

Crie um novo KeyValue.

Retornar

KeyValue: um valor-chave vazio.

`newLinkPreview()`

Crie um novo 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');

Retornar

LinkPreview: um LinkPreview vazio.

`newNavigation()`

Crie um novo Navigation.

Retornar

Navigation: uma navegação vazia.

`newNotification()`

Crie um novo Notification.

Retornar

Notification: uma notificação vazia.

`newOpenLink()`

Crie um novo OpenLink.

Retornar

OpenLink: um OpenLink vazio.

`newSelectionInput()`

Crie um novo SelectionInput.

Retornar

SelectionInput: uma SelectionInput vazia.

`newSuggestions()`

Crie um novo Suggestions.

Retornar

Suggestions: uma sugestão vazia.

`newSuggestionsResponseBuilder()`

Crie um novo SuggestionsResponseBuilder.

Retornar

SuggestionsResponseBuilder: um builder SuggestionsResponse vazio.

`newSwitch()`

Crie um novo Switch.

Retornar

Switch: uma chave vazia.

`newTextButton()`

Crie um novo TextButton.

Retornar

TextButton: um TextButton vazio.

`newTextInput()`

Crie um novo TextInput.

Retornar

TextInput: um TextInput vazio.

`newTextParagraph()`

Crie um novo TextParagraph.

Retornar

TextParagraph: um TextParagraph vazio.

`newTimePicker()`

Crie um novo TimePicker.

Retornar

TimePicker: um TimePicker vazio.

`newUniversalActionResponseBuilder()`

Crie um novo UniversalActionResponseBuilder.

Retornar

UniversalActionResponseBuilder: um builder UniversalActionResponse vazio.

`newUpdateDraftActionResponseBuilder()`

Crie um novo UpdateDraftActionResponseBuilder.

Retornar

UpdateDraftActionResponseBuilder: um UpdateDraftActionResponseBuilder vazio.

`newUpdateDraftBccRecipientsAction()`

Cria um novo UpdateDraftBccRecipientsAction.

Retornar

UpdateDraftBccRecipientsAction: um UpdateDraftBccRecipientsAction vazio.

`newUpdateDraftBodyAction()`

Crie um novo UpdateDraftBodyAction.

Retornar

UpdateDraftBodyAction: uma UpdateDraftBodyAction vazia.

`newUpdateDraftCcRecipientsAction()`

Crie um novo UpdateDraftCcRecipientsAction.

Retornar

UpdateDraftCcRecipientsAction: uma UpdateDraftCcRecipientsAction vazia.

`newUpdateDraftSubjectAction()`

Crie um novo UpdateDraftSubjectAction.

Retornar

UpdateDraftSubjectAction: uma UpdateDraftSubjectAction vazia.

`newUpdateDraftToRecipientsAction()`

Crie um novo UpdateDraftToRecipientsAction.

Retornar

UpdateDraftToRecipientsAction: uma UpdateDraftToRecipientsAction vazia.

`newValidation()`

Crie um novo Validation.

Disponível nos apps do Google Chat e nos complementos do Google Workspace.

const validation = CardService.newValidation()
    .setCharacterLimit(5)
    .setInputType(CardService.InputType.EMAIL);

Retornar

Validation: uma validação vazia.

Class CardService

Propriedades

Métodos

Documentação detalhada

newAction()

Retornar

newActionResponseBuilder()

Retornar

newActionStatus()

Retornar

newAttachment()

Retornar

newAuthorizationAction()

Retornar

newAuthorizationException()

Retornar

newBorderStyle()

Retornar

newButtonSet()

Retornar

newCalendarEventActionResponseBuilder()

Retornar

newCardAction()

Retornar

newCardBuilder()

Retornar

newCardHeader()

Retornar

newCardSection()

Retornar

newCardWithId()

Retornar

newChatActionResponse()

Retornar

newChatResponseBuilder()

Retornar

newColumn()

newColumns()

Retornar

newComposeActionResponseBuilder()

Retornar

newDatePicker()

Retornar

newDateTimePicker()

Retornar

newDecoratedText()

Retornar

newDialog()

Retornar

newDialogAction()

Retornar

newDivider()

Retornar

newDriveItemsSelectedActionResponseBuilder()

Retornar

newEditorFileScopeActionResponseBuilder()

Retornar

newFixedFooter()

Retornar

newGrid()

Retornar

newGridItem()

Retornar

newIconImage()

Retornar

newImage()

Retornar

newImageButton()

Retornar

newImageComponent()

Retornar

newImageCropStyle()

Retornar

newKeyValue()

Retornar

newLinkPreview()

Retornar

newNavigation()

Retornar

newNotification()

`newAction()`

`newActionResponseBuilder()`

`newActionStatus()`

`newAttachment()`

`newAuthorizationAction()`

`newAuthorizationException()`

`newBorderStyle()`

`newButtonSet()`

`newCalendarEventActionResponseBuilder()`

`newCardAction()`

`newCardBuilder()`

`newCardHeader()`

`newCardSection()`

`newCardWithId()`

`newChatActionResponse()`

`newChatResponseBuilder()`

`newColumn()`

`newColumns()`

`newComposeActionResponseBuilder()`

`newDatePicker()`

`newDateTimePicker()`

`newDecoratedText()`

`newDialog()`

`newDialogAction()`

`newDivider()`

`newDriveItemsSelectedActionResponseBuilder()`

`newEditorFileScopeActionResponseBuilder()`

`newFixedFooter()`

`newGrid()`

`newGridItem()`

`newIconImage()`

`newImage()`

`newImageButton()`

`newImageComponent()`

`newImageCropStyle()`

`newKeyValue()`

`newLinkPreview()`

`newNavigation()`

`newNotification()`

`newOpenLink()`

`newSelectionInput()`

`newSuggestions()`

`newSuggestionsResponseBuilder()`

`newSwitch()`

`newTextButton()`

`newTextInput()`

`newTextParagraph()`

`newTimePicker()`

`newUniversalActionResponseBuilder()`

`newUpdateDraftActionResponseBuilder()`

`newUpdateDraftBccRecipientsAction()`

`newUpdateDraftBodyAction()`

`newUpdateDraftCcRecipientsAction()`

`newUpdateDraftSubjectAction()`

`newUpdateDraftToRecipientsAction()`

`newValidation()`