Class KeyValue

ClaveValor

Obsoleto. Esta clase está obsoleta y no se debe usar en secuencias de comandos nuevas.

Esta clase dejó de estar disponible. En su lugar, usa DecoratedText.

Métodos

MétodoTipo de datos que se muestraDescripción breve
addEventAction(eventAction)WidgetAgrega la acción del evento que se puede realizar en el widget.
setAuthorizationAction(action)KeyValueEstablece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setComposeAction(action, composedEmailType)KeyValueEstablece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setId(id)WidgetEstablece el ID único asignado que se usa para identificar el widget que se modificará.
setOnClickAction(action)KeyValueEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)KeyValueEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)KeyValueEstablece una URL que se abrirá cuando se haga clic en el objeto.
setVisibility(visibility)WidgetEstablece la visibilidad del widget.

Documentación detallada

addEventAction(eventAction)

Agrega la acción del evento que se puede realizar en el widget.

Parámetros

NombreTipoDescripción
eventActionEventActionEs el EventAction que se agregará.

Volver

Widget: El 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. Esto abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.

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

// ...

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

Parámetros

NombreTipoDescripción
actionAuthorizationActionObjeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento.

Volver

KeyValue: Este objeto, para encadenar.


setComposeAction(action, composedEmailType)

Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de IU solo puede tener establecido uno de los valores 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).

// ...

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

// ...

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

Parámetros

NombreTipoDescripción
actionActionObjeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
composedEmailTypeComposedEmailTypeEs un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Volver

KeyValue: Este objeto, para encadenar.


setId(id)

Establece el ID único asignado que se usa para identificar el widget que se modificará. La mutación de widgets solo se admite en complementos.

Parámetros

NombreTipoDescripción
idStringEs el ID del widget, con un límite de 64 caracteres y en formato de `[a-zA-Z0-9-]+`.

Volver

Widget: 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 establecido uno de los siguientes valores: 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 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

NombreTipoDescripción
actionActionEs la acción que se debe realizar cuando se hace clic en este elemento.

Volver

KeyValue: 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 necesites realizar otras acciones además de crear el objeto OpenLink. Un objeto de IU solo puede tener establecido uno de los siguientes valores: 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 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

NombreTipoDescripción
actionActionObjeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

KeyValue: Este objeto, para encadenar.


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

Parámetros

NombreTipoDescripción
openLinkOpenLinkEs un objeto OpenLink que describe la URL que se abrirá.

Volver

KeyValue: Este objeto, para encadenar.


setVisibility(visibility)

Establece la visibilidad del widget. El valor predeterminado es "VISIBLE".

Parámetros

NombreTipoDescripción
visibilityVisibilityEs el Visibility del widget.

Volver

Widget: El objeto, para encadenar.

Métodos obsoletos