[Microsoft Graph]バッチ処理を試してみました。

ホーム
Microsoft Graph
[Microsoft Graph]バッチ処理を試してみました。

Microsoft Graph

2019.06.28

[Microsoft Graph]バッチ処理を試してみました。

先日公開された下記動画を見て、面白そうだったのでMicrosoft Graphのバッチ処理を試してみることにしました。

Graph エクスプローラーを使ったAPIのテスト

上記動画でも使われていますが、Microsoft Graphの各APIをテストするのに便利なツール「Graph エクスプローラー」が用意されているので、今回はこれを使います。

Graph エクスプローラーを開き、Microsoft アカウントでサインインします。

「サンプルをさらに表示」から「バッチ処理」をオンにします。

「GET を並列で実行する」をクリックし、「クエリを実行」ボタンをクリックします。

「応答のプレビュー」に、POSTしたリクエストの結果が表示されます。

{
    "responses": [
        {
            "id": "1",
            "status": 200,
            "headers": {
                "Cache-Control": "no-cache",
                "OData-Version": "4.0",
                "Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false;charset=utf-8"
            },
            "body": {
                "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(displayName,jobTitle,userPrincipalName)/$entity",
                "displayName": "**** ****",
                "surname": "****",
                "givenName": "****",
                "id": "****************",
                "userPrincipalName": "***********@outlook.jp",
                "businessPhones": [],
                "jobTitle": null,
                "mail": null,
                "mobilePhone": null,
                "officeLocation": null,
                "preferredLanguage": null
            }
        },
        {
            "id": "3",
            "status": 200,
            "headers": {
                "Cache-Control": "private",
                "OData-Version": "4.0",
                "Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false;charset=utf-8"
            },
            "body": {
                "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('***********%40outlook.jp')/events",
                "value": []
            }
        },
        {
            "id": "2",
            "status": 200,
            "headers": {
                "Cache-Control": "private",
                "OData-Version": "4.0",
                "Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false;charset=utf-8"
            },
            "body": {
                "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('***********%40outlook.jp')/messages(from,subject,receivedDateTime,bodyPreview)",
                "value": []
            }
        }
    ]
}

この結果を見る限り、まとめて送信したリクエストはそれぞれ無事に処理できたようです。
これでMicrosoft Graphにおけるバッチ処理の概要は掴めました。

バッチ処理について

上記サンプルの通り、「$batch」エンドポイントに複数のリクエストをPOST送信することで、バッチ処理できます。

HTTP

POST https://graph.microsoft.com/v1.0/$batch
Accept: application/json
Content-Type: application/json

BODY

必須プロパティ：requests, id, url, method
idプロパティを指定することで、各要求と応答を対応させることができます。

詳細は下記ドキュメント参照。

docs.microsoft.com

JSON バッチ処理を使用した複数要求の単一 HTTP 呼び出しへの統合 - Microsoft Graph

https://docs.microsoft.com/ja-jp/graph/json-batching?WT.mc_id=M365-MVP-4029057

JSON のバッチ処理を使用すると、複数の要求を単一の JSON オブジェクトに統合することにより、アプリケーションを最適化することができます。たとえば、次のような互いに無関係なデータからビューを作成する場合、

{
  "requests": [
    {
      "url": "/me",
      "method": "GET",
      "id": "1"
    },
    {
      "url": "/me/messages",
      "method": "GET",
      "id": "2"
    },
    {
      "url": "/me/drive/root/children",
      "method": "GET",
      "id": "3"
    }
  ]
}