Partager via

Créer un signet

  • Article

Espace de noms : microsoft.graph.search

Créez un objet bookmark .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

Requête HTTP

POST /search/bookmarks

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet bookmark .

Le tableau suivant indique les propriétés disponibles lorsque vous créez un signet.

Propriété Type Description
availabilityEndDateTime DateTimeOffset Date et heure auxquelles le signet cesse d’apparaître en tant que résultat de recherche. Définissez comme null pour toujours disponible. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
availabilityStartDateTime DateTimeOffset Date et heure auxquelles le signet commence à apparaître en tant que résultat de recherche. Définissez comme null pour toujours disponible. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
categories String collection Catégories couramment utilisées pour décrire ce signet. Par exemple, IT et HR.
description Chaîne Description du signet qui s’affiche sur la page des résultats de la recherche. Hérité de searchAnswer.
displayName Chaîne Nom du signet affiché dans les résultats de la recherche. Hérité de searchAnswer.
groupIds String collection Liste des groupes de sécurité qui peuvent afficher ce signet.
keywords microsoft.graph.search.answerKeyword Mots clés qui déclenchent l’affichage de ce signet dans les résultats de recherche.
languageTags String collection Liste des noms de langue spécifiques à la zone géographique dans laquelle ce signet peut être affiché. Chaque valeur de balise de langue suit le modèle {language}-{region}. Par exemple, en-us est anglais tel qu’utilisé aux États-Unis. Pour obtenir la liste des valeurs possibles, consultez Balises de langue prises en charge.
Plates-formes collection microsoft.graph.devicePlatformType Liste des appareils et systèmes d’exploitation qui peuvent afficher ce signet. Les valeurs possibles sont android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue.
powerAppIds String collection Liste des applications Power Apps associées à ce signet. Si les utilisateurs ajoutent des applications Power Apps existantes à un signet, ils peuvent effectuer des tâches directement dans la page des résultats de la recherche, telles que la saisie de congés ou la création de rapports de dépenses.
state microsoft.graph.search.answerState État du signet. Les valeurs possibles sont les suivantes : published, draft, excluded, unknownFutureValue.
targetedVariations collection microsoft.graph.search.answerVariant Variantes d’un signet pour différents pays ou appareils. Utilisez lorsque vous devez afficher un contenu différent aux utilisateurs en fonction de leur appareil, pays/région, ou les deux. Les paramètres de date et de groupe s’appliquent à toutes les variantes.
webUrl Chaîne Lien URL du signet. Lorsque les utilisateurs sélectionnent ce signet dans les résultats de la recherche, ils sont dirigés vers l’URL spécifiée. Hérité de searchAnswer.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse avec l’ID du signet créé.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/v1.0/search/bookmarks
Content-Type: application/json

{
  "displayName": "Contoso Install Site",
  "webUrl": "http://www.contoso.com/",
  "description": "Try or buy Contoso for Home or Business and view product information",
  "keywords":  {
    "keywords": ["Contoso", "install"],
    "reservedKeywords": ["Unique keyword"],
    "matchSimilarKeywords": true
  },
  "availabilityStartDateTime": null,
  "availabilityEndDateTime": null,
  "platforms": ["windows"],
  "targetedVariations": [
    {
      "languageTag": "es-es",
      "displayName": "Sitio de instalación Contoso",
      "description": "Pruebe o compre Contoso hogar o negocios y vea la información del producto"
    }
  ],
  "state": "published"
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 201 Created
Location: /733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "id": "733b26d5-af76-4eea-ac69-1a0ce8716897"
}