contact: delta

名前空間: microsoft.graph

指定したフォルダーで追加、削除、更新された連絡先のセットを取得します。

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

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

アクセス許可

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

HTTP 要求

GET /me/contactFolders/{id}/contacts/delta
GET /users/{id}/contactFolders/{id}/contacts/delta

クエリ パラメーター

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

OData クエリ パラメーター

• GET 要求と同様に、 $select クエリ パラメーターを使用して、最適なパフォーマンスを得るために必要なプロパティのみを指定できます。 id プロパティは常に返されます。

要求ヘッダー

応答

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

例

要求

デルタ関数の呼び出しを 1 つ作成し、$select パラメーターを使用して各連絡先のdisplayName プロパティのみを取得し、応答本文に含まれる連絡先の最大数を 2 に制限する方法を示します。

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

状態トークンを使用してメール フォルダーのメッセージの変更を追跡する方法を示す同様の例を見つけることができます。フォルダー 内のメッセージに対する増分変更を取得します。 フォルダー内の連絡先の追跡とメッセージの追跡の主な違いは、デルタ クエリ要求 URL と、メッセージ コレクションではなく連絡先を返すクエリ応答にあります。

GET https://graph.microsoft.com/beta/me/contactFolders/{id}/contacts/delta?$select=displayName

Prefer: odata.maxpagesize=2

mgc-beta users contact-folders contacts delta get --user-id {user-id} --contact-folder-id {contactFolder-id} --select "displayName"

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/contactFolders/{id}/contacts/delta')
	.version('beta')
	.select('displayName')
	.get();

応答

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

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

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

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/contactfolders/{id}/contacts/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "parentFolderId": "parentFolderId-value",
      "birthday": "2016-10-19T10:37:00Z",
      "fileAs": "fileAs-value",
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "initials": "initials-value"
    }
  ]
}

関連コンテンツ

• Microsoft Graph デルタ クエリ
• フォルダー内のメッセージへの増分の変更を取得する