Teams アプリ マニフェストをカスタマイズする

Visual Studio Code 用の Teams アプリ マニフェストをカスタマイズする

Teams アプリ マニフェストでは、アプリを Teams に統合する方法について説明します。 マニフェスト テンプレート ファイル manifest.template.json は、スキャフォールディング後のフォルダーで templates/appPackage 使用できます。 プレースホルダーを含むテンプレート ファイルと実際の値は、Teams Toolkit によって、環境 .fx/configs や .fx/states 環境ごとにファイルを使用して解決されます。

実際のコンテンツでマニフェストをプレビューするには、Teams Toolkit によってフォルダーの下に build/appPackage プレビュー マニフェスト ファイルが生成されます。

└───build
    └───appPackage
        ├───appPackage.{env}.zip - Zipped app package of remote Teams app
        ├───appPackage.local.zip - Zipped app package of local Teams app
        ├───manifest.{env}.json  - Previewed manifest of remote Teams app
        └───manifest.local.json  - Previewed manifest of local Teams app

マニフェスト ファイルは、ローカル環境とリモート環境でプレビューできます。

ローカル環境でのマニフェスト ファイルのプレビュー

ローカル環境でマニフェスト ファイルをプレビューするには、 F5 キーを押してローカル デバッグを実行します。 既定のローカル設定を生成すると、アプリ パッケージとプレビュー マニフェストがフォルダーの下に build/appPackage ビルドされます。

ローカル マニフェスト ファイルは、次の 2 つの方法でプレビューできます。

• CodeLens でプレビュー オプションを使用します。
• Zip Teams メタデータ パッケージ オプションを使用します。

次の手順は、CodeLens のプレビュー オプションを使用してローカル マニフェスト ファイルをプレビューするのに役立ちます。

1. ファイルの CodeLens manifest.template.json で [プレビュー] を選択します。

   

2. [ ローカル] を選択します。

   

Zip Teams メタデータ パッケージ オプションを使用してローカル マニフェスト ファイルをプレビューするには:

1. ファイルを選択 manifest.template.json します。

   

2. Visual Studio Code アクティビティ バーの [Teams Toolkit] アイコンを選択します。

3. [デプロイ] で [Zip Teams メタデータ パッケージ ] を選択 します。

   

4. [ ローカル] を選択します。

   

プレビュー ローカル イメージを次に示します。

リモート環境でのマニフェスト ファイルのプレビュー

Visual Studio Code を使用してマニフェスト ファイルをプレビューするには:

• [Teams Toolkit でのデプロイ]の下の [クラウドでプロビジョニング] を選択します。

  

• コマンド パレットを使用してマニフェスト ファイルをプレビューするには。 コマンド パレットから 、クラウドで Teams: プロビジョニングを トリガーできます。

  

これは、リモート Teams アプリの構成を生成し、パッケージをビルドし、フォルダーの下にマニフェストを build/appPackage プレビューします。

リモート環境のマニフェスト ファイルは、次の 2 つの方法でプレビューできます。

• CodeLens でプレビュー オプションを使用します。
• Zip Teams メタデータ パッケージ オプションを使用します。

CodeLens のプレビュー オプションを使用してマニフェスト ファイルをプレビューするには:

1. ファイルの CodeLens manifest.template.json で [プレビュー] を選択します。

   

2. 環境を選択します。

   

   注:

   複数の環境がある場合は、プレビューする環境を選択する必要があります。

リモート環境で Zip Teams メタデータ パッケージ を選択してマニフェスト ファイルをプレビューするには:

1. ファイルを選択 manifest.template.json します。

   

2. Visual Studio Code アクティビティ バーの [Teams Toolkit] アイコンを選択します。

3. [デプロイ] で [Zip Teams メタデータ パッケージ ] を選択 します。

   

4. 環境を選択します。

   

   注:

   複数の環境がある場合は、プレビューする環境を選択する必要があります。

ローカルの変更を開発者ポータルに同期する

マニフェスト ファイルをプレビューした後、次の方法でローカルの変更を開発者ポータルに同期できます。

1. Teams アプリ マニフェストをデプロイします。

   Teams アプリ マニフェストは、次のいずれかの方法で展開できます。

   • ファイルを manifest.template.json 右クリックし、コンテキスト メニューから [Teams アプリ マニフェストの展開 ] を選択します。

     

   • Teams をトリガーする: コマンド パレットから Teams アプリ マニフェストを選択して 、Teams アプリ マニフェストをデプロイ します。

     

2. Teams プラットフォームに更新します。

   Teams プラットフォームには、次のいずれかの方法で更新できます。

   • の左上隅にある [ Teams プラットフォームに更新 ] を選択します manifest.{env}.json。

   • Teams をトリガーする: のメニュー バーmanifest.{env}.jsonにある Teams プラットフォームにマニフェストを更新します。 次の図は、開発環境を示しています。

     

コマンド パレットから Teams: マニフェストを Teams プラットフォームに更新する をトリガーすることもできます。

注:

• エディター CodeLens またはメニュー バーからトリガーすると、現在のマニフェスト ファイルが Teams プラットフォームに更新されます。
• コマンド パレットからトリガーするには、ターゲット環境を選択する必要があります。

CLI コマンド:

        teamsfx deploy manifest --include-app-manifest yes

---

注:

変更は開発者ポータルに反映されます。 開発者ポータルの手動更新は上書きされます。

構成ファイルの変更またはテンプレートの変更によりマニフェスト ファイルが古くなっている場合は、次のいずれかのアクションを選択します。

• プレビューのみ: ローカル マニフェスト ファイルは、現在の構成に従って上書きされます。
• プレビューと更新: ローカル マニフェスト ファイルは現在の構成に従って上書きされ、Teams プラットフォームにも更新されます。
• キャンセル: アクションは実行されません。

Teams アプリ マニフェストをカスタマイズする

Teams Toolkit は、ローカル環境とリモート環境の manifest.template.json フォルダーにある次のマニフェスト テンプレート ファイルで構成されています。

• manifest.template.json
• templates/appPackage

ローカルデバッグまたはプロビジョニング中に、Teams Toolkit は、 からmanifest.template.json構成state.{env}.jsonconfig.{env}.jsonを使用してマニフェストを読み込み、開発者ポータルで Teams アプリを作成します。

manifest.template.json でサポートされているプレースホルダー

次の一覧では、 で manifest.template.jsonサポートされているプレースホルダーを示します。

• {{state.xx}} は定義済みのプレースホルダーであり、値は で state.{env}.json定義された Teams Toolkit によって解決されます。 で state.{env}.json値を変更しないようにします。
• {{config.manifest.xx}} はカスタマイズされたプレースホルダーであり、値は から config.{env}.json解決されます。

カスタマイズされたパラメーターを追加するには

1. 次のようにカスタマイズされたパラメーターを追加します。
   パターン {{config.manifest.xx}}を使用して プレースホルダーを にmanifest.template.json追加します。
   B。 に構成値を config.{env}.json追加します。

   {
       "manifest": {
        "KEY": "VALUE"
        }
   }
   

2. 構成ファイルに移動するには、構成プレースホルダーのいずれかを選択して構成ファイルに移動するか、 manifest.template.jsonで状態ファイルを表示します。

マニフェストを検証する

Zip Teams メタデータ パッケージなどの操作中に、Teams Toolkit はそのスキーマに対してマニフェストを検証します。 マニフェストを検証するさまざまな方法を次に示します。

• Visual Studio Code で、コマンド パレットから Teams: Validate マニフェスト ファイル をトリガーします。

  

• CLI で、次のコマンドを使用します。

     teamsfx validate --env local
     teamsfx validate --env dev
     ```
  
  

---

ローカル環境と開発環境の値をプレビューするには

でmanifest.template.json、CodeLens に移動して、および dev 環境の値をlocalプレビューできます。

注:

環境をプロビジョニングするか、ローカル デバッグを実行してプレースホルダーの値を生成します。

状態ファイルまたは構成ファイルに移動するには、CodeLens を選択します。これにより、すべての環境名を含むドロップダウン リストが表示されます。 1 つの環境を選択すると、対応する状態ファイルまたは構成ファイルが開きます。

すべての環境の値をプレビューするには、プレースホルダーにカーソルを合わせます。 環境名と対応する値を含む一覧が表示されます。 環境をプロビジョニングしていない場合、またはローカル デバッグを実行していない場合は、 または を選択 Trigger Teams: Provision in the cloud command to see placeholder value します Trigger local debug to see placeholder value。

Visual Studio を使用して Teams アプリ マニフェストをカスタマイズする

Visual Studio の Teams Toolkit は、アプリの依存関係のプロビジョニングと準備中に、state.{env}.json と config.{env}.json の構成を使用して manifest.template.json からマニフェストを読み込みます。 マニフェストを使用して、開発者ポータルで Teams アプリを作成することもできます。

スキャフォールディング後、templates/appPackage フォルダーの下のマニフェスト テンプレート ファイルで、manifest.template.json がローカル環境とリモート環境の間で共有されます。

マニフェスト テンプレートで、[プロジェクト]>[Teams Toolkit]>[マニフェスト ファイルを開く] の順に選択します。

Teams Toolkit でアプリ マニフェストをカスタマイズする

次の一覧では、次の 2 種類のプレースホルダーを示します manifest.template.json。

• {{state.xx}} は事前に定義されたプレースホルダーであり、その値は で state.{env}.json定義された Teams Toolkit によって解決されます。 の値 state.{env}.jsonを変更しないことをお勧めします。
• {{config.manifest.xx}} はカスタマイズされたプレースホルダーであり、値は config.{env}.json から解決されます

次のようにカスタマイズされたパラメーターを追加できます。

• パターン {{config.manifest.xx}} で manifest.template.json にプレースホルダーを追加しています。

• config.{env}.json で構成値を追加します。

      {
          "manifest": {
          "KEY": "VALUE"
          }
  }
  

Teams Toolkit でアプリ マニフェストをプレビューする

アプリ マニフェストの値は、次の 2 つの方法でプレビューできます。

• の manifest.template.jsonプレースホルダーにカーソルを合わせると、 開発環境 と ローカル 環境の値が表示されます。

  

• また、 の manifest.template.json各プレースホルダーの横にあるキーにカーソルを合わせることもできます。ここでは、 開発環境 と ローカル 環境で同じ値を確認できます。

  

環境がプロビジョニングされていない場合、または Teams アプリの依存関係が準備されていない場合は、プレースホルダーの値が生成されていないことを示します。 ホバー内のガイダンスに従って、対応する値を生成できます。

マニフェスト ファイルをプレビューする

ローカル用にサイドロードするか、Azure 用にデプロイしてマニフェスト ファイルをプレビューできます。 マニフェスト ファイルをプレビューするには、次の手順を実行します。

1. [Project>Teams Toolkit] を選択します。

2. [Teams アプリの依存関係の準備] または [ クラウドでのプロビジョニング] をトリガーし、ローカルまたはリモートの Teams アプリの構成を生成します。

   

マニフェスト ファイルをプレビューする前に zip アプリ パッケージをアップロードするには、次の 2 つの方法があります。

1. メニューの一覧から [ Project>Teams Toolkit] を選択します。

2. [Zip アプリ パッケージ] を選択し、[ローカル] または [Azure 用] を選択します。

   

3. MyTeamsApp1 を右クリックすると、ソリューション エクスプローラー セクションから zip アプリ パッケージをアップロードすることもできます。 このシナリオでは、プロジェクト名は MyTeamsApp1 です。

4. [ローカル] または [Azure 用 ] [Teams Toolkit>Zip App Package>]を選択します。

   

Teams Toolkit によって zip アプリ パッケージが生成されます。マニフェスト ファイルをプレビューするには、次の手順に従います。

1. appPackage フォルダーの下にある manifest.template.json ファイルを右クリックします。

2. [プレビュー マニフェスト ファイル]>[ローカル用] または [Azure 用] を選択します。

   

Visual Studio のマニフェスト ファイルのプレビューが表示されます。

ローカルの変更を開発者ポータルに同期する

Visual Studio でマニフェスト ファイルをプレビューしたら、ローカルの変更を開発者ポータルに同期できます。

Teams 開発者ポータルで[Project>Teams Toolkit> Update Manifest] を選択します。

また、ソリューション エクスプローラー セクションのコンテキスト メニューから、ローカルの変更を開発者ポータルに同期することもできます。 ローカルの変更が同期されたら、開発者ポータルでマニフェスト ファイルをプレビューできます。

変更が開発者ポータルに更新されます。

ヒント

• [警告] ダイアログ ボックスで [上書きおよび更新] または [キャンセル] を選択して、開発者ポータルで上書きできる手動更新を行います。

Visual Studio を使用して Teams コマンド ボットを作成すると、2 つのアプリ ID が Microsoft Azure Active Directory (Azure AD) に登録されます。 アプリ ID は、開発者ポータルの [基本的な情報] で [アプリケーション (クライアント) ID] として識別し、[アプリ機能] の下の [既存のボット ID] で識別できます。

関連項目

• Teams ツールキットの概要
• Teams のアプリ マニフェストのスキーマ
• Teams の開発者ポータル
• 複数の環境を管理する
• Microsoft Teams の開発者向けパブリック プレビュー
• Visual Studio を使用してクラウド リソースをプロビジョニングする
• Visual Studio を使用して Teams アプリをクラウドに展開する