Keyboard ALT + g to toggle grid overlay
Autodesk App Store - Revit 開発者向け情報
このガイドは、Autodesk App Store でプラグインやその他のコンテンツを無料版、体験版、有料版のいずれかで初めて公開する開発者およびコンテンツ プロバイダを対象としています。Autodesk App Store 向けに製品を作成する際のベスト プラクティス ガイドラインおよび満たす必要があるいくつかの要件について説明します。これらのガイドラインは、Autodesk App Store から複数の製品をダウンロードするユーザに一貫性のあるサービスを提供できるようにするためのものです。
要件
Autodesk App Store に初めてパブリッシャー登録を行う際には、ストアでの公開に必要な要件の詳細なリストが表示されます。以下は、Revit のみに適用される情報の要約です。
すべてのコンテンツ タイプ
オートデスクで必要となる開発者情報の大部分は、パブリッシャー システムで入力する製品申請フォームから収集されます。その際には、製品のダウンロードに含まれる、オンライン表示可能な HTML 形式のクイック スタート ページを自動生成するための情報も収集されます。その他の要件は次のとおりです。
-
互換性
Revit 2021 ソフトウェアに関連した製品（および Revit 2019 ソフトウェアで使用可能な製品）であり、Revit 2019 でサポートされている Windowsオペレーティング システムで動作する必要があります。また、Revit 2020/2019/2018 との互換性があることを記載することもできます。
-
HTML ヘルプ ページ
アプリの申請時に提供するドキュメント情報は、標準形式の HTML ページの作成に使用されます。この情報によって、ユーザが製品の使用方法をすばやく理解できるようにする必要があります。この標準ドキュメントから、追加情報（Web サイトに掲載された追加のヘルプ ファイルなど）を参照することができます。標準形式の HTML ページは、製品をストアに申請するときに提供する情報を使用して作成されます。これらの情報は、申請プロセス時に提供するよう求められます。
-
すぐに実行できる
製品は、インストール後すぐに実行できるようにする必要があります。手動によるファイルのコピーや登録をユーザに求めたり Revit の設定（サポート パスなど）の手動による編集をユーザに求めないようにしてください。
ライセンス システムを使用する場合は、ユーザによるインストール後、製品をすぐに実行できる必要があります。つまり、アプリケーションでインスタント アクティベーション（たとえば、オンライン アクティベーション）を実行できるようにするか、アプリケーションの全機能を一定期間利用できるようにし、その間にアクティベーション情報を顧客に送信するようにします。
-
ユーザ権限
ストア アプリの既定のユーザ権限は、Windows 7/8/8.1/10 管理者ユーザです。オートデスクによって作成されるインストーラには、上位のユーザ権限が必要です。アプリ インストーラに上位のユーザ権限を使用しない場合や、オートデスクが提供する標準のインストーラ テンプレートを使用しない場合は、ストアに表示される製品の説明にその旨を明確に記載する必要があります。
-
製品の安定性
製品には安定性が必要です。不適切と見なされる動作が発生したり、Revit の動作が不適切に変更されるものであってはなりません(標準機能をブロックする、別のプラグインの機能をブロックする、データ消失の原因となるなど)。
プラグイン
プラグインには次の追加要件があります。
-
- プラグインには、メイン コマンドにアクセスするためのリボン ボタンを備える必要があります。アプリケーションに多数のボタンがある場合は、個別のカスタム リボン タブを使用することもできます。
-
- ロード メカニズムにはアドイン マニフェストを使用する必要があります。
ファミリ ライブラリ
ファミリ ライブラリには次の追加要件があります。
-
- ファミリ ライブラリ（.rfa ファイル形式）は、次のフォルダにインストールする必要があります。
- Windows 7/8.1/10 (Revit 2018/2019/2020/2021 64-bit のみy): %PUBLIC%\Documents\Autodesk\Downloaded Content (通常 C:\Users\Public\Documents\Autodesk\Downloaded Content)
この場合も、オートデスク側でインストーラを作成できます。また、この新しい場所でライブラリが機能するようにライブラリを修正する際のサポートも提供します。
- ファミリ ライブラリ（.rfa ファイル形式）は、次のフォルダにインストールする必要があります。
-
- ファミリ ライブラリの場合は、Revit リボン バーにリボン ボタンを含める必要があります。リボン バー UI では、ファミリ ライブラリへのアクセスを提供するか、アクセス方法を説明するヘルプ ファイルを起動できる必要があります。
スタンドアロン アプリケーションとその他のコンテンツ
AutoCAD に統合されない製品には、追加要件はありません。該当する製品は、eBook、ビデオ チュートリアル、業種専用の計算ツールなどです。
ガイドライン
-
Revit 2018/2019/2020/2021 プラグインでバンドルおよび XML ファイルを使用する
既定の場所として、アドイン マニフェストは「すべてのユーザ」の次の場所に配置されます。
%programdata%\Autodesk\ApplicationPlugins
プラグイン ファイルは、「<アプリケーション名>.bundle」フォルダに格納され、PackageContents.xml ファイル（アプリ用に作成されたインストーラによって作成されるファイル）は、アプリケーションに必要なコンテンツとともにこの .bundle フォルダに格納されます。
PackageContents.xml には、インストーラについての情報を制御する他のタグ以外に次の xml タグが含まれ、バンドル フォルダ内の .addin マニフェストを追加で参照します。
<ComponentEntry ModuleName="./Contents/ADNPlugin-FileUpgrader.addin"
Revit 2018/2019/2020/2021 は、.bundle フォルダの内容を調べ、PackageContents.xml ファイルを読み込み、プラグインに関する Revit 専用の情報をさらに詳しく定義する「ModuleName」または .addin ファイルの場所を探します。
たとえば、.addin マニフェストとアセンブリ dll を Contents フォルダに配置する場合は、上述の xml タグによるフォルダ構造は次のようになります。
Autodesk App Store で入手可能な無料のプラグインをいくつかダウンロードして、インストールされたアプリがどのように表示されるか、それらのフォーマットについて調べることができます。
-
リボンを使用する
アプリケーションではリボン要素の使用が要件になりますが、その方法はプラグインの設計によって異なります。少なくとも、プラグインで定義されたメイン コマンドを呼び出すためのパネルか、ファミリ ライブラリの使用方法を説明するヘルプ ファイルを表示するパネルを、それぞれのプラグインまたはファミリ ライブラリの[アドイン]タブに追加する必要があります。
ただし、プラグインで複数のコマンドが定義されている場合は、ユーザがもっとも使いやすいようにプラグインのリボン レイアウトを作成する必要があります(たとえば、頻繁に使用するコマンドには大きなボタンを使用し、使用頻度が少ないコマンドには小さいボタンを使用する)。
- 通常、パネルを 1 つのみインストールするプラグインの場合は、そのパネルを[アドイン]タブに追加します。
- 複数のリボン バー パネルを作成するプラグインの場合は、そのプラグイン専用の新しいタブを作成すると便利です（可能であれば、プラグインの名前をタブ名に使用することをお勧めします）。
-
リボン アイテムでコンテキスト ヘルプ(F1 キーによるヘルプ)を使用する
Revit API では、コンテキスト ヘルプや F1 キーによるヘルプがサポートされています。Revit API ドキュメントの RibbonItem.SetContextualHelp() メソッドおよび ContextualHelp クラスを参照してください。Autodesk Apps ストアに投稿されているオートデスク プラグイン サンプル アプリは、F1 キーによるヘルプの実装方法の例として利用できます。
リボン アイテムに配置されたツールチップやコンテキスト ヘルプなどの Revit ヘルプと一貫性のあるヘルプ メカニズムを使用することをお勧めします。コンテキスト ヘルプでは、外部 URL へのリンク、ローカルにインストールされたヘルプ（CHM）ファイルの起動、Autodesk ヘルプ Wiki のトピックへのリンクなどのオプションを利用できます。
-
エンド ユーザ使用許諾契約
ADN チームによってアプリ用に作成されるインストーラには、アプリのインストール時に標準のエンド ユーザ使用許諾契約（EULA）を表示するためのボタンが含まれます。
注: この EULA は修正できません。アプリにユーザ独自の EULA を含める場合は、次のいずれかの方法を使用します。
- 標準の HTM ヘルプ ファイルのテキストから EULA を参照する、または
- アプリの初回起動時に EULA を表示し、アプリの使用開始前に EULA に同意するようユーザに求める
-
特別な考慮事項
アプリやコンテンツに特別な要件があり、標準のインストーラ テンプレートでは対処できない場合は、オートデスクにお問い合わせください。
たとえば、シングルユーザにアプリの書き込みをするという特定の要件がある場合、現在のユーザにのみインストールを実行するインストーラを作成できます。
その他の特別なニーズによりカスタム インストールが必要な場合は、Windows Installer マージ モジュール(.msm)ファイルの形式でインストーラを提供できます。オートデスク側で、.msm ファイルをアプリ用に作成する Windows Installer (.msi)ファイルと結合します。このようなシナリオの例としては、使用するライセンス システムのレジストリ エントリへの書き込み、他のベンダの従属コンポーネントのインストール、カスタム スクリプトの実行などがあります。詳細は、appsubmissions@autodesk.com にお問い合わせください。
-
ビデオ チュートリアル
以下の一連のビデオでは、Autodesk App Store for Autodesk Revit で Revit アプリを公開する手順をデモンストレーションを交えながら説明しています。
Autodesk App Store for Autodesk Revit
Revit アプリを Autodesk App Store で公開する
その他の役立つドキュメント
詳細情報
ADN チームは、Autodesk App Store にアプリを適切に公開するためのお手伝いをします。サポートが必要な場合は、いつでもお問い合わせください。ガイドラインやその他のドキュメントについてご不明な点がある場合、特定のガイドラインが掲載されていない製品向けにアプリを申請する場合は、appsubmissions@autodesk.com 宛てに電子メールでお問い合わせください。
Autodesk App Store をご利用いただきありがとうございます。
