Se usó la API de Cloud Translation para traducir esta página.

Class TextButton

Un TextButton con una etiqueta de texto Puedes establecer el color de fondo y desactivar el botón cuando sea necesario.

Disponible para los complementos de Google Workspace y las apps de Google Chat.

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setAltText(altText)`	`TextButton`	Establece el texto alternativo del botón para la accesibilidad.
`setAuthorizationAction(action)`	`TextButton`	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
`setBackgroundColor(backgroundColor)`	`TextButton`	Establece el color de fondo del botón `TextButtonStyle.FILLED`.
`setComposeAction(action, composedEmailType)`	`TextButton`	Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto.
`setDisabled(disabled)`	`TextButton`	Establece si el botón está inhabilitado.
`setIcon(icon)`	`TextButton`	Establece un `Icon` predefinido para que se muestre en el botón.
`setIconUrl(url)`	`TextButton`	Establece la URL de una imagen para usarla como ícono de este botón.
`setMaterialIcon(icon)`	`TextButton`	Establece el ícono de material design.
`setOnClickAction(action)`	`TextButton`	Establece una acción que se ejecuta cuando se hace clic en el objeto.
`setOnClickOpenLinkAction(action)`	`TextButton`	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
`setOpenLink(openLink)`	`TextButton`	Establece una URL que se abrirá cuando se haga clic en el objeto.
`setOverflowMenu(menu)`	`TextButton`	Establece un menú emergente que se abrirá cuando se haga clic en el objeto.
`setText(text)`	`TextButton`	Establece el texto que se muestra en el botón.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Establece el estilo del botón.

Documentación detallada

`setAltText(altText)`

Establece el texto alternativo del botón para la accesibilidad. Si no se configura, el valor predeterminado es el texto que se muestra en el botón.

Parámetros

Nombre	Tipo	Descripción
`altText`	`String`	Es el texto alternativo que se asignará a este botón.

Volver

TextButton: Este objeto, para encadenar.

`setAuthorizationAction(action)`

Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y vuelve a la aplicación, se vuelve a cargar el complemento.

Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) establecido.

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parámetros

Nombre	Tipo	Descripción
`action`	`AuthorizationAction`	Es el objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento.

Volver

TextButton: Este objeto, para encadenar.

`setBackgroundColor(backgroundColor)`

Establece el color de fondo del botón TextButtonStyle.FILLED. Si no se establece para un botón TextButtonStyle.FILLED, el botón usa el color secundario definido en el manifest del complemento. Este método no realiza ninguna acción para los botones TextButtonStyle.OUTLINED.

Parámetros

Nombre	Tipo	Descripción
`backgroundColor`	`String`	Es el color en formato #rgb.

Volver

TextButton: Este objeto, para encadenar.

`setComposeAction(action, composedEmailType)`

Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto. Un objeto de IU solo puede tener uno de los siguientes elementos configurados: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ComposeActionResponse configurado con ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: Este método no establece una acción de Compose que se use para extender la IU de Compose. En cambio, este método conecta este elemento de la IU a un Action que compone borradores de mensajes en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parámetros

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de composición que se debe realizar cuando se hace clic en este elemento.
`composedEmailType`	`ComposedEmailType`	Un valor de enumeración que especifica si el borrador compuesto es independiente o de respuesta.

Volver

TextButton: Este objeto, para encadenar.

`setDisabled(disabled)`

Establece si el botón está inhabilitado. Un botón inhabilitado se muestra de color gris y no se puede hacer clic en él.

Parámetros

Nombre	Tipo	Descripción
`disabled`	`Boolean`	Es el estado inhabilitado.

Volver

TextButton: Este objeto, para encadenar.

`setIcon(icon)`

Establece un Icon predefinido para que se muestre en el botón. Se debe usar esto o setIconUrl(url) para definir la imagen del botón.

Parámetros

Nombre	Tipo	Descripción
`icon`	`Icon`	Uno de los valores `Icon` predefinidos.

Volver

TextButton: Este objeto, para encadenar.

`setIconUrl(url)`

Establece la URL de una imagen para usarla como ícono de este botón. Se debe usar esto o setIcon(icon) para definir la imagen del botón.

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	Es la dirección URL de una imagen alojada que se usará como ícono de este botón.

Volver

TextButton: Este objeto, para encadenar.

`setMaterialIcon(icon)`

Establece el ícono de material design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parámetros

Nombre	Tipo	Descripción
`icon`	`MaterialIcon`	El ícono de Material Design.

Volver

TextButton: Este objeto, para encadenar.

`setOnClickAction(action)`

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

Parámetros

Nombre	Tipo	Descripción
`action`	`Action`	Es la acción que se debe realizar cuando se hace clic en este elemento.

Volver

TextButton: Este objeto, para encadenar.

`setOnClickOpenLinkAction(action)`

Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. Usa esta función cuando se deba compilar la URL o cuando debas realizar otras acciones además de crear el objeto OpenLink. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse configurado con ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

Parámetros

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

TextButton: Este objeto, para encadenar.

`setOpenLink(openLink)`

Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando ya se conoce la URL y solo se necesita abrirla. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

Parámetros

Nombre	Tipo	Descripción
`openLink`	`OpenLink`	Un objeto `OpenLink` que describe la URL que se abrirá.

Volver

TextButton: Este objeto, para encadenar.

`setOverflowMenu(menu)`

Establece un menú emergente que se abrirá cuando se haga clic en el objeto. Cada elemento del menú puede especificar una acción que se activará cuando se haga clic en él. No se admiten menús anidados, las acciones de los elementos de menú no deben especificar un menú ampliado.

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parámetros

Nombre	Tipo	Descripción
`menu`	`OverflowMenu`	Es el objeto que especifica el menú ampliado que se mostrará cuando se haga clic en este elemento.

Volver

TextButton: Este objeto, para encadenar.

`setText(text)`

Establece el texto que se muestra en el botón.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el texto que aparece en el botón.

Volver

TextButton: Este objeto, para encadenar.

`setTextButtonStyle(textButtonStyle)`

Establece el estilo del botón. Si no se establece, el valor predeterminado es el botón TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parámetros

Nombre	Tipo	Descripción
`textButtonStyle`	`TextButtonStyle`	El estilo del botón.

Volver

TextButton: Este objeto, para encadenar.