此页面由 Cloud Translation API 翻译。

widget

widget 是一种界面元素，可提供以下一项或多项功能：

其他微件的结构，例如卡片和版块
向用户显示的信息，例如文字和图片，或者
用于执行操作的功能，例如按钮、文本输入字段或复选框。

添加到卡片部分的一组 widget 定义了整个插件界面。这些 widget 在网站和移动设备上的外观和功能相同。参考文档介绍了构建 widget 集的几种方法。

插件 widget 通常分为三类：结构 widget、信息 widget 和用户互动 widget。

结构微件

结构微件为界面中使用的其他微件提供容器和组织。

按钮集 - 一个或多个文本或图片按钮的集合，按水平排列方式分组。
卡片：单个上下文卡片，包含一个或多个卡片部分。您可以通过配置卡片导航来定义用户如何在卡片之间移动。
卡片标题 - 给定卡片的标题。卡片标题可以包含标题、副标题和图片。如果该插件使用卡片操作和通用操作，则这些操作会显示在卡片标题中。
卡片版块：一组汇总的 widget，通过水平线与其他卡片版块分隔开来，并且可以选择是否添加版块标题。每张卡片都必须至少包含一个卡片部分。您无法向卡片部分添加卡片或卡片标题。

结构微件

除了这些基本结构 widget 之外，您还可以在 Google Workspace 插件中使用卡片服务创建与当前卡片重叠的结构：固定页脚和预览卡片：

固定页脚

您可以将一排固定的按钮添加到卡片底部。此行不会随卡片内容的其余部分移动或滚动。

固定页脚微件示例

以下代码段展示了如何定义固定页脚示例并将其添加到卡片中：

var fixedFooter = CardService.newFixedFooter()
    .setPrimaryButton(
        CardService.newTextButton()
            .setText("Primary")
            .setOpenLink(CardService.newOpenLink()
                .setUrl("https://www.google.com")))
    .setSecondaryButton(
        CardService.newTextButton()
            .setText("Secondary")
            .setOnClickAction(
                CardService.newAction()
                    .setFunctionName(
                        "secondaryCallback")));

var card = CardService.newCardBuilder()
    // (...)
    .setFixedFooter(fixedFooter)
    .build();

预览卡

预览卡片示例

当用户执行某项操作（例如打开 Gmail 邮件）触发新的内容相关内容时，您可以立即显示新的内容相关内容（默认行为），也可以在边栏底部显示卡片通知。如果用户在情境触发器处于活跃状态时点击“返回”图标返回到首页，系统会显示一个预览卡片，以帮助用户重新找到情境内容。

如需在有新的情境内容可用时显示预览卡片（而不是立即显示新的情境内容），请将 .setDisplayStyle(CardService.DisplayStyle.PEEK) 添加到 CardBuilder 类。只有在您的情境触发器返回单个卡片对象时，才会显示预览卡片；否则，返回的卡片会立即替换当前卡片。

如需自定义预览卡的标题，请在构建情境卡片时添加包含标准 CardHeader 对象的 .setPeekCardHeader() 方法。默认情况下，预览卡片标题仅包含您的插件名称。

自定义预览卡片示例

以下代码基于 Cats Google Workspace 插件快速入门，使用 Peek 卡片通知用户有新的上下文内容，并自定义 Peek 卡片的标题以显示所选 Gmail 邮件会话的主题。

var peekHeader = CardService.newCardHeader()
    .setTitle('Contextual Cat')
    .setImageUrl('https://www.gstatic.com/images/
        icons/material/system/1x/pets_black_48dp.png')
    .setSubtitle(text);

. . .

var card = CardService.newCardBuilder()
    .setDisplayStyle(CardService.DisplayStyle.PEEK)
    .setPeekCardHeader(peekHeader);

信息微件

信息 widget 会向用户显示信息。

图片 - 由您提供的已托管且可公开访问的网址表示的图片。
DecoratedText - 文本内容字符串，可与其他元素（例如顶部和底部文本标签）以及图片或图标搭配使用。DecoratedText widget 还可以包含 Button 或 Switch widget。添加的开关可以是切换开关或复选框。DecoratedText 微件的文本内容可以使用 HTML 格式；顶部和底部的标签必须使用纯文本。
文本段落 - 文本段落，可以包含采用 HTML 格式的元素。

信息微件

用户互动微件

借助用户互动微件，插件可以响应用户执行的操作。您可以通过操作响应配置这些微件，以显示不同的卡片、打开网址、显示通知、撰写电子邮件草稿或运行其他 Apps Script 函数。如需了解详情，请参阅构建互动式卡片指南。

卡片操作 - 放置在插件标题栏菜单中的菜单项。标题栏菜单还可以包含定义为通用操作的项，这些项会显示在该插件定义的每个卡片上。
日期时间选择器 - 一种微件，可让用户选择日期和/或时间。如需了解详情，请参阅下文的日期和时间选择器。
图片按钮 - 使用图片而非文本的按钮。您可以使用多个预定义图标中的任意一个，也可以使用由网址指明的公开托管的图片。
选择输入 - 表示一组选项的输入字段。选择输入微件以复选框、单选按钮或下拉选择框的形式呈现。
开关 - 一个开关 widget。开关只能与 DecoratedText widget 搭配使用。默认情况下，这些按钮会显示为切换开关，但您也可以将其显示为复选框。
文本按钮 - 带文本标签的按钮。您可以为文本按钮指定背景颜色填充（默认为透明）。您还可以根据需要停用该按钮。
文本输入 - 文本输入字段。该微件可以包含标题文本、提示文本和多行文本。该微件可以在文本值发生变化时触发操作。
网格 - 表示一组项的多列布局。您可以使用图片、标题、副标题以及边框和剪裁样式等一系列自定义选项来表示内容。

`DecoratedText` 复选框

您可以定义一个附带复选框的 DecoratedText widget，而不是按钮或二进制切换开关。与开关一样，复选框的值包含在通过 setOnClickAction(action) 方法传递给此 DecoratedText 所附的 Action 的操作事件对象中。

带装饰文本的复选框微件示例

以下代码段展示了如何定义复选框 DecoratedText widget，然后将其添加到卡片中：

var decoratedText = CardService.newDecoratedText()
    // (...)
    .setSwitch(CardService.newSwitch()
        .setFieldName('form_input_switch_key')
        .setValue('switch_is_on')
        .setControlType(
            CardService.SwitchControlType.CHECK_BOX));

日期和时间选择器

您可以定义允许用户选择时间和/或日期的 widget。您可以使用 setOnChangeAction() 指定一个 widget 处理脚本函数，以便在选择器的值发生变化时执行该函数。

自定义预览卡片示例

以下代码段展示了如何定义仅限日期的选择器、仅限时间的选择器和日期时间选择器，然后将其添加到卡片中：

var dateOnlyPicker = CardService.newDatePicker()
    .setTitle("Enter a date")
    .setFieldName("date_field")
    // Set default value as May 24 2019. Either a
    // number or string is acceptable.
    .setValueInMsSinceEpoch(1558668600000)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleDateChange"));

var timeOnlyPicker = CardService.newTimePicker()
    .setTitle("Enter a time")
    .setFieldName("time_field")
    // Set default value as 23:30.
    .setHours(23)
    .setMinutes(30)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleTimeChange"));

var dateTimePicker = CardService.newDateTimePicker()
    .setTitle("Enter a date and time")
    .setFieldName("date_time_field")
    // Set default value as May 24 2019 03:30 AM UTC.
    // Either a number or string is acceptable.
    .setValueInMsSinceEpoch(1558668600000)
    // EDT time is 4 hours behind UTC.
    .setTimeZoneOffsetInMins(-4 * 60)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleDateTimeChange"));

以下是日期时间选择器 widget 处理脚本函数示例。此处理脚本会格式化并记录一个字符串，表示用户在 ID 为“myDateTimePickerWidgetID”的日期时间选择器微件中选择的日期时间：

function handleDateTimeChange(event) {
  var dateTimeInput =
    event.commonEventObject.formInputs["myDateTimePickerWidgetID"];
  var msSinceEpoch = dateTimeInput.msSinceEpoch;
  var hasDate = dateTimeInput.hasDate;
  var hasTime = dateTimeInput.hadTime;

  // The following requires you to configure the add-on to read user locale
  // and timezone.
  // See https://developers.google.com/workspace/add-ons/how-tos/access-user-locale
  var userTimezoneId = event.userTimezone.id;

  // Format and log the date-time selected using the user's timezone.
  var formattedDateTime;
  if (hasDate && hasTime) {
    formattedDateTime = Utilities.formatDate(
      new Date(msSinceEpoch), userTimezoneId, "yyy/MM/dd hh:mm:ss");
  } else if (hasDate) {
    formattedDateTime = Utilities.formatDate(
      new Date(msSinceEpoch), userTimezoneId, "yyy/MM/dd")
      + ", Time unspecified";
  } else if (hasTime) {
    formattedDateTime = "Date unspecified, "
      + Utilities.formatDate(
          new Date(msSinceEpoch), userTimezoneId, "hh:mm a");
  }

  if (formattedDateTime) {
    console.log(formattedDateTime);
  }
}

下表显示了桌面设备和移动设备上的选择器选择界面示例。选择后，日期选择器会打开基于月份的日历界面，以便用户快速选择新日期。

当用户在桌面设备上选择时间选择器时，系统会打开一个下拉菜单，其中包含以 30 分钟为增量分隔的时间列表，供用户选择。用户还可以输入具体时间。在移动设备上，选择时间选择器会打开内置的移动“时钟”时间选择器。

桌面设备	移动设备

网格

使用网格微件在多列布局中显示内容。每个项都可以显示图片、标题和副标题。您可以使用其他配置选项来设置文本相对于网格项中图片的位置。

您可以使用一个标识符配置网格项，该标识符会作为参数返回给网格上定义的操作。

网格 widget 示例

var gridItem = CardService.newGridItem()
  .setIdentifier("item_001")
  .setTitle("Lucian R.")
  .setSubtitle("Chief Information Officer")
  .setImage(imageComponent);

var cropStyle = CardService.newImageCropStyle()
  .setImageCropType(CardService.ImageCropType.RECTANGLE_4_3);

var imageComponent = CardService.newImageComponent()
  .setImageUrl("https://developers.google.com/workspace/
      images/cymbal/people/person1.jpeg")
  .setCropStyle(cropStyle)

var grid = CardService.newGrid()
  .setTitle("Recently viewed")
  .addItem(gridItem)
  .setNumColumns(2)
  .setOnClickAction(CardService.newAction()
    .setFunctionName("handleGridItemClick"));

文本格式

某些基于文本的 widget 可以支持简单的文本 HTML 格式。设置这些 widget 的文本内容时，只需添加相应的 HTML 标记即可。

下表显示了支持的标记及其用途：

格式	示例	呈现的结果
粗体	`"This is <b>bold</b>."`	此文本为粗体。
斜体	`"This is <i>italics</i>."`	这是斜体。
下划线	`"This is <u>underline</u>."`	这是下划线。
删除线	`"This is <s>strikethrough</s>."`	这是~~删除线~~。
字体颜色	`"This is <font color=\"#FF0000\">red font</font>."`	这是红色字体。
超链接	`"This is a <a href=\"https://www.google.com\">hyperlink</a>."`	这是一条超链接。
时间	`"This is a time format: <time>2023-02-16 15:00</time>."`	时间格式为：2023-02-16 15:00。
换行符	`"This is the first line. <br> This is a new line.`"	这是第一行。这是新行。

widget

微件类型

结构微件

固定页脚

预览卡

信息微件

用户互动微件

DecoratedText 复选框

日期和时间选择器

网格

文本格式

`DecoratedText` 复选框