Class InsertWidget

A builder for InsertWidget objects. Developers cans insert a widget into a card by passing a InsertWidget to ModifyCard

Only available for Google Workspace add-ons that extend Google Workspace Studio.

Sample usage:

const newWidget = CardService.newDecoratedText().setText('New Widget');

const insertWidget = AddOnsResponseService.newInsertWidget()
                                          .insertAboveWidget('sample_id')
                                          .setWidget(newWidget);

const modifyCard = AddOnsResponseService.newModifyCard().setInsertWidget(insertWidget);

Methods

MethodReturn typeBrief description
insertAboveWidget(widgetId)InsertWidgetSets the widget ID, and the new widget is inserted above the widget with the given ID.
insertBelowWidget(widgetId)InsertWidgetSets the widget ID, and the new widget is inserted below the widget with the given ID.
setWidget(widget)InsertWidgetSets the Widget to be inserted.

Detailed documentation



Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.