予定表: 差分

名前空間: microsoft.graph

ユーザーのメールボックスで追加、更新、または削除された一連の 予定表 リソースを取得します。

通常、ローカル ストアのメールボックスの予定表を同期するには、複数の デルタ 関数の呼び出しがラウンドで発生します。 最初の呼び出しは完全同期で、同じラウンドの後続の 差分 呼び出しはすべて増分の変更 (追加、削除、更新) を取得します。 差分を使用すると、指定したメールボックス内の予定表のローカル ストアを増分維持および同期できます。

アクセス許可

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

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Calendars.Read Calendars.ReadBasic、Calendars.ReadWrite
委任 (個人用 Microsoft アカウント) Calendars.Read Calendars.ReadBasic、Calendars.ReadWrite
アプリケーション Calendars.Read Calendars.ReadBasic、Calendars.ReadWrite

HTTP 要求

変更の追跡を開始するには、予定表リソースでデルタ関数を含む要求を行います。

ユーザーのメールボックスの予定表一覧に対する増分変更の場合。

GET /me/calendars/delta
GET /users/{usersId}/calendars/delta

クエリ パラメーター

変更を追跡すると、1 つ以上の デルタ 関数呼び出しがラウンドで発生します。 任意のクエリ パラメーター ($deltatoken と$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、指定されたパラメーターを、応答で指定された @odata.nextLink または @odata.deltaLink URL のトークン部分に自動的にエンコードします。

最初の要求でのみ、必要なクエリ パラメーターを指定します。

以降の要求では、前の応答の @odata.nextLink または @odata.deltaLink URL を使用します。 URL には、エンコードされたクエリ パラメーターが既に含まれています。

クエリ パラメーター 種類 説明
$deltatoken 文字列 同じ予定表リストに対する前のデルタ関数呼び出しの @odata.deltaLink URL で返される状態トークン。変更追跡のそのラウンドの完了を示します。 このトークンを含む @odata.deltaLink URL 全体を保存し、その予定表リストに対する次の変更追跡の最初の要求に適用します。
$skiptoken string 前のデルタ関数呼び出しの @odata.nextLink URL で返される状態トークン。同じ予定表リストでさらに変更を追跡する必要があることを示します。

オプションのクエリ パラメーター

このメソッドでは、応答をカスタマイズするのに役立つオプションの OData クエリ パラメーター がサポートされています。

  • 他の GET リクエストと同様に $select クエリ パラメーターを使用して、最適なパフォーマンスを得るために必要なプロパティのみを指定できます。
  • delta 関数は、$expand、$filter、$orderby、$search というクエリ パラメーターをサポートしていません。

要求ヘッダー

名前 型 説明
Authorization string 必須です。 認証と認可についての詳細をご覧ください。
Content-Type string application/json. Required.
Prefer string odata.maxpagesize={x} です。 省略可能。

要求本文

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

応答

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

例

要求

次の例は、 $select パラメーターを持たない要求を示しています。既定のプロパティ セットが追跡され、返されます。

GET https://graph.microsoft.com/v1.0/me/calendars/delta

応答

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

次の応答では、@odata.deltaLink 応答ヘッダーに$deltaTokenが表示されます。

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(calendar)",
    "value": [
        {
            "@odata.type": "#microsoft.graph.calendar",
            "id": "AQMkADRhZThkMDVjLTJmNDctNDUyZC05YjA2LTI2YzRmMTIxOWJhZQBGAAADVDIMnvGkNkGo5_ASLe7iUQcAvXegGcyc-0O1dA1ftrtB6QAAAgEGAAAAvXegGcyc-0O1dA1ftrtB6QAAAUSwewAAAA==",
            "name": "Calendar",
            "color": "auto",
            "hexColor": "",
            "groupClassId": "0006f0b7-0000-0000-c000-000000000046",
            "isDefaultCalendar": true,
            "changeKey": "vXegGcyc/0O1dA1ftrtB6QAAAEO+6Q==",
            "canShare": true,
            "canViewPrivateItems": true,
            "isShared": false,
            "isSharedWithMe": false,
            "canEdit": true,
            "calendarGroupId": null,
            "allowedOnlineMeetingProviders": [
                "teamsForBusiness"
            ],
            "defaultOnlineMeetingProvider": "teamsForBusiness",
            "isTallyingResponses": true,
            "isRemovable": false,
            "owner": {
                "name": "Samantha Booth",
                "address": "samanthab@contoso.com"
            }
        },
        {
            "@odata.type": "#microsoft.graph.calendar",
            "id": "AQMkADRhZThkMDVjLTJmNDctNDUyZC05YjA2LTI2YzRmMTIxOWJhZQBGAAADVDIMnvGkNkGo5_ASLe7iUQcAvXegGcyc-0O1dA1ftrtB6QAAAgEGAAAAvXegGcyc-0O1dA1ftrtB6QAAAU4pOwAAAA==",
            "name": "Birthdays",
            "color": "auto",
            "hexColor": "",
            "groupClassId": "0006f0b7-0000-0000-c000-000000000046",
            "isDefaultCalendar": false,
            "changeKey": "vXegGcyc/0O1dA1ftrtB6QAAAEzvog==",
            "canShare": false,
            "canViewPrivateItems": true,
            "isShared": false,
            "isSharedWithMe": false,
            "canEdit": false,
            "calendarGroupId": null,
            "allowedOnlineMeetingProviders": [],
            "defaultOnlineMeetingProvider": "unknown",
            "isTallyingResponses": false,
            "isRemovable": true,
            "owner": {
                "name": "Samantha Booth",
                "address": "samanthab@contoso.com"
            }
        }
    ],
    "@odata.deltaLink": "https://graph.microsoft.com/v1.0/me/calendars/delta?$deltatoken=LztZwWjo5IivWBhyxw5rAIPrk_3pGHcZr4U33FHo0HpyBLqdo9QZIWfEL4AW1jMLBmo-o1ybmYCWlzQ5elO2bEDejh9Z8kYv_z4nhmHoC5Y.7Wdj3MWiils6M--JMM9dMyiLCh-1he4AZCqBu-8i42o"
}
  • 最終更新: