contact: delta

名前空間: microsoft.graph

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

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

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

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

アクセス許可

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

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

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 には、エンコードされた目的のパラメーターが既に含まれています。

クエリ パラメーター	種類	説明
$deltatoken	string	同じ連絡先コレクションに対する前のデルタ関数呼び出しの@odata.deltaLink URL で返された状態トークン。変更追跡のラウンドの完了を示します。 このコレクションについて、このトークンを含む、@odata.deltaLink URL 全体を次の変更追跡のラウンドの最初の要求に保存し、適用します。
$skiptoken	string	前のデルタ関数呼び出しの @odata.nextLink URL で状態トークンが返され、同じ連絡先コレクションに追跡すべき変更が他にもあることを示します。

OData クエリ パラメーター

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

要求ヘッダー

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

応答

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

例

要求

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

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

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

HTTP

GET https://graph.microsoft.com/v1.0/me/contactFolders/{id}/contacts/delta?$select=displayName
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.ContactFolders["{contactFolder-id}"].Contacts.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName" };
	requestConfiguration.Headers.Add("Prefer", "odata.maxpagesize=2");
});

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

CLI

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

プロジェクトに 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")

requestParameters := &graphusers.ItemContactFolderItemContactsDeltaWithRequestBuilderGetQueryParameters{
	Select: [] string {"displayName"},
}
configuration := &graphusers.ItemContactFolderItemContactsDeltaWithRequestBuilderGetRequestConfiguration{
	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().ContactFolders().ByContactFolderId("contactFolder-id").Contacts().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().contactFolders().byContactFolderId("{contactFolder-id}").contacts().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"displayName"};
	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/contactFolders/{id}/contacts/delta')
	.header('Prefer','odata.maxpagesize=2')
	.select('displayName')
	.get();

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

PHP

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


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

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

$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["displayName"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->contactFolders()->byContactFolderId('contactFolder-id')->contacts()->delta()->get($requestConfiguration)->wait();

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

PowerShell

Import-Module Microsoft.Graph.Users.Functions

# A UPN can also be used as -UserId.
Get-MgUserContactFolderContactDelta -UserId $userId -ContactFolderId $contactFolderId -Property "displayName" 

プロジェクトに 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.contact_folders.item.contacts.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(
		select = ["displayName"],
)

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


result = await graph_client.me.contact_folders.by_contact_folder_id('contactFolder-id').contacts.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/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 データの変更を追跡する
• フォルダー内のメッセージへの増分の変更を取得する