Package google.apps.script.type

インデックス

• AddOnWidgetSet（メッセージ）
• AddOnWidgetSet.WidgetType（列挙型）
• CommonAddOnManifest（メッセージ）
• CreateActionExtensionPoint（メッセージ）
• GranularOauthPermissionSupport（列挙型）
• HomepageExtensionPoint（メッセージ）
• HttpAuthorizationHeader（列挙型）
• HttpOptions（メッセージ）
• LayoutProperties（メッセージ）
• LinkPreviewExtensionPoint（メッセージ）
• MenuItemExtensionPoint（メッセージ）
• UniversalActionExtensionPoint（メッセージ）
• UriPattern（メッセージ）

AddOnWidgetSet

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

フィールド
usedWidgets[]	WidgetType アドオンで使用されるウィジェットのリスト。

WidgetType

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

列挙型
WIDGET_TYPE_UNSPECIFIED	デフォルトのウィジェット セット。
DATE_PICKER	日付選択ツール。
STYLED_BUTTONS	スタイル付きボタンには、塗りつぶしボタンと無効化されたボタンがあります。
PERSISTENT_FORMS	永続フォームを使用すると、アクション中にフォームの値を保持できます。
FIXED_FOOTER	カードのフッターを固定しました。
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 が使用されます。

GranularOauthPermissionSupport

アドオンで Granular OAuth Consent が有効になっているかどうか。

列挙型
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED	デフォルト値。使用しないでください。
OPT_IN	アドオンで、きめ細かい OAuth の同意が有効になっている。
OPT_OUT	アドオンが、きめ細かい OAuth の同意からオプトアウトされている。

HomepageExtensionPoint

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

フィールド
runFunction	string 必須。この拡張ポイントが有効になったときに実行されるエンドポイント。
enabled	BoolValue 省略可。false に設定すると、このコンテキストでホームページ ビューが無効になります。 設定しない場合、デフォルトは true です。 アドオンのカスタム ホームページ ビューが無効になっている場合、代わりに汎用の概要カードがユーザーに表示されます。

HttpAuthorizationHeader

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

列挙型
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 ヘッダーで送信されるトークンの構成。
granularOauthPermissionSupport	GranularOauthPermissionSupport アドオンで Granular OAuth Consent が有効になっているかどうか。

LayoutProperties

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

フィールド
primaryColor	string アドオンのメインの色。ツールバーの色を設定します。プライマリ カラーが設定されていない場合は、フレームワークによって提供されるデフォルト値が使用されます。
secondaryColor	string アドオンのセカンダリ カラー。ボタンの色を設定します。プライマリ カラーが設定されていてもセカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークによって提供されるデフォルト値が使用されます。
useNewMaterialDesign (deprecated)	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 を使用します。

MenuItemExtensionPoint

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

フィールド
runFunction	string 必須。この拡張ポイントが有効になったときに実行されるエンドポイント。
label	string 必須。この拡張ポイントを有効にしたときに実行されるアクションを説明する、ユーザーに表示されるテキスト。（「請求書を挿入して。」など）。
logoUrl	string アドオンのツールバーに表示されるロゴ画像の URL。 設定しない場合、デフォルトはアドオンのメインロゴの URL です。

UniversalActionExtensionPoint

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

フィールド
label	string 必須。この拡張ポイントを有効にしたときに実行されるアクションを説明する、ユーザーに表示されるテキスト（「新しい連絡先を追加」など）。
共用体フィールド action_type。必須。ユニバーサル アクション メニュー アイテムでサポートされているアクション タイプ。開くリンクまたは実行するエンドポイントのいずれかになります。action_type は次のいずれかになります。
openLink	string UniversalAction によって開かれる URL。
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 を空白のままにします。