Package google.apps.script.type

インデックス

• AddOnWidgetSet（メッセージ）
• AddOnWidgetSet.WidgetType（列挙型）
• CommonAddOnManifest（メッセージ）
• CreateActionExtensionPoint（メッセージ）
• 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 アクションで使用できる URL は、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 アドオンの 2 番目の色。ボタンの色を設定します。プライマリ カラーは設定されているがセカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークが提供するデフォルト値が使用されます。
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）が使用されます。

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 を空白のままにします。