次の方法で共有


mailboxItem: delta

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

指定した mailboxFolder で追加、削除、または更新された mailboxItem オブジェクトのセットを取得します。

フォルダー内のアイテムの デルタ 関数呼び出しは GET 要求に似ていますが、これらの呼び出しの 1 つ以上に 状態トークン を適切に適用することで、 そのフォルダー内のアイテムの増分変更を照会できる点が異なります。 この方法では、ユーザーのメールボックス アイテムのローカル ストアを維持および同期でき、毎回サーバーからアイテムのセット全体をフェッチする必要はありません。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) MailboxItem.Read 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション MailboxItem.Read.All 注意事項なし。

HTTP 要求

GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items/delta

クエリ パラメーター

項目の変更を追跡すると、1 つ以上の デルタ 関数呼び出しのラウンドが発生します。 任意のクエリ パラメーター ($deltaToken$skipToken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、応答で提供される nextLink または deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。 必要なクエリ パラメーターを前もって 1 回指定しておくだけで済みます。 後続の要求では、前の応答の nextLink または deltaLink URL をコピーして適用するだけです。その URL には、エンコードされた目的のパラメーターが既に含まれています。

クエリ パラメーター 説明
$deltaToken 同じ項目コレクションに対する前のデルタ関数呼び出しのdeltaLink URL で返された状態トークン。これは、その変更追跡のラウンドの完了を示します。 このコレクションについて、このトークンを含む、deltaLink URL 全体を次の変更追跡のラウンドの最初の要求に保存し、適用します。
$skipToken 前のデルタ関数呼び出しのnextLink URL で返された状態トークン。同じ項目コレクションでさらに変更を追跡できます。

OData クエリ パラメーター

  • $select クエリ パラメーターを使用して、最適なパフォーマンスを得るために必要なプロパティのみを指定できます。 id プロパティは常に返されます。
  • このデルタ クエリでは、項目の $select および $top クエリ パラメーターがサポートされます。
  • $filter$orderbyには、制限付きサポートが存在します。
    • サポートされている $filter 表現は、 $filter=receivedDateTime+ge+{value}$filter=receivedDateTime+gt+{value}のみです。
    • サポートされている唯一の $orderby 式は、$orderby=receivedDateTime+desc です。 $orderby式を含めない場合、戻り値の順序は保証されません。
  • $search クエリ パラメーターはサポートされていません。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Prefer odata.maxpagesize={x}。 省略可能。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、この関数は 200 OK 応答コードと、応答本文の mailboxItem オブジェクトのコレクションを返します。

要求

次の例は、1 つの デルタ 関数呼び出しを行い、応答本文の項目の最大数を 2 に制限する方法を示しています。

フォルダー内の項目の変更を追跡するには、1 つ以上の デルタ 関数呼び出しを行って、最後のデルタ クエリ以降の増分変更のセットを取得します。

デルタ クエリ呼び出しのラウンドを示す例については、「 フォルダー内の項目に対する増分変更を取得する」を参照してください。

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta
Prefer: odata.maxpagesize=2

応答

要求が成功した場合、応答には、 $skipToken ( @odata.nextLink 応答ヘッダー内) または $deltaToken ( @odata.deltaLink 応答ヘッダー内) である状態トークンが含まれます。 それぞれ、ラウンドを続行するか、そのラウンドのすべての変更の取得を完了したかを示します。

次の例は、@odata.nextLink 応答ヘッダーの$skipTokenを示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json
Content-length: 337

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(mailboxItem)",
    "@odata.nextLink": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta?$skiptoken={_skipToken_}",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxItem",
            "@odata.etag": "W/\"CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT\"",
            "createdDateTime": "2021-10-19T06:30:30Z",
            "lastModifiedDateTime": "2021-10-19T07:17:06Z",
            "changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT",
            "categories": [],
            "type": "IPM.Note",
            "size": 75329,
            "id": "AAMkAGUwNjQ4ZyTAACQ2fKdhq8oSKEDSVrdi3lRAAFSX03WAAA="
        }
    ]
}