Package google.apps.script.type

目次

AddOnWidgetSet

アドオンで使用されるウィジェットのサブセット。

フィールド
usedWidgets[]

WidgetType

アドオンで使用されるウィジェットのリスト。

WidgetType

ウィジェットのタイプ。WIDGET_TYPE_UNSPECIFIED は基本ウィジェット セットです。

列挙型
WIDGET_TYPE_UNSPECIFIED デフォルトのウィジェット セット。
DATE_PICKER 日付選択ツール。
STYLED_BUTTONS スタイル付きボタンには、塗りつぶしボタンと無効化されたボタンがあります。
PERSISTENT_FORMS 永続フォームを使用すると、アクション中にフォームの値を保持できます。
UPDATE_SUBJECT_AND_RECIPIENTS 下書きの件名と受信者を更新する。
GRID_WIDGET グリッド ウィジェット。
ADDON_COMPOSE_UI_ACTION アドオンの作成 UI に適用される Gmail アドオン アクション。

CommonAddOnManifest

すべてのアドオン ホスト アプリケーションで共有されるアドオン構成。

フィールド
name

string

必須。アドオンの表示名。
logoUrl

string

必須。アドオン ツールバーに表示されるロゴ画像の URL。
layoutProperties

LayoutProperties

アドオンカードの一般的なレイアウト プロパティ。
addOnWidgetSet

AddOnWidgetSet

アドオンで使用されるウィジェット。このフィールドが指定されていない場合は、デフォルトのセットが使用されます。
useLocaleFromApp

bool

ホストアプリからロケール情報を渡すかどうか。
homepageTrigger

HomepageExtensionPoint

任意のコンテキスト、任意のホストで実行されるエンドポイントを定義します。この関数によって生成されたカードは常にユーザーに表示されますが、このアドオンでよりターゲットを絞ったトリガーが宣言されている場合、コンテキスト コンテンツによってカードが隠れる可能性があります。
universalActions[]

UniversalActionExtensionPoint

アドオンの設定メニューとして機能するユニバーサル アクション メニューで拡張ポイントのリストを定義します。拡張ポイントには、開くリンク URL か、フォームの送信として実行するエンドポイントを指定できます。
openLinkUrlPrefixes

ListValue

OpenLink アクションでは、HTTPS、MAILTO、または TEL スキームの URL のみを使用できます。HTTPS リンクの場合、URL は許可リストで指定されているプレフィックスのいずれかと一致している必要があります。接頭辞でスキームを省略すると、HTTPS であると見なされます。HTTP リンクは自動的に HTTPS リンクに書き換えられます。

CreateActionExtensionPoint

ユーザーが Google Workspace アプリケーションでリソース作成ワークフローを呼び出したときに配信されるトリガーの構成。詳細については、@ メニューからサードパーティ リソースを作成するをご覧ください。

フィールド
id

string

必須。この拡張ポイントを区別するための一意の ID。ID は最大 64 文字で、[a-zA-Z0-9-]+ の形式にする必要があります。
labelText

string

必須。リソース作成のエントリ ポイントのアイコンと一緒に表示されるテキスト（Create support case など）。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。
localizedLabelText

map<string, string>

（省略可）他の言語にローカライズするための labelText の地図。言語は ISO 639 形式で、国 / 地域は ISO 3166 で指定します。国 / 地域はハイフン（-）で区切って指定します。例: en-US。

ユーザーの言語 / 地域が地図のキーに存在する場合、ローカライズされたバージョンの labelText がユーザーに表示されます。
runFunction

string

必須。リソース作成ワークフローがトリガーされてリンクが作成されるときに実行されるエンドポイント。
logoUrl

string

（省略可）リソース作成のエントリ ポイントに表示されるアイコン。省略した場合、メニューにはアドオンのツールバー アイコン logoUrl が使用されます。

HomepageExtensionPoint

アドオンのホームページ ビューを宣言するための一般的な形式です。

フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。
enabled

BoolValue

（省略可）false に設定すると、このコンテキストでホームページ ビューが無効になります。

設定しない場合のデフォルトは true です。

アドオンのカスタム ホームページ ビューが無効になっている場合は、代わりに汎用の概要カードが表示されます。

HttpAuthorizationHeader

アドオンの HTTP リクエストで送信される認証ヘッダー。

列挙型
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED デフォルト値。SYSTEM_ID_TOKEN と同等。
SYSTEM_ID_TOKEN プロジェクト固有の Google Workspace アドオンのシステム サービス アカウントの ID トークンを送信します（デフォルト）。
USER_ID_TOKEN エンドユーザーの ID トークンを送信します。
NONE Authentication ヘッダーを送信しないでください。

HttpOptions

アドオンの HTTP エンドポイントにリクエストを送信するためのオプション。

フィールド
authorizationHeader

HttpAuthorizationHeader

HTTP Authorization ヘッダーで送信されるトークンの構成。

LayoutProperties

すべてのアドオン ホスト アプリケーションで共有されるカード レイアウト プロパティ。

フィールド
primaryColor

string

アドオンのメインの色。ツールバーの色を設定します。プライマリ カラーが設定されていない場合は、フレームワークで指定されたデフォルト値が使用されます。
secondaryColor

string

アドオンのセカンダリ カラー。ボタンの色を設定します。プライマリ カラーは設定されているがセカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークで指定されたデフォルト値が使用されます。
useNewMaterialDesign

bool

カードのマテリアル デザインを有効にします。

LinkPreviewExtensionPoint

ユーザーがサードパーティまたは Google 以外のサービスから Google ドキュメント、スプレッドシート、スライドのファイルにリンクを入力または貼り付けたときに配信されるトリガーの構成。

フィールド
labelText

string

必須。リンクのプレビューをユーザーに促すスマートチップの例のテキスト（Example: Support case など）。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。
localizedLabelText

map<string, string>

（省略可）他の言語にローカライズするための labelText の地図。言語は ISO 639 形式で、国 / 地域は ISO 3166 で指定します。国 / 地域はハイフン（-）で区切って指定します。例: en-US。

ユーザーの言語 / 地域が地図のキーに存在する場合、ローカライズされたバージョンの labelText がユーザーに表示されます。
patterns[]

UriPattern

必須。リンクをプレビューするためにアドオンをトリガーする URL パターンの配列。
runFunction

string

必須。リンク プレビューがトリガーされたときに実行されるエンドポイント。
logoUrl

string

（省略可）スマートチップとプレビュー カードに表示されるアイコン。省略した場合、アドオンではツールバー アイコン logoUrl が使用されます。

ホストアプリ内に表示されるメニュー項目またはボタンを宣言するための一般的な形式。

フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。
label

string

必須。この拡張ポイントを有効にして行った操作を説明する、ユーザーに表示されるテキスト。（例: 「請求書を挿入」）。
logoUrl

string

アドオン ツールバーに表示されるロゴ画像の URL。

設定しない場合、アドオンのメインロゴの URL がデフォルトで使用されます。

UniversalActionExtensionPoint

ユニバーサル アクション メニュー項目の拡張ポイントを宣言するための形式です。

フィールド
label

string

必須。この拡張ポイントを有効にして行った操作を説明する、ユーザーに表示されるテキスト（「新しい連絡先を追加」など）。
共用体フィールド action_type。必須。ユニバーサル アクション メニュー項目でサポートされているアクション タイプ。開くリンクまたは実行するエンドポイントを指定できます。action_type は次のいずれかになります。
runFunction

string

UniversalAction によって実行されるエンドポイント。

UriPattern

リンク プレビューをトリガーする各 URL パターンの設定。

フィールド
hostPattern

string

プレビューするには、各 URL パターンに必要です。URL パターンのドメイン。URL にこのドメインを含むリンクをプレビューします。特定のサブドメイン（subdomain.example.com など）のリンクをプレビューするには、サブドメインを含めます。ドメイン全体のリンクをプレビューするには、ワイルドカード文字とアスタリスク（*）をサブドメインとして指定します。

たとえば、*.example.com は subdomain.example.com および another.subdomain.example.com と一致します。
pathPrefix

string

（省略可）hostPattern のドメインを追加するパス。

たとえば、URL ホストパターンが support.example.com の場合、support.example.com/cases/ でホストされているケースの URL を照合するには、「cases」と入力します。

ホストパターン ドメイン内のすべての URL を照合する場合は、pathPrefix を空のままにします。