Usar a API de pesquisa da Microsoft para pesquisar eventos de calendárioUse the Microsoft Search API to search calendar events

Use a API de pesquisa da Microsoft para pesquisar eventos no calendário principal do usuário conectado.Use the Microsoft Search API to search for events in the signed-in user’s primary calendar. A identidade do usuário para a pesquisa se baseia no token de autenticação.The user identity for the search is based on the auth token.

Cuidado

O esquema de API de pesquisa foi alterado com algumas propriedades em uma solicitação de pesquisa e resposta renomeada ou removida.The search API schema has changed with some properties in a search request and response renamed or removed. Veja mais detalhes sobre a substituição.See more details about the deprecation. Os exemplos neste tópico mostram o esquema a usar no futuro.Examples in this topic show the schema to use going forward.

ExemploExample

SolicitaçãoRequest

Este exemplo procura a palavra-chave "contoso" no calendário do usuário e retorna até 25 resultados.This example searches in the user's calendar for the keyword "contoso", and will return up to 25 results.

POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "event"
      ],
      "query": {
        "queryString":"contoso"
      },
      "from": 0,
      "size": 25
    }
  ]
}

RespostaResponse

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#search",
  "value": [
  {
   "@odata.type": "#microsoft.graph.searchResponse",
   "searchTerms": [
    "contoso"
   ],
   "hitsContainers": [
    {
     "@odata.type": "#microsoft.graph.searchHitsContainer",
     "hits": [
      {
       "@odata.type": "#microsoft.graph.searchHit",
       "hitId": "AAMkADEwODY2NzllLTQ3MmEtNGRlMC05ZTUyLTE4ZDRhYmU1ZGM3NABGAAAAAAA3+iYQBnJnQabRVDelNhnzBwAejhWkAOAxQ6M4c1c9NwfrAAAAAAENAAAejhWkAOAxQ6M4c1c9NwfrAABbUZLJAAA=",
       "rank": 1,
       "summary": "Here is a summary of your events from last week",
       "resource": {
        "@odata.type": "#microsoft.graph.event",
        "end": {
         "dateTime": "2020-06-16T04:15:00Z",
         "timeZone": "UTC"
        },
        "hasAttachments": false,
        "iCalUId": "040000008200E00074C5B7101A82E008000000007093FDD79B3AD60100000000000000001000000036DAA2262EB4E04DA27DA77985FB8251",
        "isAllDay": false,
        "sensitivity": "Normal",
        "start": {
         "dateTime": "2020-06-16T03:30:00Z",
         "timeZone": "UTC"
        },
        "subject": "Weekly digest: Microsoft 365 changes",
        "type": "Single"
       }
      }
     ],
     "total": 1,
     "moreResultsAvailable": false
    }
   ]
  }
 ]
}

Limitações conhecidasKnown limitations

  • Você pode acessar somente a caixa de correio do usuário conectado.You can access only the signed-in user’s own mailbox. Não há suporte para a pesquisa de caixas de correio delegadas.Searching delegated mailboxes is not supported.
  • Para eventos, a propriedade total do tipo searchHitsContainer contém o número de resultados na página, e não o número total de resultados correspondentes.For events, the total property of the searchHitsContainer type contains the number of results on the page, not the total number of matching results.
  • A classificação de resultados não é suportada para eventos.Sorting results is not supported for events. Uma cláusula de classificação na solicitação retornará um código de erro de solicitação inválida na resposta.A sort clause in the request will return a Bad Request error code in the response.

Próximas etapasNext steps