最初の Outlook アドインをビルドするBuild your first Outlook add-in

この記事では、選択したメッセージのプロパティを、少なくとも 1 つ表示する Outlook 作業ウィンドウ アドインを作成するプロセスについて説明します。In this article, you'll walk through the process of building an Outlook task pane add-in that displays at least one property of a selected message.

アドインを作成するCreate the add-in

Office アドイン用の Yeoman ジェネレーター または Visual Studio を使用して Office アドインを作成することができます。You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio. Yeoman ジェネレーターでは Visual Studio Code またはその他のエディターで管理できる Node.js プロジェクトを作成します。一方、Visual Studio では Visual Studio のソリューションを作成します。The Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor, whereas Visual Studio creates a Visual Studio solution. 使用する方のタブを選択し、手順に従ってアドインを作成してローカルでテストします。Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally.

前提条件Prerequisites

  • Node.js (バージョン 8.0.0 以降)Node.js (version 8.0.0 or later)

  • 最新バージョンの YeomanOffice アドイン用の Yeoman ジェネレーター。これらのツールをグローバルにインストールするには、コマンド プロンプトから次のコマンドを実行します。The latest version of Yeoman and the Yeoman generator for Office Add-ins. To install these tools globally, run the following command via the command prompt:

    npm install -g yo generator-office
    

    注意

    Yeomanのジェネレーターを過去に取付けている場合でも、npmからのパッケージを最新のバージョンにすることをお勧めします。Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

アドイン プロジェクトの作成Create the add-in project

  1. 次のコマンドを実行し、Yeoman ジェネレーターを使用してアドイン プロジェクトを作成します。Run the following command to create an add-in project using the Yeoman generator:

    yo office
    

    注意

    yo officeコマンドを実行すると、Yeoman のデータ収集ポリシーと Office アドイン CLI ツールに関するプロンプトが表示される場合があります。When you run the yo office command, you may receive prompts about the data collection policies of Yeoman and the Office Add-in CLI tools. 提供された情報を使用して、必要に応じてプロンプトに応答します。Use the information that's provided to respond to the prompts as you see fit.

    プロンプトが表示されたら、以下の情報を入力してアドイン プロジェクトを作成します。When prompted, provide the following information to create your add-in project:

    • Choose a project type: (プロジェクトの種類を選択) - Office Add-in Task Pane projectChoose a project type - Office Add-in Task Pane project

    • Choose a script type: (スクリプトの種類を選択) - JavascriptChoose a script type - Javascript

    • What would you want to name your add-in?: (アドインの名前を何にしますか)What do you want to name your add-in? - My Office Add-in

    • Which Office client application would you like to support?: (どの Office クライアント アプリケーションをサポートしますか)Which Office client application would you like to support? - Outlook

    Yeoman ジェネレーターのプロンプトと応答のスクリーンショット

    ウィザードを完了すると、ジェネレーターによってプロジェクトが作成されて、サポートしているノード コンポーネントがインストールされます。After you complete the wizard, the generator will create the project and install supporting Node components.

    ヒント

    アドイン プロジェクトの作成後に Yeoman ジェネレーターが提供する次の手順ガイダンスは無視できます。You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. この記事中の詳しい手順は、このチュートリアルを完了するために必要なすべてのガイダンスを提供します。The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

  2. Web アプリケーション プロジェクトのルート フォルダーに移動します。Navigate to the root folder of the web application project.

    cd "My Office Add-in"
    

プロジェクトを探究するExplore the project

Yeomanジェネレーターで作成したアドインプロジェクトには、原型となる作業ペインアドインのサンプルコードが含まれています。The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in.

  • プロジェクトのルートディレクトリにある ./ manifest.xmlファイルは、アドインの設定と機能性を定義します。The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • ./src/taskpane/taskpane.htmlファイルには、作業ペイン用のHTMLマークアップが含まれています。The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • ./src/taskpane/taskpane.cssファイルには、作業ペインのコンテンツに適用されるCSSが含まれています。The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • ./src/taskpane/taskpane.jsファイルには、作業ペインとOutlookの間のやり取りを容易にするOffice JavaScript APIコードが含まれています。The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and Outlook.

コードを更新するUpdate the code

  1. コードエディタで、./src/taskpane/taskpane.htmlファイルを開き、全体の<main>要素(一部の<body>要素)を次のマークアップに置き換えます。In your code editor, open the file ./src/taskpane/taskpane.html and replace the entire <main> element (within the <body> element) with the following markup. この新しいマークアップは、./src/taskpane/taskpane.jsのスクリプトがデータを書き込む場所にラベルを追加します。This new markup adds a label where the script in ./src/taskpane/taskpane.js will write data.

    <main id="app-body" class="ms-welcome__main" style="display: none;">
        <h2 class="ms-font-xl"> Discover what Office Add-ins can do for you today! </h2>
        <p><label id="item-subject"></label></p>
        <div role="button" id="run" class="ms-welcome__action ms-Button ms-Button--hero ms-font-xl">
            <span class="ms-Button-label">Run</span>
        </div>
    </main>
    
  2. コードエディターで、ファイル ./src/taskpane/taskpane.jsを開き、実行関数内に次のコードを追加してください。In your code editor, open the file ./src/taskpane/taskpane.js and add the following code within the run function. このコードはOffice JavaScript APIを使用して現在のメッセージへの参照を取得し、そのsubjectプロパティ値を作業ペインに書き込みます。This code uses the Office JavaScript API to get a reference to the current message and write its subject property value to the task pane.

    // Get a reference to the current message
    var item = Office.context.mailbox.item;
    
    // Write message property value to the task pane
    document.getElementById("item-subject").innerHTML = "<b>Subject:</b> <br/>" + item.subject;
    

試してみるTry it out

注意

開発の最中でも、OfficeアドインはHTTPではなくHTTPSを使用する必要があります。Office Add-ins should use HTTPS, not HTTP, even when you are developing. 次のいずれかのコマンドを実行した後に証明書をインストールするように求められた場合は、Yeoman ジェネレーターによって提供される証明書をインストールするプロンプトを受け入れます。If you are prompted to install a certificate after you run one of the following commands, accept the prompt to install the certificate that the Yeoman generator provides.

ヒント

Mac でアドインをテストしている場合は、先に進む前に次のコマンドを実行してください。If you're testing your add-in on Mac, run the following command before proceeding. このコマンドを実行すると、ローカル Web サーバーが起動します。When you run this command, the local web server will start.

npm run dev-server
  1. プロジェクトのルート ディレクトリから次のコマンドを実行します。Run the following command in the root directory of your project. このコマンドを実行すると、ローカル Web サーバーが起動します (まだ実行されていない場合)。When you run this command, the local web server will start (if it's not already running).

    npm start
    
  2. テスト用に Outlook アドインをサイドロードする」の手順に従って Outlook アドインをサイドロードします。Follow the instructions in Sideload Outlook add-ins for testing to sideload the add-in in Outlook.

  3. Outlook で、メッセージを選択または開きます。In Outlook, select or open a message.

  4. ホームタブ(または新しいウィンドウでメッセージを開いた場合はメッセージタブ)を選択し、リボンのタスクパネルの表示ボタンを選択、アドインの作業ペインを開きます。Choose the Home tab (or the Message tab if you opened the message in a new window), and then choose the Show Taskpane button in the ribbon to open the add-in task pane.

    アドイン ボタンが強調表示された Outlook のメッセージ ウィンドウのスクリーンショット

  5. 作業ペインの下部までスクロールし、実行リンクを選択してメッセージを作業ペインに書き込みます。Scroll to the bottom of the task pane and choose the Run link to write the message subject to the task pane.

    メッセージ プロパティを表示するアドインの作業ウィンドウのスクリーンショット

次の手順Next steps

おめでとうございます、最初のOutlook作業ペインアドインの作成に成功しました。Congratulations, you've successfully created your first Outlook task pane add-in! 次に、Outlook アドインの機能の詳細について説明します。Outlook アドインのチュートリアルに従って、より複雑なアドインをビルドします。Next, learn more about the capabilities of an Outlook add-in and build a more complex add-in by following along with the Advanced Outlook add-in tutorial.