パッケージ化と公開の拡張機能

Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019

拡張機能を開発したらVisual Studio Marketplace にパッケージ化して発行できます。 Marketplace は、Microsoft のプライベートおよびパブリック拡張機能、統合、およびその他のオファーのグローバル リポジトリです。

前提条件

Marketplace に発行する前に、次の要件の一覧を満たす必要があります。

発行元の作成

Microsoft からの拡張機能や統合を含め、すべての拡張機能または統合には発行元が必要です。 誰でもパブリッシャーを作成し、その下に拡張機能を発行できます。 また、開発チームなどの他のユーザーとパブリッシャー アクセスを共有することもできます。

1. Visual Studio Marketplace 発行ポータルにサインインします。

2. 既存のパブリッシャーの一部でない場合は、[ + 発行元の作成] を選択します。
   発行元名を入力します。ID フィールドは、入力に基づいて自動入力されます。

   

   注

   • 発行元名がマルチバイト文字の場合は 16 文字以内であることを確認します。
   • 発行元 ID を保存します。これは拡張機能のマニフェスト ファイルに必要です。

   発行元の作成を求めるメッセージが表示されない場合は、[関連サイト] の下の [拡張機能の発行] までスクロールします。

   • mycompany-myteamなど、一意の発行元識別子を設定します。 マニフェストの publisher 属性にこの値を使用します。
   • My Teamなどの表示名を設定します。

3. Marketplace パブリッシャー契約を確認し、[作成] を選択します。

   

発行元を作成した後は、アイテムを管理できますが、発行するまでアイテムは表示されません。

拡張機能をパッケージ化する

拡張機能をアップロードするには、VSIX 2.0 と互換性のある .vsix ファイルとしてパッケージ化します。 Microsoft では、拡張機能をパッケージ化して発行するためのクロスプラットフォーム コマンド ライン インターフェイス (CLI) を提供しています。

1. 拡張マニフェスト ファイル (vss-extension.json) を開き、 publisher フィールドの値を発行元の ID に設定します。 次に例を示します。

   {
       ...
       "id": "my-first-extension",
       "publisher": "AnnetteNielsen",
       ...
   }
   

2. コマンド プロンプトから、拡張機能ディレクトリから TFX ツールのパッケージ化コマンドを実行します。

   npx tfx-cli extension create
   

   拡張機能が正常にパッケージ化されたことを示すメッセージが表示されます。

   === Completed operation: create extension ===
   - VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix
   - Extension ID: my-first-extension
   - Extension Version: 1.0.0
   - Publisher: AnnetteNielsen
   

パッケージ のサイズを確認する

パッケージ化された vsix のサイズを確認します。 50 MB を超える場合は、最適化する必要があります。 これを行うには、次の考慮事項を参照してください。

• 一般的な依存関係を拡張パッケージに 1 回指定して重複除去します。
• パッケージに依存関係を含めるのではなく、実行時またはインストール時に依存関係をフェッチします。 ツール インストーラー ライブラリを使用して、実行時にツールの依存関係をプルすることを検討してください。 この方法では、プライベート エージェントのバージョン別にツールがキャッシュされ、すべてのビルドのダウンロードが防止されます。 ツール インストーラー ライブラリは、切断されたシナリオ (インターネットなし) では機能しません。これは、タスクの説明またはドキュメントで説明する必要があります。
• WebPack を使用して、タスクの依存関係をツリーでシェイクします。

拡張機能の公開

拡張機能がパッケージ化されたら、パブリッシャーの下の Marketplace にアップロードできます。 extension のマニフェスト ファイルで指定されたpublisher識別子拡張機能がアップロードされる発行元の識別子と一致している必要があります。

1. 管理ポータルからページの上部にあるドロップダウン メニューから発行元を選択します。

2. 新しい拡張機能>Azure DevOps を選択します。

   

3. ファイルをドラッグ アンド ドロップするか、選択して、前のパッケージ化手順で作成した VSIX ファイルを見つけて、[ アップロードを選択します。

   

   クイック検証の後、公開されている拡張機能の一覧に拡張機能が表示されます。 心配しないでください。拡張機能はユーザーにのみ表示されます。

   

この時点で、拡張機能はどのアカウントにも表示されません。 他のユーザーに表示できるようにするには、拡張機能を共有する必要があります。

拡張機能を共有する

Azure DevOps にインストールする前に、拡張機能を組織と共有します。 拡張機能を共有するには、次のタスクを実行します。

1. Marketplace 管理ポータルから一覧から拡張機能を選択し、右クリックして、拡張機能に応じて Share/Unshare または Publish/Unpublish を選択します。

   

2. Organization を選択し、組織の名前を入力します。 [Enter] を選択します。

   

3. パネルを閉じます。

拡張機能をこの組織にインストールできるようになりました。

拡張機能をインストールする

共有拡張機能をインストールするには、次の手順を実行します。

1. Marketplace で拡張機能を選択し、概要ページを開きます。

   

   注

   拡張機能はプライベートであるため、このページを表示できるのは、自分と共有している組織のメンバーだけです。

2. [無料 を選択して インストール プロセスを開始します。 ドロップダウン メニューから拡張機能を共有した組織を選択します。

   

3. [インストール] を選択します。

おめでとうございます。 拡張機能を組織にインストールし、試す準備ができました。

拡張機能を試す

1. インストール ウィザードの最後で Proceed to organization を選択して、拡張機能がインストールされた組織のホーム ページ (https://dev.azure.com/{organization}) に移動します。

2. ブラウザーを更新します。

3. Organization 設定を開き、Extensions を選択します。

   

Installed タブに新しい拡張機能が表示されます。

拡張機能をデバッグする

Visual Studio またはブラウザー開発者ツールを使用して拡張機能をデバッグするには、 baseUri プロパティを追加してマニフェストを変更します。 このアクションにより、ソース コードを変更するたびに拡張機能を再デプロイする必要なく、開発が高速化されます。

{
    ...
    "baseUri": "https://localhost:44300",
    ...
}

マニフェストを変更すると、ローカル Web サーバー インスタンスから拡張機能が読み込まれます。 たとえば、Visual Studio の IISExpress です。 マニフェストを変更した後、このデバッグ拡張機能を 1 回だけデプロイしてインストールします。

拡張機能を更新する

既に発行した拡張機能を更新するには、次の手順を実行します。

1. 表示される項目の一覧から拡張機能を選択します。
2. など、開発バージョンのpublisher.extension-devを右クリックして選択します。
3. 拡張機能を検証します。
4. publisher.extensionなど、運用環境のバージョンに同じ更新プログラムを適用します。
5. 拡張機能の .vsix ファイルを参照してアップロードします。

Azure DevOps は、既に拡張機能を持つすべてのアカウントの更新されたバージョンを自動的にインストールします。 新しいインストールも最新バージョンを受け取ります。

拡張機能をパブリックにする

Marketplace の拡張機能または統合を開発するときは、プライベートのままにします。 これにより、拡張機能の可視性が、共有している特定のアカウントに制限されます。

拡張機能をパブリックに使用できるようにするには、マニフェストで public フラグ を true に設定します。

適格性

Marketplace に公開登録するには、統合または拡張機能が次の条件を満たしている必要があります。

• Azure DevOps を使用または拡張します。
• お客様または貴社は、統合または拡張機能の配布とアドバタイズを行うライセンスを所有し、開発し、ライセンスを取得しています。
• 拡張機能または統合はアクティブに維持されます。

また、Microsoft はデモを要求し、Marketplace エントリ用に計画されているコンテンツを確認する場合もあります。

トップ パブリッシャー

トップ パブリッシャー プログラムは、Azure DevOps 拡張機能または統合を使用するパブリッシャーでのみ使用できます。 Visual Studio IDE および Visual Studio Code 拡張機能の発行元には適用されません。

トップ パブリッシャー プログラムは、模範的なポリシー、品質、信頼性、サポートを通じて、顧客と Marketplace に対するコミットメントを持つパブリッシャーを認識します。 トップ パブリッシャーになると、すべてのパブリック オファリングにトップ パブリッシャー バッジが表示されます。

パブリッシャーの上位要件

Marketplace のトップ パブリッシャー プログラムは、Azure DevOps 拡張機能と統合を自信を持って評価または取得できるように設計されています。 トップ パブリッシャー バッジは、発行元が模範的なポリシー、品質、信頼性、サポートを通じて顧客と Marketplace へのコミットメントを示していることを意味します。 これは、1 つ以上のグローバル Azure DevOps 拡張機能または統合を持つパブリッシャー向けであり、Visual Studio IDE および Visual Studio Code 拡張機能の発行元には適用されません。

Marketplace では、次のパラメーターでパブリッシャーを慎重に確認した後、バッジがパブリッシャーに割り当てられます。

• プライバシー ポリシー
• ライセンス ポリシー
• サポート ポリシー
• ドキュメント
• Q と応答性
• 商品とサービスの評価とレビュー
• 提案のアクティブな導入とインストール数
• Azure DevOps の少なくとも 1 つのパブリック拡張機能の管理
• 5,000 を超えるインストールとアクティブなインストール数が 1,000 を超えるパブリック拡張機能

トップ パブリッシャーから拡張機能を入手すると、タイムリーなサポートと全体的なエクスペリエンスが期待できます。 トップ パブリッシャーのオファリングを確認します。

オファリングにポリシーを追加する方法の詳細については、 extension マニフェストを参照してください。

1. 発行元プロファイルを更新します。

   パブリッシャー プロファイルを使用すると、すべてのオファリングを 1 か所で、主な発行元関連情報と共に紹介できます。 プロファイルに表示される情報を指定するには、次の手順を実行します。

   ある。 Visual Studio Marketplace でオファリングを発行および管理するアカウントを使用して、 https://marketplace.visualstudio.com/manage/publishers にサインインします。

   b。 発行元を選択し、Details タブの About you セクションに入力します。 c。 変更を保存し、 表示プロファイル を選択して、コンシューマーにどのように表示されるかを確認します。 このプロファイルページを利用して、オファリングを広めたり紹介したりできます。

トップ パブリッシャーに適用する

1. Marketplace 管理ポータルに、Marketplace でオファリングを発行および管理するアカウントを使用してサインインします。
2. 発行元を選択し、[ トップ パブリッシャー ] タブに移動します。タブが表示されるように、1 つ以上のグローバル Azure DevOps (サーバー/サービス) 拡張機能または統合を用意します。
3. 上記の要件を満たし、発行元の所有者である場合は、プログラムに申請できます。 アプリケーションが完了すると、Marketplace チームに電子メールが送信され、ケースが確認されます。 10 営業日以内に回答し、次のステップ、質問の明確化、バッジの付与を行います。

チームは、バッジを付与する前に、オファリングのアクティブな取り込み、インストール/開始カウント、オファリング全体の評価とレビューなど、他のパラメーターを検討している可能性があります。 Microsoft は、いつでもトップ パブリッシャー バッジの付与、拒否、または取り消しを行う権利を留保します。

パブリッシャーがトップ パブリッシャーになったら、今後のすべての更新プログラムとオファリングが、前述の要件を満たす必要があります。

Marketplace 拡張機能のレビューに応答する

Visual Studio Marketplace で拡張機能に対して顧客が残したレビューに応答できます。 所有者、作成者、共同作成者のいずれかのアクセス許可がある場合はレビューの横にある Reply を見つけて選択します。

応答は 1 つだけ残すことができます。 レビューをサポート フォーラムとして使用しないでください。 詳細が必要な場合は、校閲者が連絡するためのサポート エイリアスを指定してください。 その後、問題を外部で解決し、解決策を使用して返信を更新できます。

発行元の応答のガイドライン

Visual Studio Marketplace は、お客様が拡張機能を見つけ、試し、インストールし、確認するのに役立つ、オープンで招待的で、敬意を払い、役立つ場所のままにします。 コミュニケーションは、健全なコミュニティを維持する上で重要な役割を果たします。 この環境の作成に役立つ、顧客レビューに応答する発行元向けのガイドラインを次に示します。 顧客との対話について深く考え、Marketplace が作成しようとしているカスタマー エクスペリエンスの精神を振り返ります。

• レビューは顧客のコメントに限定してください。 Replyを使用してレビューに返信する必要があります。
• すべての顧客の意見を尊重します。 議論、非難、または口論なしでコメントをフィードバックとして受け入れます。
• 回答が価値を高め、顧客のコメントに関連していることを確認します。
• 質問や問題に正確に対処することに重点を置きます。 詳細が必要な場合は、レビューで話し合うのではなく、電子メールで連絡するように顧客に依頼してください。 問題を解決したら、解決策を使用して返信を更新します。 顧客がレビューを編集できるように、返信を編集できます。
• スパム、虐待、攻撃的なコンテンツなどの不適切なレビューに対して、Microsoft のレビューにフラグを設定します。

レビューを無効にする要求

発行元は、報告された問題が Marketplace または基になるプラットフォームが原因である場合は、レビューを無効にするよう訴えることができます。 問題が有効な場合、Marketplace 管理者は評価を無効にします。 拡張機能ハブ ページの評価とレビュー セクションからappeal をできます。

拡張機能の発行を取り消す

無料の拡張機能を Marketplace で提供しなくなった場合は、発行を取り消すことができます。

次のシナリオでは、Marketplace から拡張機能を削除することを検討してください。

• 新しい拡張機能を開発し、現在の拡張機能を提供する必要がなくなりました。
• 拡張機能に問題があり、問題を解決するまで Marketplace から削除する必要があります。
• 間違って拡張機能をパブリックとして公開しました。

拡張機能を非公開または削除するには、特定の条件を満たす必要があります。

1. publisher ページで拡張機能を選択しメニューの Unpublish を選択します。

   拡張機能は Marketplace から直ちに非公開になり、新しいユーザーはそれをインストールできません。 拡張機能の評価とレビューはそのまま残ります。

Marketplace で拡張機能をもう一度提供するには、メニューから [発行 ] を選択します。

拡張機能にインストールがゼロの場合は、Marketplace から完全に削除することを選択できます。 これを行うには、メニューから [削除 ] を選択します。 このアクションを元に戻すことはできません。

拡張機能レポート ハブ

拡張機能を Visual Studio Marketplace で使用できるようになったら、 レポート 機能を使用できます。 この機能を使用すると、拡張機能のパフォーマンスを追跡して分析し、必要なアクションを実行できます。 拡張機能ハブにアクセスするには、 発行元ページ を参照して拡張機能を選択するか、拡張機能の詳細ページの [レポート] リンクを選択します。

取得

選択した期間の取得関連データをこのタブで表示できます。

• 選択した期間の総合取得の集計
• 拡張機能のダウンロードによって分割された集計取得データは、Azure DevOps に接続されている無料拡張機能用のインストールを表します。
• 試用版ごとに分割された Azure DevOps の有料拡張機能に対する接続購入の集計取得
• Azure DevOps と接続されたサーバーの取得による拡張機能ページ ビューの毎日の傾向
• ページ ビューから取得への変換率

有料拡張機能の場合、購入と試用版のすべてのトランザクションの詳細は、日付、組織名、試用終了日、数量で利用できます。 [連絡先] アクションを使用して、ユーザーと通信できます。 詳細については、この記事で後述する 「連絡先」 セクションを参照してください。

[アンインストール]

次の統計情報を表示できます。

• 拡張機能をアンインストールした組織の数
• アンインストール拡張機能の毎日の傾向
• アンインストール中に共有される詳細なフィードバック
• アンインストールの主な理由

テキストと日付の検索を使用して、詳細なフィードバックからより多くの分析情報を分析して引き出すことができます。

有料の拡張機能の場合は、[ 連絡先 ] アクションを使用してユーザーと通信できます。 詳細については、この記事で後述する「お問い合わせ」セクションを参照してください。

評価とレビュー

このタブには、次の情報が表示されます。

• 選択した期間の平均評価と総合評価
• レビュー担当者数別の平均評価
• 平均評価の毎日の傾向

詳細セクションには、トランザクション ビューのすべてのレビューと応答が表示されます。

レビューに 返信 したり、以前の返信を 編集 したりして、拡張機能ユーザーとのエンゲージメントをより適切に管理できます。 また、報告された問題が Marketplace または基になるプラットフォームが原因である場合は、評価を無効にするよう 訴 えることができます。 問題が有効な場合、評価は無効になります。

エンゲージメントを管理する

[Q & A] タブには、拡張機能ユーザーからのすべての質問のスナップショットが表示され、応答されていないクエリが一番上に表示されます。 以前の応答に返信したり、編集したりして、拡張機能ユーザーとのエンゲージメントをより適切に管理できます。

Excel にエクスポート

レポート ページで使用できるすべてのデータ要素は、独自のカスタム レポートの作成に役立つ XLS 形式でダウンロードすることもできます。

お問い合わせ

有料の拡張機能の場合は、[ 連絡先 ] アクションを使用してユーザーと通信できます。 この機能は、拡張機能に対する共同作成者 + アクセス権を持つパブリッシャーのみが使用できます。

Marketplace ブローカーは、プライバシー ポリシーでは顧客の電子メール アドレスを直接共有できないため、ユーザーとの最初の通信を仲介します。 通信をオプトインしたユーザーのみがメールを受信します。 組織の最後の連絡日は、通信を送信した後に更新されます。

トランザクション通信: 拡張機能またはサービスの継続的な使用に必要な重要な情報を伝える電子メール。次に例を示します。

• 重要なセキュリティに関する注意事項
• トランザクションの確認
• 製品の取り消しに関する通知
• 特定のフィードバック要求
• サービスの廃止に関する通知

プロモーション用メール: 拡張機能、製品、サービス、Web サイト、またはイベントの販売に使用される電子メール。

• イベントまたは Web キャストへの招待
• 新しいマーケティングまたはパートナー プログラムに関する情報
• 付加価値コンテンツを取得するためのオファー
• プロモーション コンテンツを含むニュースレター

詳細については、 Marketplace パブリッシャー契約を参照してください。

関連記事

• Web 拡張機能を開発する
• 機能拡張ポイントを調べる