Documentation / Autodesk App Store Revit

Autodesk App Store Revit

プロフェッショナル開発者向け情報

このガイドは、Autodesk App Store でプラグインやその他のコンテンツ（無料版、試用版、有料版）を初めて公開する開発者やコンテンツ プロバイダを対象としています。このガイドでは、Autodesk App Store 向けの製品を作成する際にパブリッシャーが遵守すべきベスト プラクティスのガイドラインといくつかの要件を概説します。これらのガイドラインは、Autodesk App Store のユーザーが Store から複数の製品をダウンロードする際に、一貫した体験を提供できるようにするためのものです。

要件

初めてパブリッシャー登録を行う際には、Autodesk App Store での公開に必要な要件の詳細なリストが表示されます。以下の情報は、その概要です。内容に相違がある場合は、オンラインの Publisher Agreement が優先されます。

すべてのコンテンツ タイプ

その他の要件

オートデスクが必要とする情報の大部分は、コンテンツを申請する際に記入する Web フォームを介して収集されます。その際には、製品のダウンロードに含まれる、オンライン表示可能な HTML「クイック スタート」ページを生成するための情報も収集されます。

互換性

Revit® 2024 ソフトウェアに関連した製品（および Revit® 2024 ソフトウェアと一緒に使用可能な製品）であり、Revit® 2024 がサポートするすべての Windows オペレーティング・システム上で動作する必要があります。また、Revit® 2023｜2022｜2021｜2020｜2019 との互換性があることを記載することもできます。

ユーザー権限

ストア アプリの既定のユーザー権限は、Windows 7/8.1/10/11 管理者ユーザーです。インストーラの実行には、管理者権限が必要です。

製品の安定性

製品には安定性が必要です。不適切と見なされる動作が発生したり、Revit の動作が不適切に変更されるものであってはなりません。例えば、標準機能をブロックする、別のプラグインの機能をブロックする、データ消失の原因となるなどが該当します。

HTML ヘルプページ

アプリの申請時に提供するドキュメント情報は、標準形式の HTML ページの作成に使用されます。この情報によって、ユーザが製品の使用方法をすばやく理解できるようにする必要があります。この標準 HTML ドキュメントからは、追加情報（Web サイトに掲載された追加のヘルプ ファイルなど）を参照することができます。標準形式のHTMLページは、製品をストアに提出する際に提供する情報を使用して作成されます。

すぐに実行できる

製品はインストール後すぐに利用できる必要があります。ユーザーが手動でファイルをコピーまたは登録したり、Revit の設定（サポートパスなど）を手動で編集したりする作業をなくす必要があります。

ライセンスシステムを使用する場合は、ユーザーが製品をインストールするとすぐに実行できるようにする必要があります。つまり、あなたのアプリケーションは、インスタントアクティベーション(たとえば、オンラインアクティベーション)を可能にするか、あるいは、顧客にアクティベーション情報を送信するのに十分な時間の猶予期間を設けて、フル機能の使用を可能にしなければなりません。

スタンドアロン アプリケーションとその他のコンテンツ

Revit に統合されない製品には、追加要件はありません。該当する製品は、電子ブック、ビデオ チュートリアル、業界固有の計算ツールなどです。

プラグイン

追加要件

  • プラグインには、メイン コマンドにアクセスするためのリボン ボタンを備えている必要があります。アプリケーションに多数のボタンがある場合は、個別のカスタム リボン タブを使用することもできます。
  • ロード メカニズムにはアドイン マニフェストを使用する必要があります。

ファミリ ライブラリ

追加要件

ファミリ ライブラリ（.rfa ファイル形式）は、次のフォルダにインストールする必要があります。

Windows 7/8.1/10/11 (Revit 2019/2020/2021/2022/2023/2024 64-bit のみ): %PUBLIC%\Documents\Autodesk\Downloaded Content (通常 C:\Users\Public\Documents\Autodesk\Downloaded Content)

この場合も、オートデスク側でインストーラーを作成し、ライブラリがこの新しい場所で動作するように修正するお手伝いをします。

ファミリ ライブラリの場合は、Revit リボン バーにリボン ボタンを含める必要があります。リボン バー UI では、ファミリ ライブラリへのアクセスを提供するか、アクセス方法を説明するヘルプ ファイルを起動できる必要があります。

ガイドライン

Revit® 2019 | 2020 | 2021 | 2022 | 2023 | 2024 プラグインでバンドルおよび XML ファイルを使用する

既定の場所として、アドイン マニフェストは「すべてのユーザ」の次の場所に配置されます。:

%programdata%\Autodesk\ApplicationPlugins

プラグイン ファイルは、「<アプリケーション名>.bundle」フォルダに格納され、PackageContents.xml ファイル（アプリ用にオートデスク側で用意したインストーラによって作成されるファイル）は、アプリケーションに必要なコンテンツとともにこの .bundle フォルダに格納されます。:

PackageContents.xml には、インストーラについての情報を制御する他のタグ以外に次の xml タグが含まれ、バンドル フォルダ内の .addin マニフェストを追加で参照します。

<ComponentEntry ModuleName="./Contents/ADNPlugin-FileUpgrader.addin"

Revit 2019 | 2020 | 2021 | 2022 | 2023 | 2024 は、.bundle フォルダの内容を調べ、PackageContents.xml ファイルを読み込み、プラグインに関する Revit 専用の情報をさらに詳しく定義する「ModuleName」または .addin ファイルの場所を検索します。

Autodesk App Store で入手可能な無料のプラグインをいくつかダウンロードして、インストールされたアプリがどのように表示されるか、それらのフォーマットについて調べることができます。

特別な考慮事項

アプリやコンテンツに特別な要件があり、標準のインストーラ テンプレートでは対処できない場合は、オートデスクにお問い合わせください。

たとえば、シングルユーザにアプリの書き込みをするという特定の要件がある場合、現在のユーザにのみインストールを実行するインストーラを作成できます。

その他の特別なニーズによりカスタム インストールが必要な場合は、Windows Installer マージ モジュール(.msm)ファイルの形式でインストーラを提供できます。オートデスク側で、.msm ファイルをアプリ用に作成する Windows Installer (.msi)ファイルと結合します。このようなシナリオの例としては、使用するライセンス システムのレジストリ エントリへの書き込み、他のベンダの従属コンポーネントのインストール、カスタム スクリプトの実行などがあります。詳細は、appsubmissions@autodesk.com にお問い合わせください。

リボン アイテムでコンテキスト ヘルプ(F1 キーによるヘルプ)を使用する

Revit API では、コンテキスト ヘルプや F1 キーによるヘルプがサポートされています。Revit API ドキュメントの RibbonItem.SetContextualHelp() メソッドおよび ContextualHelp クラスを参照してください。Autodesk Apps Store で公開されているオートデスク プラグイン サンプル アプリは、F1 キーによるヘルプの実装方法の例として利用できます。

リボン アイテムに配置されたツールチップやコンテキスト ヘルプなどの Revit ヘルプと一貫性のあるヘルプ メカニズムを使用することをお勧めします。コンテキスト ヘルプでは、外部 URL へのリンク、ローカルにインストールされたヘルプ（CHM）ファイルの起動、Autodesk ヘルプ Wiki のトピックへのリンクなどのオプションを利用できます。

リボンを使用する

アプリケーションにはリボン要素の使用が要件になりますが、その方法はプラグインのデザインによって異なります。少なくとも、プラグインで定義されたメイン コマンドを呼び出すためのパネルか、ファミリ ライブラリの使用方法を説明するヘルプ ファイルを表示するパネルを、それぞれのプラグインまたはファミリ ライブラリの[アドイン]タブに追加する必要があります。

ただし、プラグインで複数のコマンドが定義されている場合は、ユーザがもっとも使いやすいようにプラグインのリボン レイアウトを作成する必要があります(たとえば、頻繁に使用するコマンドには大きなボタンを使用し、使用頻度が少ないコマンドには小さいボタンを使用する)。

  • 通常、パネルを 1 つのみインストールするプラグインの場合は、そのパネルを[アドイン]タブに追加します。

  • 複数のリボン バー パネルを作成するプラグインの場合は、そのプラグイン専用の新しいタブを作成すると便利です（可能であれば、プラグインの名前をタブ名に使用することをお勧めします）。

エンド ユーザ使用許諾契約

ADN チームによってアプリ用に作成されるインストーラには、アプリのインストール時に標準のエンド ユーザ使用許諾契約（EULA）を表示するためのボタンが含まれます。

注: この EULA は修正できません。アプリにユーザ独自の EULA を含める場合は、次のいずれかの方法を使用します。:

  • 標準の HTM ヘルプ ファイルのテキストから EULA を参照する。

  • アプリの初回起動時に EULA を表示し、アプリの使用開始前に EULA に同意するようユーザに求める。

ビデオ チュートリアル

次の一連のビデオでは、Autodesk App Store for Revit で Revit アプリを公開する手順をデモンストレーションを交えながら説明しています。

その他のリソース

追加情報

ADN チームは、Autodesk App Store でのパブリッシャーとしての成功を支援します。本ガイドラインおよび Autodesk App Store Publisher Center のその他のドキュメントをご確認の上、ご不明な点がございましたら、appsubmissions@autodesk.com までメールでお問い合わせください。