Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
Obtenha um conjunto de contatos que foram adicionados, excluídos ou atualizados em uma pasta especificada.
Uma chamada de função delta para contatos em uma pasta é semelhante a uma solicitação GET, exceto que, aplicando tokens de estado adequadamente em uma ou mais dessas chamadas, você pode consultar alterações incrementais nos contatos dessa pasta. Isso permite que você mantenha e sincronize um armazenamento local dos contatos de um usuário sem ter que buscar todo o conjunto de contatos do servidor todas as vezes.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global | Governo dos EUA L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão | Permissões menos privilegiadas | Permissões com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | Contacts.Read | Contacts.ReadWrite |
| Delegado (conta pessoal da Microsoft) | Contacts.Read | Contacts.ReadWrite |
| Aplicativo | Contacts.Read | Contacts.ReadWrite |
Solicitação HTTP
GET /me/contactFolders/{id}/contacts/delta
GET /users/{id | userPrincipalName}/contactFolders/{id}/contacts/delta
Parâmetros de consulta
O acompanhamento de alterações nos contatos incorre em uma rodada de uma ou mais chamadas de função delta . Se você usar qualquer parâmetro de consulta (diferente de $deltatoken e $skiptoken), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink ou @odata.deltaLink fornecida na resposta. Você só precisa especificar uma vez os parâmetros de consulta desejados antecipadamente.
Em solicitações subsequentes, basta copiar e aplicar a @odata.nextLink URL ou @odata.deltaLink da resposta anterior, pois essa URL já inclui os parâmetros codificados e desejados.
| Parâmetro de consulta | Tipo | Descrição |
|---|---|---|
| $deltatoken | string | Um token de estado retornado na @odata.deltaLink URL da chamada de função delta anterior para a mesma coleção de contatos, indicando a conclusão dessa rodada de controle de alterações. Salve e aplique toda a URL @odata.deltaLink, incluindo esse token na primeira solicitação da próxima série de controle de alterações desse conjunto. |
| $skiptoken | string | Um token de estado retornado na URL @odata.nextLink da chamada de função delta anterior indicando que não há mais alterações a serem controladas na mesma coleção de contatos. |
Parâmetros de consulta OData
- Você pode usar um parâmetro de consulta
$selectcomo em qualquer solicitação GET para especificar somente as propriedades necessárias para obter melhor desempenho. A propriedade id sempre será retornada.
Cabeçalhos de solicitação
| Nome | Tipo | Descrição |
|---|---|---|
| Autorização | string | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type | string | application/json. Obrigatório. |
| Preferir | cadeia de caracteres | odata.maxpagesize={x}. Opcional. |
Resposta
Se bem-sucedido, este método retorna o código de resposta 200 OK e uma coleção de objetos contact no corpo da resposta.
Exemplo
Solicitação
O exemplo a seguir mostra como fazer uma única chamada de função delta, use o parâmetro $select para obter apenas a propriedade displayName de cada contato e limite o número máximo de contatos no corpo de resposta a 2.
Para controlar as alterações nos contatos em uma pastas, faça uma ou mais chamadas de função delta, com os tokens de estado apropriados, para obter o conjunto de alterações incrementais desde a última consulta delta.
Você pode encontrar um exemplo semelhante que mostra como usar os tokens de estado para controlar alterações nas mensagens de uma pasta de email: Obtenha alterações incrementais nas mensagens de uma pasta. As principais diferenças entre o acompanhamento de contatos e o acompanhamento de mensagens em uma pasta estão nas URLs de solicitação de consulta delta e nas respostas de consulta retornando contato em vez de coleções de mensagens .
GET https://graph.microsoft.com/v1.0/me/contactFolders/{id}/contacts/delta?$select=displayName
Prefer: odata.maxpagesize=2
Resposta
Se a solicitação for bem-sucedida, a resposta incluiria um token de estado que é um skipToken
(em um cabeçalho de resposta @odata.nextLink ) ou um deltaToken (em um cabeçalho de resposta @odata.deltaLink ).
Respectivamente, eles indicam se você deve continuar com a rodada ou se concluiu a obtenção de todas as alterações para essa rodada.
A resposta abaixo mostra um skipToken em um cabeçalho de resposta @odata.nextLink.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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"
}
]
}