contact : deltacontact: delta

Espace de noms: microsoft.graphNamespace: microsoft.graph

Obtenez un ensemble de contacts qui ont été ajoutés, supprimés ou mis à jour dans un dossier spécifié.Get a set of contacts that have been added, deleted, or updated in a specified folder.

Un appel de fonction delta pour les contacts d’un dossier est similaire à une requête GET, sauf que lorsque vous appliquez correctement des jetons d’état dans un ou plusieurs de ces appels, vous pouvez rechercher les modifications incrémentielles dans les contacts de ce dossier. Cela vous permet de mettre à jour et de synchroniser une collection locale des contacts d’un utilisateur, sans avoir à récupérer l’ensemble des contacts de l’utilisateur depuis le serveur.A delta function call for contacts in a folder is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in the contacts in that folder. This allows you to maintain and synchronize a local store of a user's contacts without having to fetch the entire set of contacts from the server every time.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
ApplicationApplication Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite

Requête HTTPHTTP request

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

Paramètres de requêteQuery parameters

Le suivi des modifications dans les contacts entraîne une série d’un ou de plusieurs appels de fonction delta. Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du nextLink ou de l’URL deltaLink fournie dans la réponse. Il vous suffit de spécifier les paramètres de requête de votre choix la première fois. Dans les requêtes suivantes, copiez et appliquez le nextLink ou l’URL deltaLink à partir de la réponse précédente, car cette URL inclut déjà les paramètres codés souhaités.Tracking changes in contacts incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. You only need to specify any desired query parameters once upfront. In subsequent requests, simply copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

Paramètre de requêteQuery parameter TypeType DescriptionDescription
$deltatoken$deltatoken stringstring Jeton d’état renvoyé dans l’URL deltaLink de l’appel de fonction delta précédent pour la même collection de contacts, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.A state token returned in the deltaLink URL of the previous delta function call for the same contact collection, indicating the completion of that round of change tracking. Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that collection.
$skiptoken$skiptoken stringstring Jeton d’état renvoyé dans l’URL nextLink de l’appel de fonction delta précédent, indiquant que des modifications supplémentaires doivent être suivies dans la même collection de contacts.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same contact collection.

Paramètres de requête ODataOData query parameters

  • Vous pouvez utiliser un paramètre de requête $select comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée.You can use a $select query parameter as in any GET request to specify only the properties your need for best performance. The id property is always returned.

En-têtes de demandeRequest headers

NomName TypeType DescriptionDescription
AutorisationAuthorization stringstring Porteur {token}. Obligatoire.Bearer {token}. Required.
Content-TypeContent-Type stringstring application/json. Obligatoire.application/json. Required.
PréférencePrefer chaînestring odata.maxpagesize={x}. Facultatif.odata.maxpagesize={x}. Optional.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet de la collection contact dans le corps de la réponse.If successful, this method returns a 200 OK response code and contact collection object in the response body.

ExempleExample

DemandeRequest

L’exemple suivant montre comment effectuer un seul appel de fonction delta, utilisez le paramètre $select pour obtenir uniquement la propriété de chaque contact displayName et limiter le nombre maximal de contacts dans le corps de réponse à 2.The following example shows how to make a single delta function call, use the $select parameter to get only each contact's displayName property, and limit the maximum number of contacts in the response body to 2.

Pour effectuer le suivi des modifications dans les contacts d’un dossier, effectuez un ou plusieurs appels de fonction delta avec des jetons d’état appropriés, pour accéder à l’ensemble des modifications incrémentielles depuis la dernière requête delta.To track changes in the contacts in a folder, you would make one or more delta function calls, with appropriate state tokens, to get the set of incremental changes since the last delta query.

Vous pouvez trouver un exemple similaire qui montre comment utiliser les jetons d’état pour effectuer le suivi des modifications dans les messages d’un dossier de courriers : Apporter des modifications incrémentielles aux messages dans un dossier Les principales différences entre le suivi des contacts et le suivi des messages dans un dossier résident dans les URL de la requête delta et dans les réponses de la requête renvoyant contact plutôt que des collections de messages.You can find a similar example that shows how to use the state tokens to track changes in the messages of a mail folder: Get incremental changes to messages in a folder. The main differences between tracking contacts and tracking messages in a folder are in the delta query request URLs, and the query responses returning contact rather than message collections.

GET https://graph.microsoft.com/v1.0/me/contactFolders/{id}/contacts/delta?$select=displayName
Prefer: odata.maxpagesize=2
RéponseResponse

Si la requête est acceptée, la réponse inclut un jeton d’état qui est un skipTokenIf the request is successful, the response would include a state token, which is either a skipToken
(dans un en-tête de réponse _@odata.nextLink_) ou un deltaToken (dans un en-tête de réponse _@odata.deltaLink_). Ils indiquent respectivement si vous devez continuer avec la série ou si vous avez terminé d’accéder à toutes les modifications pour cette série.(in an _@odata.nextLink_ response header) or a deltaToken (in an _@odata.deltaLink_ response header). Respectively, they indicate whether you should continue with the round or you have completed getting all the changes for that round.

La réponse suivante illustre un skipToken dans un en-tête de réponse _@odata.nextLink_.The response below shows a skipToken in an _@odata.nextLink_ response header.

Remarque : L’objet de réponse illustré ici peut être tronqué à des fins de concision. Toutes les propriétés sont renvoyées à partir d’un appel réel.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@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"
    }
  ]
}

Voir aussiSee also