Class CardService

CardService

CardService permite crear tarjetas genéricas que se usan en diferentes productos de extensión de Google, como los complementos de Google Workspace.

A continuación, se muestra un ejemplo de una tarjeta de complementos.

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

También puedes devolver varias tarjetas de la siguiente manera:

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

A continuación, se muestra cómo definir una tarjeta con un encabezado, texto, una imagen y un elemento de menú:

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

Ejemplo de una tarjeta 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();

Propiedades

PropiedadTipoDescripción
BorderTypeBorderTypeLa enumeración BorderType.
ComposedEmailTypeComposedEmailTypeLa enumeración ComposedEmailType.
ContentTypeContentTypeLa enumeración ContentType.
GridItemLayoutGridItemLayoutLa enumeración GridItemLayout.
HorizontalAlignmentHorizontalAlignmentLa enumeración HorizontalAlignment.
IconIconLa enumeración Icon.
ImageCropTypeImageCropTypeLa enumeración ImageCropType.
ImageStyleImageStyleLa enumeración ImageStyle.
LoadIndicatorLoadIndicatorLa enumeración LoadIndicator.
OnCloseOnCloseLa enumeración OnClose.
OpenAsOpenAsLa enumeración OpenAs.
SelectionInputTypeSelectionInputTypeLa enumeración SelectionInputType.
TextButtonStyleTextButtonStyleLa enumeración TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeLa enumeración UpdateDraftBodyType.

Métodos

MétodoTipo de datos que se muestraDescripción breve
newAction()ActionCree una Action nueva
newActionResponseBuilder()ActionResponseBuilderCree una ActionResponseBuilder nueva
newActionStatus()ActionStatusCree una ActionStatus nueva
newAttachment()AttachmentCree una Attachment nueva
newAuthorizationAction()AuthorizationActionCree una AuthorizationAction nueva
newAuthorizationException()AuthorizationExceptionCree una AuthorizationException nueva
newBorderStyle()BorderStyleCree una BorderStyle nueva
newButtonSet()ButtonSetCree una ButtonSet nueva
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCree una CalendarEventActionResponseBuilder nueva
newCardAction()CardActionCree una CardAction nueva
newCardBuilder()CardBuilderCree una CardBuilder nueva
newCardHeader()CardHeaderCree una CardHeader nueva
newCardSection()CardSectionCree una CardSection nueva
newCardWithId()CardWithIdCree una CardWithId nueva
newChatActionResponse()ChatActionResponseCree una ChatActionResponse nueva
newChatResponseBuilder()ChatResponseBuilderCree una ChatResponseBuilder nueva
newComposeActionResponseBuilder()ComposeActionResponseBuilderCree una ComposeActionResponseBuilder nueva
newDatePicker()DatePickerCree una DatePicker nueva
newDateTimePicker()DateTimePickerCree una DateTimePicker nueva
newDecoratedText()DecoratedTextCree una DecoratedText nueva
newDialog()DialogCree una Dialog nueva
newDialogAction()DialogActionCree una DialogAction nueva
newDivider()DividerCree una Divider nueva
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCree una DriveItemsSelectedActionResponseBuilder nueva
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCree una EditorFileScopeActionResponseBuilder nueva
newFixedFooter()FixedFooterCree una FixedFooter nueva
newGrid()GridCree una Grid nueva
newGridItem()GridItemCree una GridItem nueva
newIconImage()IconImageCree una IconImage nueva
newImage()ImageCree una Image nueva
newImageButton()ImageButtonCree una ImageButton nueva
newImageComponent()ImageComponentCree una ImageComponent nueva
newImageCropStyle()ImageCropStyleCree una ImageCropStyle nueva
newKeyValue()KeyValueCree una KeyValue nueva
newNavigation()NavigationCree una Navigation nueva
newNotification()NotificationCree una Notification nueva
newOpenLink()OpenLinkCree una OpenLink nueva
newSelectionInput()SelectionInputCree una SelectionInput nueva
newSuggestions()SuggestionsCree una Suggestions nueva
newSuggestionsResponseBuilder()SuggestionsResponseBuilderCree una SuggestionsResponseBuilder nueva
newSwitch()SwitchCree una Switch nueva
newTextButton()TextButtonCree una TextButton nueva
newTextInput()TextInputCree una TextInput nueva
newTextParagraph()TextParagraphCree una TextParagraph nueva
newTimePicker()TimePickerCree una TimePicker nueva
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCree una UniversalActionResponseBuilder nueva
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCree una UpdateDraftActionResponseBuilder nueva
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCrea un UpdateDraftBccRecipientsAction nuevo.
newUpdateDraftBodyAction()UpdateDraftBodyActionCree una UpdateDraftBodyAction nueva
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCree una UpdateDraftCcRecipientsAction nueva
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCree una UpdateDraftSubjectAction nueva
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCree una UpdateDraftToRecipientsAction nueva

Documentación detallada

newAction()

Cree una Action nueva

Devolvedor

Action: Es una acción vacía.


newActionResponseBuilder()

Cree una ActionResponseBuilder nueva

Devolvedor

ActionResponseBuilder: Es un compilador de ActionResponse vacío.


newActionStatus()

Cree una ActionStatus nueva

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de Google Workspace.

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

Devolvedor

ActionStatus: Es un ActionStatus vacío.


newAttachment()

Cree una Attachment nueva

Devolvedor

Attachment: Es un archivo adjunto vacío.


newAuthorizationAction()

Cree una AuthorizationAction nueva

Devolvedor

AuthorizationAction: Es una AuthorizationAction vacía.


newAuthorizationException()

Cree una AuthorizationException nueva

Devolvedor

AuthorizationException: Es una AuthorizationException vacía.


newBorderStyle()

Cree una BorderStyle nueva

Devolvedor

BorderStyle: Es un BorderStyle vacío.


newButtonSet()

Cree una ButtonSet nueva

Devolvedor

ButtonSet: Es un ButtonSet vacío.


newCalendarEventActionResponseBuilder()


newCardAction()

Cree una CardAction nueva

Devolvedor

CardAction: Es una CardAction vacía.


newCardBuilder()

Cree una CardBuilder nueva

Devolvedor

CardBuilder: Es un compilador de tarjetas vacío.


newCardHeader()

Cree una CardHeader nueva

Devolvedor

CardHeader: Es un CardHeader vacío.


newCardSection()

Cree una CardSection nueva

Devolvedor

CardSection: Es una CardSection vacía.


newCardWithId()

Cree una CardWithId nueva Se usa para enviar una tarjeta en un mensaje de Google Chat. El ID de tarjeta es un identificador único para una tarjeta en un mensaje cuando se envían varias tarjetas.

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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);

Devolvedor

CardWithId: Es un CardWithId vacío.


newChatActionResponse()

Cree una ChatActionResponse nueva

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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);

Devolvedor

ChatActionResponse: Es un ChatActionResponse vacío.


newChatResponseBuilder()

Cree una ChatResponseBuilder nueva

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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();

Devolvedor

ChatResponseBuilder: Es un ChatResponseBuilder vacío.


newComposeActionResponseBuilder()

Cree una ComposeActionResponseBuilder nueva

Devolvedor

ComposeActionResponseBuilder: Es un compilador de ComposeActionResponse vacío.


newDatePicker()

Cree una DatePicker nueva

Devolvedor

DatePicker: Es un selector de fecha vacío.


newDateTimePicker()

Cree una DateTimePicker nueva

Devolvedor

DateTimePicker: Es un selector de fecha y hora vacío.


newDecoratedText()

Cree una DecoratedText nueva

Devolvedor

DecoratedText: Es un objeto DecoratedText vacío.


newDialog()

Cree una Dialog nueva

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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);

Devolvedor

Dialog: Es un Dialog vacío.


newDialogAction()

Cree una DialogAction nueva

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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)

Devolvedor

DialogAction: Es un DialogAction vacío.


newDivider()

Cree una Divider nueva En el siguiente ejemplo, se compila una tarjeta simple con 2 párrafos separados por un 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;
}

Devolvedor

Divider: Es un divisor.


newDriveItemsSelectedActionResponseBuilder()


newEditorFileScopeActionResponseBuilder()


newFixedFooter()

Cree una FixedFooter nueva

Devolvedor

FixedFooter: Es un FixFooter vacío.


newGrid()

Cree una Grid nueva

Devolvedor

Grid: Es una cuadrícula vacía.


newGridItem()

Cree una GridItem nueva

Devolvedor

GridItem: Es un GridItem vacío.


newIconImage()

Cree una IconImage nueva

Devolvedor

IconImage: Es una imagen de ícono vacía.


newImage()

Cree una Image nueva

Devolvedor

Image: Es una imagen vacía.


newImageButton()

Cree una ImageButton nueva

Devolvedor

ImageButton: Es un ImageButton vacío.


newImageComponent()

Cree una ImageComponent nueva

Devolvedor

ImageComponent: Un ImageComponent vacío.


newImageCropStyle()

Cree una ImageCropStyle nueva

Devolvedor

ImageCropStyle: Un ImageCropStyle vacío.


newKeyValue()

Cree una KeyValue nueva

Devolvedor

KeyValue: Es un par clave-valor vacío.


newNavigation()

Cree una Navigation nueva

Devolvedor

Navigation: Es un objeto Navigation vacío.


newNotification()

Cree una Notification nueva

Devolvedor

Notification: Es una notificación vacía.


Cree una OpenLink nueva

Devolvedor

OpenLink: Es un OpenLink vacío.


newSelectionInput()

Cree una SelectionInput nueva

Devolvedor

SelectionInput: Es un SelectionInput vacío.


newSuggestions()

Cree una Suggestions nueva

Devolvedor

Suggestions: Una sugerencia vacía.


newSuggestionsResponseBuilder()

Cree una SuggestionsResponseBuilder nueva

Devolvedor

SuggestionsResponseBuilder: Es un compilador de SuggestionsResponse vacío.


newSwitch()

Cree una Switch nueva

Devolvedor

Switch: Un interruptor vacío.


newTextButton()

Cree una TextButton nueva

Devolvedor

TextButton: Es un TextButton vacío.


newTextInput()

Cree una TextInput nueva

Devolvedor

TextInput: Es un TextInput vacío.


newTextParagraph()

Cree una TextParagraph nueva

Devolvedor

TextParagraph: Es un TextParagraph vacío.


newTimePicker()

Cree una TimePicker nueva

Devolvedor

TimePicker: Es un selector de hora vacío.


newUniversalActionResponseBuilder()

Cree una UniversalActionResponseBuilder nueva

Devolvedor

UniversalActionResponseBuilder: Es un compilador de UniversalActionResponse vacío.


newUpdateDraftActionResponseBuilder()

Cree una UpdateDraftActionResponseBuilder nueva

Devolvedor

UpdateDraftActionResponseBuilder: Es un UpdateDraftActionResponseBuilder vacío.


newUpdateDraftBccRecipientsAction()

Crea un UpdateDraftBccRecipientsAction nuevo.

Devolvedor

UpdateDraftBccRecipientsAction: Es un UpdateDraftBccRecipientsAction vacío.


newUpdateDraftBodyAction()

Cree una UpdateDraftBodyAction nueva

Devolvedor

UpdateDraftBodyAction: Es un UpdateDraftBodyAction vacío.


newUpdateDraftCcRecipientsAction()

Cree una UpdateDraftCcRecipientsAction nueva

Devolvedor

UpdateDraftCcRecipientsAction: Es un UpdateDraftCcRecipientsAction vacío.


newUpdateDraftSubjectAction()

Cree una UpdateDraftSubjectAction nueva

Devolvedor

UpdateDraftSubjectAction: Es un UpdateDraftSubjectAction vacío.


newUpdateDraftToRecipientsAction()

Cree una UpdateDraftToRecipientsAction nueva

Devolvedor

UpdateDraftToRecipientsAction: Es un UpdateDraftToRecipientsAction vacío.