Microsoft Graph と Azure Bot Service で Office 365 対応の会議室＆スケジュール予約 Bot を開発する: (1) Graph API による操作

18419 ワード

Office365 AzureBotService Microsoft365 BotFramework MicrosoftGraph Office365 テキストリンク

Microsoft 365 (旧称 Office 365、以下 M365) はクラウド利用を前提とした Office 製品群で、ローカル環境に Office ソフトウエアをインストールしてもよし、インストール不要でブラウザーから利用してもよし、Outlook | Excel | Word | PowerPoint | OneNote などのファイルのバックアップや、会社や学校での情報共有が自在なサービスになっています。また、M365 の情報は認証を経て Web API でアクセスすることが可能であり(*1)、属する組織 (会社や学校) のドメインで共有されている情報を用いて、空き時間情報を取得したり、スケジュール予約をしたりすることができます。

(*1) M365 を含むマイクロソフトのクラウド製品にアクセスできる Web API 群は、まとめて Microsoft Graph と呼ばれています

今回は、この M365 の Graph API を用いて、会議室や関係者のスケジュールの空きを見つけて予約を行うチャットボットを構成する方法を紹介します。

会議室＆スケジュール予約Bot開発シリーズ
- (1) Microsoft 365 Graph API による操作 (←イマココ)
- (2) (仮)Azure Bot Service からの OAuth 認証
- (3) (仮)チャットボットのフロー構成を考える
準備
- M365 アカウント
- Rest API テストツール
手順

準備

M365 アカウント

この Graph API の操作を確認する段階では、会社や学校でご利用中の M365 アカウントでも大丈夫です。
管理者による制限で API の利用 (アクセスや操作) ができない場合は、開発者用サブスクリプション(無料、90日間有効) を作成し、ご自分で権限をコントロールできる M365 ドメイン(*.onmicrosoft.com)を取得してください。

Microsoft 365 デベロッパーセンター > 開発者プログラム

Rest API テストツール

Postman、Talend API Tester (←どちらも無償で利用できます) などなど、お好みのものをお使いください。こちらの手順では Talend API Tester の Chrome Extention を使用しています。

手順

1. Microsoft Graph デベロッパーセンターでの操作

Microsoft Graph から M365 の情報にアクセス、操作を行う上で、Microsoft Graph Explorer という、ブラウザーから動作を確認できるツールが用意されています。こちらで M365 へのアクセスや操作内容を確認します。

1.1 M365 サインインと Microsoft Graph からの M365 アクセスの確認

ブラウザーから Microsoft Graph Explorer を開きます。

左メニューバーの認証の欄にある [サインイン] をクリックして、M365 アカウントでサインインします。

ユーザー名および M365 アカウントが表示されたのを確認してから、Graph Explorer に用意されているサンプルクエリで動作を確認していきます。

サインインできない場合は、ブラウザーのポップアップがブロックされていないことを確認してください。

左のメニューバーの サンプルクエリ の中から >はじめに に含まれている 自分のプロファイル をクリックします。

画面中央上部に Rest API の URI & アクセスに必要な情報が表示されます。
画面中央下側の 応答のプレビュー に、サインインで使用しているユーザー情報が表示されれば、無事 Microsoft Graph の Rest API で M365 プロファイルにアクセスができています。

Rest API でアクセスする場合は以下を設定します。
- URI
[GET] https://graph.microsoft.com/v1.0/me
- Header
Authorization: Bearer user_token
Content-Type: application/json

詳細は Microsoft Docs > Microsoft Graph > ユーザーの取得を確認してください。
Authorization に設定する認証トークン(user_token)は後述します。

1.2 アクセス許可の設定

今回はスケジュールの作成を行う権限が必要になりますので、Microsoft Graph からのアクセス許可を設定します。ユーザー名の右側に表示される ⚙ をクリックし、表示される [アクセス許可を選択する] をクリックします。

アクセス許可の一覧から Calendars を探してクリックします。

Calendars.ReadWrite をクリックして✓(チェック)をつけ、画面下部の [同意] をクリックして設定します。

要求されているアクセス許可 のポップアップ画面が表示されますので、[承諾] をクリックして設定を完了します。

1.3 Microsoft Graph から Outlook 予定表へのアクセス＆操作

1.3.1　空き時間から会議スケジュールを検索する

Microsoft Graph を使って、会議の参加メンバーや会議室の Outlook スケジュールを参照して、会議を設定できる日程を検索することができます。

Microsoft Docs > Microsoft Graph > 会議の日時を検索する

Graph Explorer のサンプルクエリから Outlook カレンダー > 会議の日時を検索する をクリックします。

今回は POST で、Request Body に検索するメンバーや日時を記載します。
以下のように、とりあえずユーザーは1人(参加必須)、7/1 の 9:00-17:00 (ここではUTCで設定)の間で1時間の会議を検索するには以下のようになります;

{
    "attendees": [
        {
            "emailAddress": {
                "address": "user01@YOUR_ACCOUNT.onmicrosoft.com"
            },
            "type": "Required"
        }
    ],
    "timeConstraint": {
        "timeslots": [
            {
        "start": {
                    "dateTime": "2020-07-01T00:00:00.0000000",
                    "timeZone": "UTC"
                },
                "end": {
                    "dateTime": "2020-07-01T08:00:00.0000000",
                    "timeZone": "UTC"
                }            }
        ]
    },
    "meetingDuration": "PT1H"
}

こちらを 要求本文 にコピー＆ペーストし、Email はサインインしているアカウントに変更、時間も適切なものに変更してください。[クエリーの実行] をクリックして送信します。

応答に OK - 200 と表示され、応答のプレビュー に条件に合った会議時間が提示されます。

例えば、以下のように 7/1 の 9:00-10:00 が第1候補として、複数の候補日程が提示されます。

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.meetingTimeSuggestionsResult",
    "emptySuggestionsReason": "",
    "meetingTimeSuggestions": [
        {
            "confidence": 100,
            "order": 1,
            "organizerAvailability": "free",
            "attendeeAvailability": [],
            "locations": [],
            "meetingTimeSlot": {
                "start": {
                    "dateTime": "2020-07-01T00:00:00.0000000",
                    "timeZone": "UTC"
                },
                "end": {
                    "dateTime": "2020-07-01T01:00:00.0000000",
                    "timeZone": "UTC"
                }
            }
        },
 :

1.3.2　会議の予定を作成する

今度は、Microsoft Graph で Outlook の会議(イベント)を作成してみます。

Microsoft Docs > Microsoft Graph > イベントを作成する

Graph Explorer のサンプルクエリから Outlook カレンダー > 会議の予約 をクリックします。

POST でアクセスし、Request Body に会議参加メンバーや会議室、日時を記載します。
以下のように、例えばユーザーは送信者本人ひとり(参加必須)、7/1 の 13:00-14:00 (ここではUTCで設定) に会議を作成するには以下のようになります;

{
    "subject": "My event",
    "start": {
        "dateTime": "2020-07-01T04:00:00.0000000",
        "timeZone": "UTC"
    },
    "end": {
        "dateTime": "2020-07-01T05:00:00.0000000",
        "timeZone": "UTC"
    }
}

応答に Created - 201 と表示されたら会議の作成は完了です。

操作に使用しているユーザーの Outlook にアクセスし、会議が作成されているのを確認してください。

2. Rest API による操作

今度は Rest API のテストツールから M365 へのアクセスや操作を行います。

Microsoft Graph で M365 にアクセスする場合には認証トークンが必要です。通常ではチャットボットを含む Web や PC, モバイルアプリなどから Graph API を用いてアクセスを行うことになり、アプリ自体を予め Microsoft ID プラットフォームに登録しておく必要があります。

Microsoft Docs > Microsoft Graph > Microsoft Graph の認証と承認の基本方法

アプリ登録はチャットボット作成の際に行いますので、Microsoft Graph の動作確認を行う今回は Microsoft Graph Explorer から発行される認証トークンを利用します。

2.1 認証トークンの取得

Microsoft Graph Explorer にサインインした状態で、画面中央上部にある、アクセストークン をクリックします。トークンが表示されたら、選択してコピー、または 📄 をクリックしてコピーし、ローカルに保存しておきます。

2.2 Rest API のテストツールから Outlook 予定表へのアクセス＆操作

Microsoft Graph Explorer から行ったのと同じ操作を (＋ちょっと実践的に Request Body を複雑にして) 行ってみます。

2.2.1　空き時間から会議スケジュールを検索する

再掲ですが、使用する API はこちら;
Microsoft Docs > Microsoft Graph > 会議の日時を検索する

YOUR_ACCESS_TOKEN は 2.1 でコピーしておいた認証トークンに置き換えます。

POST https://graph.microsoft.com/v1.0/me/findMeetingTimes
Content-Type: application/json
Authorization: bearer YOUR_ACCESS_TOKEN

Request Body は例えば以下のようになります。
会議の参加者 user01 と user02、およびリソース(会議室)である room01 の空きを 7/1, 13:00 ～ 7/2, 18:00 (日本時間)の範囲で、2 時間の会議ができる日時を検索します。参加者および日時範囲を適切に修整します。

{
   "attendees":[
      {
         "emailAddress":{
            "address":"user01@YOUR_ACCOUNT.onmicrosoft.com"
         },
         "type":"Required"
      },
      {
         "emailAddress":{
            "address":"user02@YOUR_ACCOUNT.onmicrosoft.com"
         },
         "type":"Required"
      },
      {
         "emailAddress":{
            "address":"room01@YOUR_ACCOUNT.onmicrosoft.com"
         },
         "type":"resource"
      }
   ],
   "timeConstraint":{
      "timeslots":[
         {
            "start":{
               "dateTime":"2020-07-01T13:00:00.0000000",
               "timeZone":"Tokyo Standard Time"
            },
            "end":{
               "dateTime":"2020-07-02T18:00:00.0000000",
               "timeZone":"Tokyo Standard Time"
            }
         }
      ]
   },
   "meetingDuration":"PT2H"
}

この room01 は Outlook のリソースとして登録されているため、"type":"resource" として、いち参加者のように "attendees" に追加しています。ユーザーとして登録されている場合は、"locationConstraint" のパラメーターで追加します。(詳細はドキュメントを参照してください)
また、日本時間で日時を設定するため、"timeZone" を "Tokyo Standard Time" に設定しています。

Request URI, Header, Body をコピー＆ペーストしたら、リクエストを送信します。

Response 200 が返り、候補日時が Response Body として取得できます。

指定された日時の範囲と、稼働時間内で候補日時が検索され、提示されます。また、UTC 表記になっています。

{
   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.meetingTimeSuggestionsResult",
   "emptySuggestionsReason": "",
   "meetingTimeSuggestions":[
      {
         "confidence": 100.0,
         "organizerAvailability": "free",
         "attendeeAvailability":[
            {
               "availability": "free",
               "attendee":{
                  "emailAddress":{
                     "address": "user02@YOUR_ACCOUNT.onmicrosoft.com"
                  }
               }
            },
            {
               "availability": "free",
               "attendee":{
                  "emailAddress":{
                     "address": room01@YOUR_ACCOUNT.onmicrosoft.com"
                  }
               }
            },
         ],
   "locations":[],
   "meetingTimeSlot":{
      "start":{
         "dateTime": "2020-07-01T05:00:00.0000000",
         "timeZone": "UTC"
      },
      "end":{
         "dateTime": "2020-07-01T07:00:00.0000000",
         "timeZone": "UTC"
      }
   }
},
:

2.2.2　会議の予定を作成する

再掲ですが、使用する API はこちら;
Microsoft Docs > Microsoft Graph > イベントを作成する

YOUR_ACCESS_TOKEN は 2.1 でコピーしておいた認証トークンに置き換えます。

POST https://graph.microsoft.com/v1.0/me/events
Content-Type: application/json
Authorization: bearer YOUR_ACCESS_TOKEN

Request Body は例えば以下のようになります。
会議の参加者 user01 と user02、リソース(会議室) room01 に 7/1, 15:00 ～ 16:00 (日本時間)の会議(イベント)を作成します。参加者および日時範囲を適切に修整します。

{
    "subject": "Plan Meeting",
    "body": {
        "contentType": "HTML",
        "content": "こちらで今期の企画会議を設定します"
    },
    "start": {
        "dateTime": "2020-07-01T15:00:00",
        "timeZone": "Tokyo Standard Time"
    },
    "end": {
        "dateTime": "2020-07-01T16:00:00",
        "timeZone": "Tokyo Standard Time"
    },
    "attendees": [
        {
            "emailAddress": {
                    "address":"user01@YOUR_ACCOUNT.onmicrosoft.com"
                },
                "type": "required"
        },
        {
            "emailAddress": {
                "address":"user02@YOUR_ACCOUNT.onmicrosoft.com"
            },
            "type": "required"
        },
        {
            "emailAddress": {
                    "address":"room01@YOUR_ACCOUNT.onmicrosoft.com"
                },
                "type": "resource"
        }
    ]
}

2.2.1 と同様に room01 は Outlook のリソースとして登録されているため、"type":"resource" として、いち参加者のように "attendees" に追加しています。ユーザーとして登録されている場合は、"location" のパラメーターで追加します。(詳細はドキュメントを参照してください)
また、日本時間で日時を設定していますが、2.2.1 の Response で取得した結果をそのまま (UTCで) 利用いただいても構いません。

Request URI, Header, Body をコピー＆ペーストしたら、リクエストを送信します。

Response 201 (Created) が返ってきたら作成は完了です。

Outlook スケジュールにイベントが作成されているのを確認してください。

イベントの詳細を開くと、参加者や会議室、件名や説明が入力されているのを確認できます。

Author And Source

この問題について(Microsoft Graph と Azure Bot Service で Office 365 対応の会議室＆スケジュール予約 Bot を開発する: (1) Graph API による操作), 我々は、より多くの情報をここで見つけました https://qiita.com/annie/items/40eef880b6e560d401c0

著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。

Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .