イベント: デルタ

名前空間: microsoft.graph

ユーザーの標準として設定されている予定表の calendarView において追加、削除、更新された一連のイベント リソース (開始日と終了日で定義されたさまざまなイベント) を取得します。

通常、ローカル ストアの calendarView にあるイベントを同期させるには、複数の delta 関数の呼び出しが必要になります。 最初の呼び出しは完全同期で、同じラウンドの後続の 差分 呼び出しはすべて増分の変更 (追加、削除、更新) を取得します。 これにより、指定された calendarView にあるイベントのローカル格納の保守と同期を行う際に、サーバーからその予定表のイベントすべてを毎回フェッチする必要がなくなります。

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

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

アクセス許可

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

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

HTTP 要求

GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}

クエリ パラメーター

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

クエリ パラメーター	種類	説明
startDateTime	String	時間範囲の開始日時は、ISO 8601 形式で表されます。 例: "2015-11-08T19:00:00.0000000"。
endDateTime	String	時間範囲の終了日時は、ISO 8601 形式で表されます。 例: "2015-11-08T20:00:00.0000000"。
$deltatoken	string	同じ予定表ビューの前のデルタ関数呼び出しの@odata.deltaLink URL で返された状態トークン。変更追跡のラウンドの完了を示します。 このトークンを含む @odata.deltaLink URL 全体を保存して、その予定表ビューの次の一覧の変更追跡の最初の要求に適用します。
$skiptoken	string	前のデルタ関数呼び出しの @odata.nextLink URL 内で返された状態トークンで、同じカレンダー ビュー内に追跡されるべきさらなる変化があることを示しています。

OData クエリ パラメーター

• calendarView での delta 関数の呼び出しは、通常の GET /calendarView 要求で取得するものと同じプロパティを返すことを予想します。 $select を使用して、それらのプロパティのサブセットのみを取得することはできません。

• calendarView の delta 関数がサポートしていない OData クエリ パラメーターは他にも $expand、$filter、$orderby、および $search があります。

要求ヘッダー

名前	種類	説明
Authorization	string	ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type	string	application/json. Required.
Prefer	string	odata.maxpagesize={x}。 省略可能。
Prefer	string	{タイム ゾーン}。 省略可能。存在しない場合は UTC と見なされます。

応答

成功した場合、このメソッドは 200 OK の応答コードと、応答本文で イベント コレクション オブジェクトを返します。

calendarView の日付範囲にバインドされた delta 関数呼び出しのラウンド内で、差分呼び出しが @removed 以下の 2 種類のイベントを以下の deleted の理由で返すことがあります。

• 日付範囲内にあり、前回の差分呼び出し以降に削除されたイベント。
• 日付範囲外にあり、前回の差分呼び出し以降に追加、削除、または更新されたイベント。

シナリオで必要とされる日付範囲の @removed 以下のイベントをフィルター処理します。

例

要求

次の例では、1 回のデルタ関数呼び出しを行い、応答本文中のイベントの最大数を 2 に制限する方法を示します。

カレンダー ビュー内の変更を追跡するには、1 回以上のデルタ関数呼び出しを作成し、適切な状態トークンを使用して、前回のデルタ クエリ以降になされた一連の増分変更を取得します。

HTTP

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?startdatetime={start_datetime}&enddatetime={end_datetime}
Prefer: odata.maxpagesize=2

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.CalendarView.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.StartDateTime = "{start_datetime}";
	requestConfiguration.QueryParameters.EndDateTime = "{end_datetime}";
	requestConfiguration.Headers.Add("Prefer", "odata.maxpagesize=2");
});

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "odata.maxpagesize=2")


requestStartDateTime := "{start_datetime}"
requestEndDateTime := "{end_datetime}"

requestParameters := &graphusers.ItemCalendarViewDeltaWithRequestBuilderGetQueryParameters{
	StartDateTime: &requestStartDateTime,
	EndDateTime: &requestEndDateTime,
}
configuration := &graphusers.ItemCalendarViewDeltaWithRequestBuilderGetRequestConfiguration{
	Headers: headers,
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.Me().CalendarView().Delta().GetAsDeltaGetResponse(context.Background(), configuration)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.me().calendarView().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.startDateTime = "{start_datetime}";
	requestConfiguration.queryParameters.endDateTime = "{end_datetime}";
	requestConfiguration.headers.add("Prefer", "odata.maxpagesize=2");
});

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/calendarView/delta?startdatetime={start_datetime}&enddatetime={end_datetime}')
	.header('Prefer','odata.maxpagesize=2')
	.get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\CalendarView\Delta\DeltaRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$headers = [
		'Prefer' => 'odata.maxpagesize=2',
	];
$requestConfiguration->headers = $headers;

$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->startDateTime = "{start_datetime}";
$queryParameters->endDateTime = "{end_datetime}";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->calendarView()->delta()->get($requestConfiguration)->wait();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.calendar_view.delta.delta_request_builder import DeltaRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		start_date_time = "{start_datetime}",
		end_date_time = "{end_datetime}",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)
request_configuration.headers.add("Prefer", "odata.maxpagesize=2")


result = await graph_client.me.calendar_view.delta.get(request_configuration = request_configuration)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

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

以下の応答は、@odata.nextLink 応答ヘッダーに含まれる skipToken を示しています。

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

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

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "transactionId": null,
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isDraft": false,
      "isReminderOn": true
    }
  ]
}

関連コンテンツ

• デルタ クエリを使用して、Microsoft Graph データの変更を追跡する
• カレンダー内のイベントの増分の変更を取得する