Informations de référence sur l’API Recherche web v7

Avertissement

Les API Recherche Bing passent de Cognitive Services aux services de recherche Bing. À compter du 30 octobre 2020, toutes les nouvelles instances de Recherche Bing doivent être provisionnées en suivant le processus documenté ici. Les API Recherche Bing provisionnées à l’aide de Cognitive Services seront prises en charge les trois prochaines années ou jusqu’à la fin de votre Contrat Entreprise, selon la première éventualité. Pour obtenir des instructions de migration, consultez Services de recherche Bing.

L’API Recherche web vous permet d’envoyer une requête de recherche à Bing et de récupérer les résultats de recherche qui incluent des liens vers des pages web, des images, etc. Cette section fournit des détails techniques sur les pages web, les recherches connexes et les résultats de classement en plus des paramètres de requête qui affectent les résultats de la recherche. Pour obtenir des exemples montrant comment effectuer des requêtes, consultez Rechercher sur le web.

Pour plus d’informations sur les en-têtes que les demandes doivent inclure, consultez En-têtes de requête.

Pour plus d’informations sur les paramètres de requête que les demandes doivent inclure, consultez Paramètres de requête.

Pour plus d’informations sur les objets JSON que la réponse peut inclure, consultez Corps de la réponse. Cette référence contient un objet JSON spécifique aux réponses web. Pour plus d’informations sur les objets JSON pour d’autres types de réponses que les résultats de recherche peuvent inclure, consultez la documentation de référence spécifique à l’API. Par exemple, si le résultat de la recherche contient les images et les réponses aux actualités, consultez l’API Recherche d’images et l’API Recherche d’actualités.

Pour plus d’informations sur l’utilisation autorisée et l’affichage des résultats, consultez les exigences d’utilisation et d’affichage de l’API de recherche Bing.

Notes

Étant donné que les paramètres et formats d’URL sont susceptibles de changer sans préavis, utilisez toutes les URL telles quelles. Vous ne devez pas créer de dépendances par rapport au format d’URL ou aux paramètres sauf indication contraire.

Points de terminaison

Pour demander des résultats de recherche web, envoyez une requête GET à :

https://api.cognitive.microsoft.com/bing/v7.0/search

Pour les abonnements multiservices, vous devez inclure la région dans l’URL. Par exemple : westus.api.cognitive.microsoft.com. Consultez Régions prises en charge.

La requête doit utiliser le protocole HTTPS.

Notes

La longueur maximale de l’URL est de 2 048 caractères. Pour que votre URL ne dépasse pas la limite, la longueur maximale de vos paramètres de requête doit être inférieure à 1 500 caractères. Si l’URL dépasse 2 048 caractères, le serveur retourne une erreur 404 (Introuvable).

headers

Voici les en-têtes possibles d’une demande et d’une réponse.

En-tête Description
Acceptation En-tête de demande facultatif.

Le type de média par défaut est application/json. Pour spécifier que la réponse utilise JSON-LD, donnez la valeur application/ld+json à l’en-tête Accept.
Accept-Language En-tête de demande facultatif.

Liste délimitée par des virgules des langues à utiliser pour les chaînes d’interface utilisateur. Elle est triée par ordre de préférence décroissant. Pour plus d’informations, notamment le format attendu, voir RFC2616.

Cet en-tête et le paramètre de requête setLang s’excluent mutuellement ; ne spécifiez pas les deux.

Si vous définissez cet en-tête, vous devrez également spécifier le paramètre de requête cc. Pour déterminer pour quel marché les résultats devront être retournés, Bing utilise la première langue prise en charge qu’il trouve dans la liste et la combine avec la valeur du paramètre cc. Si la liste ne comporte pas de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la demande, ou utilise un marché agrégé ou par défaut pour les résultats. Pour identifier le marché utilisé par Bing, voir l’en-tête BingAPIs-Market.

N’utilisez cet en-tête et le paramètre de requête cc que si vous spécifiez plusieurs langues. Sinon, utilisez les paramètres de requête mkt et setLang.

Une chaîne d’interface utilisateur est une chaîne utilisée comme étiquette dans une interface utilisateur. Les objets de réponse JSON en comportent quelques-unes. Les liens vers les propriétés Bing.com dans les objets de la réponse s’appliquent à la langue spécifiée.
BingAPIs-Market En-tête de réponse.

Marché utilisé par la demande. Le format est <languageCode>-<countryCode>. Par exemple, en-US.

Si vous spécifiez un marché qui n’est pas répertorié dans les codes de marché, cette valeur peut différer du marché que vous avez spécifié dans le paramètre de requête mkt . La même valeur est vraie si vous spécifiez des valeurs pour cc et Accept-Language qui ne peuvent pas être rapprochées.
BingAPIs-TraceId En-tête de réponse.

ID de l’entrée du journal contenant les détails de la demande. Lorsqu’une erreur se produit, capturez cet ID. Si vous ne parvenez pas à identifier ou à résoudre le problème, précisez cet ID avec les autres informations envoyées à l’équipe de support.
Ocp-Apim-Subscription-Key En-tête de demande requis.

Clé d’abonnement reçue lors de l’inscription à ce service dans Cognitive Services.
Pragma En-tête de demande facultatif.

Par défaut, Bing retourne le contenu en cache, s’il est disponible. Pour éviter cela, définissez l’en-tête Pragma sur no-cache (par exemple, Pragma: no-cache).
Retry-After En-tête de réponse.

La réponse inclut cet en-tête si vous dépassez le nombre de requêtes autorisées par seconde (QPS) ou par mois (QPM). L’en-tête contient le nombre de secondes que vous devez attendre avant d’envoyer une autre requête.
User-Agent En-tête de demande facultatif.

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour offrir une expérience optimisée aux utilisateurs mobiles. Nous vous conseillons de toujours indiquer cet en-tête, bien qu’il soit facultatif.

L’agent utilisateur doit correspondre à la chaîne envoyée par n’importe quel navigateur couramment utilisé. Pour plus d’informations sur les agents utilisateurs, voir RFC 2616.

Voici quelques exemples de chaînes de l’agent utilisateur.
  • Windows Phone – Mozilla/5.0 (compatible ; MSIE 10.0 ; Windows Phone 8.0 ; Trident/6.0 ; IEMobile/10.0 ; ARM ; Touch ; NOKIA ; Lumia 822)

  • Android – Mozilla/5.0 (Linux ; U ; Android 2.3.5 ; en-us ; SCH-I500 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML ; comme Gecko) Version/4.0 Mobile Safari/533.1

  • iPhone – Mozilla/5.0 (iPhone ; CPU iPhone OS 6_1 comme Mac OS X) AppleWebKit/536.26 (KHTML ; comme Gecko) Mobile/10B142 iPhone4;1 BingWeb/3.03.1428.20120423

  • PC – Mozilla/5.0 (Windows NT 6.3 ; WOW64 ; Trident/7.0 ; Touch ; rv:11.0) comme Gecko

  • iPad – Mozilla/5.0 (iPad ; CPU OS 7_0 comme Mac OS X) AppleWebKit/537.51.1 (KHTML, comme Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID En-tête de demande et de réponse facultatif.

Bing utilise cet en-tête pour garantir aux utilisateurs un comportement cohérent d’un appel d’API Bing à l’autre. Bing propose souvent de nouvelles fonctionnalités et améliorations, et se sert de l’ID client comme d’une clé pour attribuer le trafic aux différentes versions d’évaluation. Si vous n’assignez pas le même ID client à un utilisateur d’une demande à l’autre, Bing est susceptible d’affecter cet utilisateur à plusieurs versions d’évaluation en conflit, ce qui risque de nuire à l’expérience utilisateur. Par exemple, si la deuxième demande comporte une attribution de version d’évaluation différente de la première, l’expérience se révélera peut-être inattendue. En outre, Bing pouvez utiliser l’ID client pour adapter les résultats web à l’historique de recherche de cet ID client, offrant une expérience plus riche pour l’utilisateur.

Bing utilise également cet en-tête pour aider à améliorer le classement des résultats en analysant l’activité générée par un ID client. L’amélioration de la pertinence permet d’obtenir des résultats de meilleure qualité de la part des API Bing et, en retour, des taux de clic plus élevés pour le consommateur des API.

IMPORTANT : Il est vivement recommandé d’indiquer cet en-tête, bien qu’il soit facultatif. Grâce à la persistance de l’ID client dans plusieurs demandes pour une même combinaison appareil/utilisateur final, (1) le consommateur des API bénéficie d’une expérience utilisateur cohérente et (2) le taux de clic est plus élevé du fait des résultats de meilleure qualité provenant des API Bing.

Voici les règles d’utilisation de base qui s’appliquent à cet en-tête.
  • Chaque utilisateur de votre application sur l’appareil doit avoir un ID client unique, généré par Bing.

    Si vous n’insérez pas cet en-tête dans la demande, Bing génère un ID et le retourne dans l’en-tête de réponse X-MSEdge-ClientID. La première fois que l’utilisateur utilise votre application sur cet appareil est la seule fois où vous ne devez PAS inclure cet en-tête dans la demande.

  • ATTENTION : Vous devez vous assurer que cet ID client ne peut pas être associé à des informations de compte utilisateur authentifiables.

  • Utilisez l’ID client pour chaque requête d’API Bing qu’effectue votre application pour cet utilisateur sur l’appareil.

  • Conservez l’ID client. Pour conserver l’identifiant dans une application de navigateur, utilisez un cookie HTTP persistant qui garantit l’utilisation de cet identifiant dans toutes les sessions. N’utilisez pas de cookie de session. Dans le cas d’autres applications, comme des applications mobiles, utilisez le stockage persistant de l’appareil pour conserver cet identifiant.

    La prochaine fois que l’utilisateur utilisera votre application sur cet appareil, vous récupérerez l’ID client que vous aurez conservé.

REMARQUE : Les réponses de Bing ne comportent pas forcément cet en-tête. Si elles l’incluent, capturez l’ID client et utilisez-le pour toutes les demandes Bing suivantes concernant l’utilisateur sur cet appareil.

REMARQUE : Si vous insérez l’en-tête X-MSEdge-ClientID, n’incluez pas les cookies dans la requête.
X-MSEdge-ClientIP En-tête de demande facultatif.

Adresse IPv4 ou IPv6 de l’appareil client. L’adresse IP est utilisée pour découvrir l’emplacement de l’utilisateur. Bing utilise les informations de localisation pour déterminer le comportement de recherche approprié.

REMARQUE : Nous vous conseillons de toujours indiquer cet en-tête et l’en-tête X-Search-Location, bien qu’ils soient facultatifs.

N’obfusquez pas l’adresse (par exemple, en remplaçant le dernier octet par 0). Cela aurait pour effet d’éloigner la localisation de l’emplacement réel de l’appareil, ce qui pourrait conduire Bing à retourner des résultats erronés.
X-Search-Location En-tête de demande facultatif.

Liste délimitée par des points-virgules de paires clé/valeur qui décrivent la situation géographique du client. Bing utilise les informations de localisation pour déterminer le comportement de recherche approprié et retourner le contenu local pertinent. Spécifiez la paire clé/valeur sous la forme <clé>:<valeur>. Voici les clés permettant de spécifier l’emplacement de l’utilisateur.

  • lat : obligatoire. Latitude de la localisation du client, en degrés. Elle doit être supérieure ou égale à -90,0 et inférieure ou égale à +90,0. Les valeurs négatives indiquent les latitudes sud et les valeurs positives les latitudes nord.

  • long : obligatoire. Longitude de la localisation du client, en degrés. Elle doit être supérieure ou égale à -180,0 et inférieure ou égale à +180,0. Les valeurs négatives indiquent les longitudes occidentales et les valeurs positives les longitudes orientales.

  • re : obligatoire. Rayon, en mètres, qui spécifie la précision horizontale des coordonnées. Transmettez la valeur retournée par le service de localisation de l’appareil. Voici quelques valeurs courantes : 22 m pour le GPS/Wi-Fi, 380 m pour la triangulation des tours cellulaires et 18 000 m pour la recherche IP inversée.

  • ts : facultatif. Horodatage UTC UNIX correspondant au moment où le client était à cette position. (L’horodatage UNIX est le nombre de secondes écoulées depuis le 1er janvier 1970.)

  • head – Facultatif. Direction relative du client en déplacement. Spécifiez-la en degrés, entre 0 et 360, dans le sens horaire par rapport au nord géographique. N’indiquez cette clé que si la clé sp est différente de zéro.

  • sp : facultatif. Vitesse horizontale, en mètres par seconde, à laquelle se déplace l’appareil client.

  • alt : facultatif. Altitude de l’appareil client, en mètres.

  • are : facultatif. Rayon, en mètres, qui spécifie la précision verticale des coordonnées. N’indiquez cette clé que si vous spécifiez la clé alt.

  • disp : facultatif. Emplacement géographique de l’utilisateur sous forme, disp:<City, State>. Par exemple, disp:Seattle, Washington. Il s’agit de la version de texte d’affichage de l’emplacement de l’utilisateur que vous avez spécifiée à l’aide des touches lat/long. Si cette valeur est en conflit avec les coordonnées lat/long, Bing utilise la valeur de disp comme emplacement de l’utilisateur.

REMARQUE : Bing ignore cet en-tête si la requête inclut un emplacement. Par exemple, si cet en-tête reflète l’emplacement de l’utilisateur comme San Francisco, mais que la requête est restaurants seattle, Bing retourne des restaurants situés à Seattle, Washington.

REMARQUE : Bien que la plupart des clés soient facultatives, plus vous fournissez d’informations, plus les résultats de localisation sont précis.

REMARQUE : Nous vous conseillons de toujours indiquer la situation géographique de l’utilisateur (qui est facultative). C’est particulièrement important si l’adresse IP du client ne reflète pas exactement l’emplacement physique de l’utilisateur (par exemple, si le client utilise un VPN). Pour obtenir des résultats optimaux, vous devez inclure cet en-tête et l’en-tête X-Search-ClientIP, mais au minimum, vous devez inclure cet en-tête.

Notes

N’oubliez pas que les conditions d’utilisation imposent le respect de toutes les lois en vigueur, y compris en ce qui concerne l’utilisation de ces en-têtes. Par exemple, dans certaines juridictions, comme en Europe, il faut obtenir le consentement de l’utilisateur pour pouvoir placer certains dispositifs de suivi sur les appareils des utilisateurs.

Paramètres de requête

Voici les paramètres de requête que la demande peut inclure. La colonne Obligatoire indique si vous devez absolument spécifier le paramètre. Vous devez encoder les valeurs des paramètres de requête dans une URL.

Name Valeur Type Obligatoire
answerCount Nombre de réponses que vous souhaitez inclure. Les réponses qui Bing retournent sont basées sur le classement. Par exemple, si Bing retourne des pages web, des images, des vidéos et des recherches associées pour une demande et que vous définissez ce paramètre sur deux (2), la réponse inclut des pages web et des images.

Si vous avez inclus le paramètre de requête dans la responseFilter même requête et que vous l’avez défini sur des pages web et des actualités, la réponse inclurait uniquement les pages web.

Pour plus d’informations sur la promotion d’une réponse classée dans la réponse, consultez promouvoir.
Entier non signé Non
cc Code à 2 caractères du pays d'où proviennent les résultats. Pour obtenir la liste des valeurs possibles, consultez Codes de marché.

Si vous définissez ce paramètre, vous devez également spécifier l’en-tête Accept-Language. Bing utilise la première langue prise en charge qu’elle trouve dans les langues spécifiées et la combine avec le code du pays pour déterminer le marché pour lequel retourner les résultats. Si la liste des langues n’inclut de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la requête. Ou, Bing peut utiliser un marché agrégé ou par défaut pour les résultats.

Utilisez ce paramètre de requête et l’en-tête Accept-Language uniquement si vous spécifiez plusieurs langues. Sinon, vous devez utiliser les mkt paramètres et setLang les paramètres de requête.

Ce paramètre et le paramètre de requête mkt s’excluent mutuellement ; ne spécifiez pas les deux.
String Non
count Nombre de résultats de recherche à renvoyer dans la réponse. La valeur par défaut est 10 et la valeur maximale est 50. Le nombre réel renvoyé peut être inférieur à ce que vous avez demandé.

Utilisez ce paramètre avec le paramètre pour afficher les offset résultats de la page. Pour plus d’informations, consultez Pagination des pages web.

Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez count sur 10 et offset 0 pour obtenir la première page des résultats. Pour chaque page suivante, incrémentez de offset 10 (par exemple, 0, 10, 20). Il est possible que plusieurs pages incluent un chevauchement dans les résultats.
UnsignedShort Non
Fraîcheur Filtrez les résultats de la recherche par les valeurs d’âge qui ne respectent pas la casse suivantes :
  • Jour : retourner des pages web qui Bing découvertes au cours des dernières 24 heures

  • Semaine : retourner des pages web qui Bing découvertes au cours des 7 derniers jours

  • Mois : retourner des pages web découvertes au cours des 30 derniers jours

Pour obtenir des articles découverts par Bing au cours d’une période spécifique, spécifiez une plage de dates sous la forme AAAA-MM-JJ.. AAAA-MM-JJ. Par exemple : &freshness=2019-02-01..2019-05-30. Pour limiter les résultats à une date unique, définissez ce paramètre sur une date spécifique. Par exemple : &freshness=2019-02-04.
String Non
mkt Marché d’où proviennent les résultats. En règle générale, mkt il s’agit du pays à partir duquel l’utilisateur effectue la demande. Toutefois, il peut s’agir d’un autre pays si l’utilisateur n’est pas situé dans un pays où Bing fournit des résultats. Le marché doit se trouver dans le <code> de code> de langue du< formulaire. Par exemple, en-US. La chaîne ne respecte pas la casse. Pour obtenir la liste des valeurs de marché possibles, consultez Codes de marché.

NOTE: Si vous le connaissez, vous êtes encouragé à toujours spécifier le marché. Le fait d’indiquer le marché aide Bing à router la requête et à renvoyer une réponse appropriée et optimale. Si vous spécifiez un marché qui n’est pas répertorié dans les codes de marché, Bing utilise un code de marché adapté le mieux en fonction d’un mappage interne susceptible de changer.

Ce paramètre et le paramètre de requête cc s’excluent mutuellement ; ne spécifiez pas les deux.
String Non
offset Décalage de base zéro qui indique le nombre de résultats de recherche à ignorer avant de retourner les résultats. La valeur par défaut est 0. Le décalage doit être inférieur à (totalEstimatedMatches - count).

Utilisez ce paramètre avec le paramètre pour afficher les count résultats de la page. Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez count sur 10 et offset 0 pour obtenir la première page des résultats. Pour chaque page suivante, incrémentez de offset 10 (par exemple, 0, 10, 20). il est possible que plusieurs pages incluent des chevauchements dans les résultats.
Court non signé Non
Promouvoir Liste délimitée par des virgules de réponses que vous souhaitez inclure, quel que soit leur classement. Par exemple, si vous définissez answerCount) sur deux (2) de sorte que Bing retourne les deux premières réponses classées, mais que vous souhaitez également que la réponse inclue des actualités, vous devez définir promote des actualités. Si les réponses les plus classées sont des pages web, des images, des vidéos et des recherches connexes, la réponse inclut des pages web et des images, car les actualités ne sont pas une réponse classée. Mais si vous définissez promote la vidéo, Bing promouvoirait la réponse vidéo dans la réponse et retournerait des pages web, des images et des vidéos.

Les correspondances que vous souhaitez promouvoir n’entrent pas dans la limite answerCount. Par exemple, si les correspondances classées sont des actualités, des images et des vidéos, et que vous affectez à answerCount la valeur 1 et définissez promote sur les actualités, la réponse contient des actualités et des images. Par ailleurs, si les correspondances classées sont des actualités, des images et des vidéos, la réponse contient des vidéos et des actualités.

Les valeurs possibles sont les suivantes.
  • Calcul
  • Images
  • Actualités
  • RelatedSearches
  • SpellSuggestions
  • TimeZone
  • Vidéos
  • Pages web

NOTE: Utilisez uniquement si vous spécifiez answerCount.
String Non
q Terme de requête de recherche de l’utilisateur. Le terme peut ne pas être vide.

Le terme peut contenir Bing opérateurs avancés. Par exemple, pour limiter les résultats à un domaine spécifique, utilisez l’opérateur site :
String Oui
responseFilter Liste délimitée par des virgules de réponses à inclure dans la réponse. Si vous ne spécifiez pas ce paramètre, la réponse inclut toutes les réponses de recherche pour lesquelles il existe des données pertinentes.

Voici les valeurs de filtre possibles.
  • Calcul
  • Entities
  • Images
  • Actualités
  • RelatedSearches
  • SpellSuggestions
  • TimeZone
  • Vidéos
  • Pages web

Si vous souhaitez exclure des types de contenu spécifiques de la réponse (des images, par exemple), vous pouvez ajouter un trait d’union (moins) en tant que préfixe à la valeur responseFilter. Séparer les types exclus avec une virgule : &responseFilter=-images,-videos

Bien que vous puissiez utiliser ce filtre pour obtenir une seule réponse, vous devez plutôt utiliser le point de terminaison spécifique à la réponse pour obtenir des résultats plus riches. Par exemple, pour recevoir uniquement des images, envoyez la demande à l’un des points de terminaison de l’API Recherche d’images .

Les réponses RelatedSearches et SpellSuggestions ne prennent pas en charge un point de terminaison distinct comme l’API Recherche d’images (seule l’API Recherche web les renvoie).

Pour inclure des réponses qui seraient autrement exclues en raison du classement, consultez le paramètre promouvoir la requête.
String Non
safeSearch filtre les pages web pour le contenu pour adultes. Voici les valeurs de filtre possibles.
  • Désactivé : renvoyer des pages web avec du texte et des images adultes.
  • Modéré – Retourner les pages web comportant du texte pour adultes, mais pas des images ou des vidéos pour adultes.
  • Strict – Ne pas retourner les pages web comportant du texte, des images ou des vidéos pour adultes.
La valeur par défaut est Modéré.

NOTE: Pour les résultats vidéo, s’il safeSearch est défini sur Désactivé, Bing l’ignore et utilise Moderate.

REMARQUE : Si la demande provient d’un marché où la stratégie de Bing en matière de contenu pour adultes exige que safeSearch ait la valeur Strict, Bing ignore la valeur safeSearch et utilise Strict.

REMARQUE : Si vous utilisez l’opérateur de requête site:, il est possible que la réponse présente du contenu pour adultes, et ce quel que soit le paramètre de requête safeSearch défini. N’utilisez site: que si vous connaissez le contenu du site et si votre scénario accepte le contenu pour adultes.
String Non
setLang Langue à utiliser pour les chaînes de l’interface utilisateur. Vous pouvez spécifier la langue à l’aide d’un code à 2 lettres ou à 4 lettres. L’utilisation de codes à 4 lettres est recommandée.

Pour obtenir la liste des codes de langue pris en charge, consultez Bing langues prises en charge.

Bing charge les chaînes localisées si setlang contient un code de culture neutre de 2 lettres valide (fr) ou un code de culture spécifique à 4 lettres valide (fr-ca). Par exemple, pour fr-ca, Bing charge les chaînes de code de culture neutres fr.

S’il setlang n’est pas valide (par exemple, zh) ou Bing ne prend pas en charge la langue (par exemple, af, af-na), Bing valeurs par défaut en (anglais).

Pour spécifier le code à 2 lettres, définissez ce paramètre sur un code de langue ISO 639-1.

Pour spécifier le code à 4 lettres, utilisez le formulaire <langue-pays<>/région> où <la langue> est un code de langue ISO 639-1 (culture neutre) et <pays/région> est un code iso 3166 pays/région (culture spécifique). Par exemple, utilisez en-US pour États-Unis anglais.

Nous vous conseillons de toujours indiquer la langue, bien qu’elle soit facultative. En général, on définit setLang sur la langue spécifiée par mkt, sauf si l’utilisateur souhaite que les chaînes de l’interface utilisateur soient affichées dans une autre langue.

Ce paramètre et l’en-tête Accept-Language s’excluent mutuellement ; ne spécifiez pas les deux.

Une chaîne d’interface utilisateur est une chaîne utilisée comme étiquette dans une interface utilisateur. Les objets de réponse JSON en comportent quelques-unes. En outre, les liens vers les propriétés Bing.com dans les objets de la réponse s’appliquent à la langue spécifiée.
String Non
Textdecorations Valeur booléenne qui détermine si les chaînes d’affichage doivent contenir des marqueurs de décoration tels que la mise en surbrillance des caractères. Si la valeur est true, les chaînes peuvent inclure des marqueurs. La valeur par défaut est false.

Pour spécifier s’il faut utiliser des caractères Unicode ou des balises HTML comme marqueurs, consultez le paramètre de requête textFormat .

Pour plus d’informations sur la mise en surbrillance des correspondances, consultez Mise en surbrillance des correspondances.
Boolean Non
textFormat Type de marqueurs à utiliser pour les décorations de texte (voir le textDecorations paramètre de requête).

Les valeurs possibles sont les suivantes.
  • Brut : utilisez des caractères Unicode pour marquer le contenu qui a besoin d’une mise en forme spéciale. Les caractères Unicode se trouvent dans la plage E000 à E019. Par exemple, Bing utilise E000 et E001 pour marquer le début et la fin des termes de requête pour la mise en surbrillance des correspondances.

  • HTML : utilisez des balises HTML pour marquer le contenu qui a besoin d’une mise en forme spéciale. Par exemple, utilisez <des balises b> pour mettre en surbrillance les termes de requête dans les chaînes d’affichage.

La valeur par défaut est Raw.

Pour obtenir la liste des marqueurs, consultez Mise en surbrillance des correspondances.

Pour les chaînes d’affichage qui contiennent des caractères HTML pouvant être échappés tels que <, >et &, si textFormat la valeur est définie sur HTML, Bing échappe les caractères appropriés (par exemple, < est placé &dans lt;).

Pour plus d’informations sur le traitement des chaînes avec les caractères Unicode incorporés, consultez Mise en surbrillance des correspondances.
String Non

Objets de réponse

Notes

Pour se conformer à la nouvelle directive sur le droit d’auteur de l’UE en France, les Bing web, les actualités, les vidéos, les images et toutes les API de recherche personnalisée doivent omettre du contenu de certaines sources d’actualités de l’UE pour Français utilisateurs. Le contenu supprimé peut inclure des images miniatures et des vidéos, des aperçus vidéo et des extraits de code qui accompagnent les résultats de recherche de ces sources. Par conséquent, les API Bing peuvent fournir moins de résultats avec des images miniatures et des vidéos, des aperçus vidéo et des extraits de code pour Français utilisateurs.

Voici les objets de réponse JSON que peut inclure la réponse. Si la demande aboutit, l’objet de niveau supérieur dans la réponse est l’objet SearchResponse. Si la demande échoue, l’objet de niveau supérieur est l’objet ErrorResponse.

Cette liste contient des objets JSON spécifiques aux réponses web. Pour plus d’informations sur les objets JSON pour d’autres types de réponses que les résultats de la recherche peuvent inclure, consultez la documentation de référence spécifique à l’API. Par exemple, si le résultat de la recherche contient les images et les réponses aux actualités, consultez l’API Image et l’API Actualités.

Object Description
Calcul Définit une expression et sa réponse.
Entité Définit une entité telle qu’une personne, un lieu ou une chose.
Error Définit une erreur qui s’est produite.
ErrorResponse Objet de niveau supérieur figurant dans la réponse en cas d’échec de la demande.
Identifiable Définit un ID de ressource.
LicenseAttribution Définit une règle contractuelle pour l’attribution de la licence.
LinkAttribution Définit une règle contractuelle pour l’attribution du lien.
MediaAttribution Définit une règle contractuelle pour l’attribution du média.
Requête Définit une chaîne de requête.
QueryContext Définit le contexte de requête qui Bing utilisé pour la requête, si la chaîne de requête spécifiée contient une erreur orthographique.
RankingGroup Définit un groupe de résultats de la recherche, par exemple, mainline.
RankingItem Définit un élément de groupe de classement à afficher.
RankingResponse Définit où le contenu doit être placé sur la page de résultats de la recherche et dans quel ordre.
RelatedSearchAnswer Définit une liste de requêtes associées effectuées par d’autres personnes.
SearchResponse Objet de niveau supérieur inclus par la réponse lorsque la requête réussit.
SpellSuggestions Définit une chaîne de requête suggérée qui représente probablement l’intention de l’utilisateur.
TextAttribution Définit une règle contractuelle pour l’attribution du texte brut.
Timezone Définit la date et l’heure d’un ou plusieurs emplacements géographiques.
TimeZoneInformation Définit les informations de fuseau horaire sur un emplacement géographique.
WebAnswer Définit une liste de liens de page web pertinents.
Page Définit une page web pertinente pour la requête.

Entité

Définit une entité telle qu’une personne, un lieu ou une chose.

Nom Valeur Type
bingId ID qui identifie de façon unique cette entité. String
contractualRules Liste des règles auxquelles vous devez adhérer si vous affichez l’entité. Par exemple, les règles peuvent régir l’attribut de la description de l’entité.

Les règles contractuelles suivantes peuvent s’appliquer.


Toutes les entités n’incluent pas de règles. Si l’entité fournit des règles contractuelles, vous devez les respecter. Pour plus d’informations sur l’utilisation de règles contractuelles, consultez Attributing Data.
Object[]
description Brève description de l’entité. String
entityPresentationInfo Informations supplémentaires sur l’entité (par exemple, indicateurs permettant de déterminer le type de l’entité : Pour déterminer le type de l’entité, utilisez les champs et entityTypeHint les entityScenario champs. Par exemple, les champs vous aident à déterminer si l’entité est une entité dominante ou d’ambiguïté et s’il s’agit d’une personne ou d’un film. L’entité est une entité dominante si Bing croit qu’une seule entité satisfait à la demande. Si plusieurs entités peuvent satisfaire la demande, l’entité est une entité d’ambiguïté et l’utilisateur doit sélectionner l’entité qui lui intéresse. EntityPresentationInfo
image Image de l’entité. Image
name Nom de l’entité. String
webSearchUrl URL qui amène l’utilisateur à la page de résultats de la recherche Bing pour cette entité. String

EntityAnswer

Définit une réponse d’entité.

Nom Valeur Type
queryScenario Scénario de requête pris en charge. Ce champ est défini sur DominantEntity ou DisambiguationItem. Le champ est défini sur DominantEntity si Bing détermine qu’une seule entité satisfait à la requête. Par exemple, un livre, un film, une personne ou une attraction. Si plusieurs entités peuvent satisfaire la demande, le champ est défini sur DisambiguationItem. Par exemple, si la demande utilise le titre générique d’une franchise de films, le type de l’entité serait probablement DisambiguationItem. Toutefois, si la demande spécifie un titre spécifique de la franchise, le type de l’entité serait probablement DominantEntity. String
value Liste d’entités. Entity[]

EntityPresentationInfo

Définit des informations supplémentaires sur une entité telle que les indicateurs de type.

Nom Valeur Type
entityScenario Scénario pris en charge. String
entityTypeDisplayHint Version d’affichage de l’indicateur d’entité. Par exemple, si entityTypeHints c’est Artiste, ce champ peut être défini sur American Singer. String
entityTypeHint Liste d’indicateurs qui indiquent le type de l’entité. La liste peut contenir un indicateur unique tel que Movie ou une liste d’indicateurs tels que Place, LocalBusiness, Restaurant. Chaque conseil successif de ce tableau se rapproche du type d’entité.

Pour obtenir la liste des types possibles, consultez Types d’entités. Si l’objet n’inclut pas ce champ, Generic est supposé.
String[]

Calcul

Définit une expression et sa réponse.

Élément Description Type
Expression Expression mathématique ou conversion.

Si la requête contient une requête pour convertir des unités de mesure (par exemple, des compteurs en pieds), ce champ contient les unités et valuecontient les unités.

Si la requête contient une expression mathématique telle que 2+2, ce champ contient l’expression et value contient la réponse.

Notez que les expressions mathématiques peuvent être normalisées. Par exemple, si la requête était sqrt(4^2+8^2), l’expression normalisée peut être sqrt((4^2)+(8^2)).

Si la requête de l’utilisateur est une question mathématique et que le paramètre de requête textDecorations a la valeur true, la chaîne d’expression peut inclure des marqueurs de mise en forme. Par exemple, si la requête de l’utilisateur est log(2), l’expression normalisée inclut les marqueurs d’indice. Pour plus d’informations, consultez Mise en surbrillance des correspondances.
String
value Réponse de l’expression. String

Error

Définit l’erreur qui s’est produite.

Élément Description Type
code Code d’erreur identifiant la catégorie de l’erreur. Pour connaître la liste des codes possibles, voir Codes d’erreur. String
message Description de l’erreur. String
moreDetails Description de l’erreur comportant des informations supplémentaires. String
parameter Paramètre de requête de la demande ayant provoqué l’erreur. String
subCode Code identifiant l’erreur. Par exemple, si code est InvalidRequest, subCode peut être ParameterInvalid ou ParameterInvalidValue. String
value Valeur du paramètre de requête qui n’était pas valide. String

ErrorResponse

Objet de niveau supérieur figurant dans la réponse en cas d’échec de la demande.

Nom Valeur Type
_type Indicateur de type. String
errors Liste des erreurs qui décrivent les raisons pour lesquelles la demande a échoué. Error[]

Identifiable

Définit l’identité d’une ressource.

Nom Valeur Type
id Identificateur. String

Image

Définit une image.

Notes

Étant donné que le format et les paramètres d’URL sont soumis à modification sans préavis, toutes les URL d’image doivent être utilisées comme c’est le cas ; vous ne devez pas prendre de dépendances sur le format ou les paramètres d’URL. L’exception est ces paramètres et valeurs abordés par les images redimensionner et rogner les miniatures.

Nom Valeur Type
height Hauteur de l’image source, en pixels. Court non signé
hostPageUrl URL de la page web qui inclut l’image.

Cette URL et contentUrl peut être la même URL.
String
name Chaîne de texte facultative qui contient des informations aléatoires sur l’image. String
provider Source de l’image. Le tableau contient un seul élément.

Vous devez attribuer l’image au fournisseur. Par exemple, vous pouvez afficher le nom du fournisseur en tant que curseur pointant sur l’image ou rendre l’image un lien de clic vers le site web du fournisseur où l’image est trouvée.
Organisation[]
thumbnailUrl URL vers une miniature de l’image. Pour plus d’informations sur le redimensionnement de l’image, consultez Redimensionner et rogner des images miniatures. String
width Largeur de l’image source, en pixels. Court non signé

LicenseAttribution

Définit une règle contractuelle pour l’attribution de la licence.

Nom Valeur Type
_type Indicateur de type, défini sur LicenseAttribution. String
license Licence sous laquelle il est possible d’utiliser le contenu. Licence
licenseNotice Licence à afficher à côté du champ ciblé. Par exemple, « Texte sous licence CC-BY-SA ».

Utilisez le nom de la licence et l’URL dans le champ license pour créer un lien hypertexte vers le site web décrivant les détails de la licence. Ensuite, remplacez le nom de la licence dans la chaîne licenseNotice (par exemple, CC-BY-SA) par le lien hypertexte que vous venez de créer.
String
mustBeCloseToContent Valeur booléenne qui détermine si le contenu de la règle doit être placé à proximité du champ auquel la règle s’applique. Si la valeur est true, le contenu doit être à proximité immédiate. Si ce champ a la valeur false ou n’existe pas, l’emplacement du contenu est à la discrétion de l’appelant. Boolean
targetPropertyName Nom du champ auquel la règle s’applique. String

LinkAttribution

Définit une règle contractuelle pour l’attribution du lien.

Nom Valeur Type
_type Indicateur de type, défini sur LinkAttribution. String
mustBeCloseToContent Valeur booléenne qui détermine si le contenu de la règle doit être placé à proximité du champ auquel la règle s’applique. Si la valeur est true, le contenu doit être à proximité immédiate. Si ce champ a la valeur false ou n’existe pas, l’emplacement du contenu est à la discrétion de l’appelant. Boolean
targetPropertyName Nom du champ auquel la règle s’applique.

Si aucune cible n’est spécifiée, l’attribution s’applique à l’entité dans son ensemble et devrait s’afficher juste après la présentation de l’entité. Si plusieurs règles d’attribution du texte et du lien ne spécifient pas de cible, concaténez-les et affichez-les avec une étiquette « Données provenant de : ». Par exemple, « Données du <nom du fournisseur 1> | < nom du fournisseur2> ».
String
text Texte d’attribution. String
url URL du site web du fournisseur. Utilisez text et l’URL pour créer le lien hypertexte. String

MediaAttribution

Définit une règle contractuelle pour l’attribution du média.

Nom Valeur Type
_type Indicateur de type, défini sur MediaAttribution. String
mustBeCloseToContent Valeur booléenne qui détermine si le contenu de la règle doit être placé à proximité du champ auquel la règle s’applique. Si la valeur est true, le contenu doit être à proximité immédiate. Si ce champ a la valeur false ou n’existe pas, l’emplacement du contenu est à la discrétion de l’appelant. Boolean
targetPropertyName Nom du champ auquel la règle s’applique. String
url URL utilisée pour créer le lien hypertexte du contenu multimédia. Par exemple, si la cible est une image, vous utiliserez l’URL pour rendre l’image cliquable. String

Métabalise

Définit les métadonnées d’une page web.

Nom Valeur Type
contenu Métadonnées. String
name Nom des métadonnées. String

Organisation

Définit un éditeur.

Notez qu’un éditeur peut indiquer son nom, son site web ou les deux.

Nom Valeur Type
name Nom de l’éditeur. String
url URL du site web de l’éditeur.

Notez que l’éditeur peut ne pas indiquer de site web.
String

Requête

Définit une requête de recherche.

L’objet SpellSuggestions utilise cet objet pour suggérer une chaîne de requête qui représente probablement l’intention de l’utilisateur. Il est également utilisé par RelatedSearchAnswer pour retourner une requête associée que d’autres utilisateurs ont effectuée.

Nom Valeur Type
displayText Version d’affichage du terme de requête. Cette version du terme de requête peut contenir des caractères spéciaux qui mettent en surbrillance le terme de recherche trouvé dans la chaîne de requête. La chaîne contient les caractères de mise en surbrillance uniquement si la requête a activé la mise en surbrillance des correspondances (voir le paramètre de requête textDecorations ). Pour plus d’informations sur la mise en surbrillance des correspondances, consultez Mise en surbrillance des correspondances. String
texte Chaîne de requête. Utilisez cette chaîne comme terme de requête dans une nouvelle requête de recherche. String
webSearchUrl URL qui amène l’utilisateur à la page de résultats de la recherche Bing pour la requête.

Seuls les résultats de recherche associés incluent ce champ.
String

QueryContext

Définit la chaîne de requête qui Bing utilisée pour la requête.

Élément Description Type
adultIntent Valeur booléenne qui indique si la requête spécifiée est destinée à des adultes. La valeur est true si la requête a l’intention adulte.

Si la valeur est true et que le paramètre de requête safeSearch de la requête est défini sur Strict, la réponse contient uniquement les résultats des actualités, le cas échéant.
Boolean
alterationOverrideQuery Chaîne de requête à utiliser pour forcer Bing à utiliser la chaîne d’origine. Par exemple, si la chaîne de requête est saling downwind, la chaîne de requête de remplacement est +saling downwind. N’oubliez pas d’encoder la chaîne de requête, ce qui entraîne %2Bsaling+downwind.

l’objet inclut ce champ uniquement si la chaîne de requête d’origine contient une erreur orthographique.
String
alteredQuery Chaîne de requête qui Bing utilisée pour effectuer la requête. Bing utilise la chaîne de requête modifiée si la chaîne de requête d’origine contenait des fautes d’orthographe. Par exemple, si la chaîne de requête est saling downwind, la chaîne de requête modifiée est sailing downwind.

L’objet inclut ce champ uniquement si la chaîne de requête d’origine contient une erreur orthographique.
String
askUserForLocation Valeur booléenne qui indique si Bing exige que l’emplacement de l’utilisateur donne des résultats précis. Si vous avez spécifié l’emplacement de l’utilisateur à l’aide des en-têtes X-MSEdge-ClientIP et X-Search-Location, vous pouvez ignorer ce champ.

Dans le cas des requêtes pour lesquelles l’emplacement de l’utilisateur doit fournir des résultats précis, comme « météo du jour » ou « restaurants proches », ce champ est défini sur true.

Dans le cas des requêtes qui précisent l’emplacement (par exemple, « météo Seattle »), ce champ est défini sur false. Ce champ est également défini sur false pour les requêtes qui ne sont pas conscientes de l’emplacement, telles que « best-seller ».
Boolean
originalQuery Chaîne de requête telle que spécifiée dans la demande. String

RankingGroup

Définit un groupe de résultats de la recherche, par exemple, mainline.

Nom Valeur Type
items Liste des éléments de résultat de recherche à afficher dans le groupe. RankingItem[]

RankingItem

Définit un élément de résultat de recherche à afficher. Pour plus d’informations sur l’utilisation des ID, consultez Utilisation du classement pour afficher les résultats.

Nom Valeur Type
answerType Réponse qui contient l’élément à afficher. Par exemple, Actualités.

Utilisez le type pour trouver la réponse dans l’objet SearchResponse . Le type est le nom d’un SearchResponse champ.
String
resultIndex Index de base zéro de l’élément dans la réponse.

Si l’élément ne comporte pas ce champ, affiche tous les éléments de la réponse. Par exemple, affiche tous les articles dans la réponse Actualités.
Integer
value ID qui identifie une réponse ou un élément de réponse à afficher. Si l’ID identifie une réponse, affiche tous les éléments de la réponse. Identifiable

RankingResponse

Définit où le contenu doit être placé sur la page de résultats de la recherche et dans quel ordre.

Nom Valeur Type
mainline Résultats de la recherche à afficher dans la partie principale. RankingGroup
pole Résultats de la recherche qui doivent être les plus visibles (par exemple, affichés au-dessus de la partie principale et de l’encadré). RankingGroup
sidebar Résultats de la recherche à afficher dans l’encadré. RankingGroup

RelatedSearchAnswer

Définit une liste de requêtes associées effectuées par d’autres personnes.

Nom Valeur Type
id ID qui identifie de manière unique la réponse de recherche associée.

L’objet inclut ce champ uniquement si la réponse Classement spécifie que vous affichez toutes les recherches associées dans un groupe. Pour plus d’informations sur l’utilisation de l’ID, consultez Utilisation du classement pour afficher les résultats.
String
value Liste des requêtes associées effectuées par d’autres personnes. Requête[]

SearchResponse

Objet de niveau supérieur de la réponse pour les demandes de recherche.

Par défaut, l’API De recherche inclut toutes les réponses, sauf si :

  • La requête spécifie le paramètre de requête responseFilter pour limiter les réponses

  • Un ou plusieurs composants de recherche ne retournent pas de résultats (par exemple, aucun résultat d’actualité n’est pertinent pour la requête)

  • La clé d’abonnement n’a pas accès au composant de recherche.

Si le service soupçonne une attaque par déni de service, la requête réussit (le code d’état HTTP est 200 OK), mais le corps de la réponse est vide.

Nom Valeur Type
_type Indicateur de type. String
Calcul Réponse à une expression mathématique ou à une expression de conversion d’unités. Calcul
Entités Liste d’entités pertinentes pour la requête de recherche. EntityAnswer
Images Liste d’images pertinentes pour la requête de recherche. Images
Nouvelles Liste des articles d’actualités pertinents pour la requête de recherche. Actualités
queryContext Chaîne de requête qui Bing utilisée pour la requête.

La réponse inclut le contexte uniquement si la chaîne de requête contient une erreur orthographique ou a une intention adulte.
QueryContext
rankingResponse L’ordre dans lequel Bing suggère d’afficher les résultats de la recherche. RankingResponse
relatedSearches Liste des requêtes connexes effectuées par d’autres personnes. RelatedSearchAnswer
spellSuggestions Chaîne de requête qui représente probablement l’intention de l’utilisateur. SpellSuggestions
Timezone Date et heure d’un ou plusieurs emplacements géographiques. Timezone
Vidéos Liste des vidéos pertinentes pour la requête de recherche. Vidéos
Pages Liste des pages web pertinentes pour la requête de recherche. WebAnswer

SpellSuggestions

Définit une chaîne de requête suggérée qui représente probablement l’intention de l’utilisateur.

Les résultats de la recherche incluent cette réponse si Bing détermine que l’utilisateur peut avoir l’intention de rechercher quelque chose de différent. Par exemple, si l’utilisateur recherche alon brown, Bing peut déterminer que l’utilisateur a probablement l’intention de rechercher Alton Brown à la place (en fonction des recherches passées par d’autres d’Alon Brown).

Nom Valeur Type
id ID qui identifie de manière unique la réponse de suggestion orthographique.

Vous utilisez ce champ lorsque vous utilisez la réponse de classement pour afficher les suggestions d’orthographe. Pour plus d’informations sur l’utilisation de l’ID, consultez Utilisation du classement pour afficher les résultats.
String
value Liste des chaînes de requête suggérées qui peuvent représenter l’intention de l’utilisateur.

La liste ne contient qu’un seul Query objet.
Requête[]

TextAttribution

Définit une règle contractuelle pour l’attribution du texte brut.

Nom Valeur Type
_type Indicateur de type, défini sur TextAttribution. String
text Texte d’attribution.

L’attribution du texte s’applique à l’entité dans son ensemble et devrait s’afficher juste après la présentation de l’entité. Si plusieurs règles d’attribution du texte ou du lien ne spécifient pas de cible, concaténez-les et affichez-les avec une étiquette « Données provenant de : ».
String

TimeZone

Définit les données et l’heure d’un ou plusieurs emplacements géographiques.

Nom Valeur Type
otherCityTimes Liste des dates et heures des fuseaux horaires à proximité. TimeZoneInformation[]
primaryCityTime Données et heure UTC de l’emplacement géographique spécifié dans la requête.

Si la requête a spécifié un emplacement géographique spécifique (par exemple, une ville), cet objet contient le nom de l’emplacement géographique et la date et l’heure actuelles de l’emplacement, en UTC.

Si la requête a spécifié un emplacement géographique général, tel qu’un état ou un pays, cet objet contient la date et l’heure de la ville principale ou de l’état trouvé dans l’état ou le pays spécifié. Si l’emplacement contient des fuseaux horaires supplémentaires, le otherCityTimes champ contient les données et l’heure des villes ou états situés dans les autres fuseaux horaires.
TimeZoneInformation

TimeZoneInformation

Définit une date et une heure pour un emplacement géographique.

Nom Valeur Type
Emplacement Nom de l’emplacement géographique.

Par exemple, comté; Ville; Ville, État; Ville, État, Pays; ou fuseau horaire.
String
Temps Données et heure spécifiées dans le formulaire, AAAA-MM-DDThh;mm:ss.ssssssZ. String
utcOffset Décalage par rapport à l’heure UTC. Par exemple, UTC-7. String

WebAnswer

Définit une liste de liens de page web pertinents.

Nom Valeur Type
id ID qui identifie de façon unique la réponse web.

L’objet inclut ce champ uniquement si la réponse classement suggère d’afficher tous les résultats web dans un groupe. Pour plus d’informations sur l’utilisation de l’ID, consultez Utilisation du classement pour afficher les résultats.
String
someResultsRemoved Valeur booléenne qui indique si la réponse exclut certains résultats de la réponse. Si Bing exclu certains résultats, la valeur est true. Boolean
totalEstimatedMatches Nombre estimé de pages web pertinentes pour la requête. Utilisez ce nombre avec les paramètres de requête de comptage et de décalage pour pager les résultats. Long
value Liste des pages web pertinentes pour la requête. WebPage[]
webSearchUrl URL du Bing résultats de recherche pour les pages web demandées. String

Page web

Définit une page web pertinente pour la requête.

Nom Valeur Type
à propos de À usage interne uniquement. Object
dateLastCrawled Dernière fois que Bing analysé la page web. La date est sous forme, AAAA-MM-DDTHH:MM:SS. Par exemple, 2015-04-13T05:23:39. String
deepLinks Liste de liens vers du contenu connexe qui Bing trouvé dans le site web qui contient cette page web.

L’objet Webpage de ce contexte inclut uniquement les champs , et snippeturlurlPingSuffixles namechamps.
Page web[]
displayUrl URL d’affichage de la page web. L’URL est destinée uniquement à des fins d’affichage et n’est pas bien formée. String
id ID qui identifie de manière unique cette page web dans la liste des résultats web.

L’objet inclut ce champ uniquement si la réponse Classement spécifie que vous mélangez les pages web avec les autres résultats de recherche. Chaque page web contient un ID qui correspond à un ID dans la réponse classement. Pour plus d’informations, consultez Utilisation du classement pour afficher les résultats.
String
name Nom de la page web.

Utilisez ce nom avec url pour créer un lien hypertexte qui, lorsque vous cliquez sur l’utilisateur, accède à la page web.
String
Mentionne À usage interne uniquement. Object
searchTags Liste des balises de recherche spécifiées par le propriétaire de la page web sur la page web. L’API retourne uniquement les balises de recherche indexées.

Le name champ de l’objet MetaTag contient la balise de recherche indexée. Les balises de recherche commencent par search.* (par exemple, search.assetId). Le content champ contient la valeur de la balise.
MetaTag[]
extrait Extrait de texte de la page web qui décrit son contenu. String
url URL de la page web.

Utilisez cette URL avec name pour créer un lien hypertexte qui, lorsque vous cliquez sur l’utilisateur, accédez à la page web.
String

Types d'entités

Cette section contient les indicateurs d’entité possibles. Les indicateurs sont regroupés par catégorie d’entités.

Voici les types d’entités de base.

  • Générique
  • Personne
  • Emplacement
  • Média
  • Organisation

Voici les indicateurs d’entité qui se trouvent sous le type de base Place.

  • Attraction
  • City
  • Continent
  • Pays ou région
  • Hotel
  • Maison
  • LocalBusiness
  • Localité
  • MinorRegion
  • Voisinage
  • Autre
  • PointOfInterest
  • PostalCode
  • Radiostation
  • Région
  • Restaurant
  • State
  • StreetAddress
  • Sous-région
  • TouristAttraction
  • Voyage

Voici les indicateurs d’entité qui se trouvent sous le type de base multimédia.

  • Book
  • Film
  • TelevisionSeason
  • TvShow
  • Jeu

Voici les indicateurs d’entité liés à l’événement.

  • Événement

Voici les indicateurs d’entité liés à la profession.

  • Acteur
  • Artiste
  • Procureur

Voici les indicateurs d’entité liés à l’éducation.

  • CollegeOrUniversity
  • École
  • Spécialité

Voici des indicateurs d’entité non liés.

  • Animal
  • Voiture
  • Drogue
  • Aliment
  • Produit
  • SportsTeam

Codes d’erreur

Voici les codes d’état HTTP qu’une demande peut retourner.

Code d’état Description
200 Réussite.
400 L’un des paramètres de requête est manquant ou non valide.
401 La clé d’abonnement est manquante ou non valide.
403 L’utilisateur est authentifié (par exemple, il a utilisé une clé d’abonnement valide), mais il n’est pas autorisé à accéder à la ressource demandée.

Bing peut également retourner cet état si l’appelant a dépassé son quota mensuel de requêtes.
410 La demande a utilisé le protocole HTTP au lieu du protocole HTTPS. HTTPS est le seul protocole pris en charge.
429 L’appelant a dépassé son quota de requêtes par seconde.
500 Erreur de serveur inattendue.

Si la demande échoue, la réponse comporte un objet ErrorResponse qui contient une liste d’objets Error décrivant l’origine de l’erreur. Si l’erreur est liée à un paramètre, le champ parameter identifie celui qui pose problème. De même, si l’erreur est liée à une valeur de paramètre, le champ value identifie la valeur non valide.

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidRequest", 
      "subCode": "ParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidAuthorization", 
      "subCode": "AuthorizationMissing", 
      "message": "Authorization is required.", 
      "moreDetails": "Subscription key is not recognized."
    }
  ]
}

Voici les valeurs possibles de code d’erreur et de sous-code d’erreur.

Code SubCode Description
ServerError UnexpectedError
ResourceError
NotImplemented
Le code d’état HTTP est 500.
InvalidRequest ParameterMissing
ParameterInvalidValue
HttpNotAllowed
Bloqué
Bing retourne InvalidRequest à chaque fois que la demande comporte une partie non valide. Par exemple, un paramètre obligatoire est manquant ou une valeur de paramètre n’est pas valide.

Si l’erreur est ParameterMissing ou ParameterInvalidValue, le code d’état HTTP est 400.

Si vous utilisez le protocole HTTP au lieu du protocole HTTPS, Bing retourne HttpNotAllowed, et le code d’état HTTP est 410.
RateLimitExceeded Aucun sous-code Bing retourne RateLimitExceeded chaque fois que vous dépassez votre quota de requêtes par seconde (QPS) ou par mois (QPM).

Si vous dépassez votre QPS, Bing retourne le code d’état HTTP 429 ; si vous dépassez votre QPM, Bing retourne le code d’état 403.
InvalidAuthorization AuthorizationMissing
AuthorizationRedundancy
Bing retourne InvalidAuthorization s’il ne parvient pas à identifier l’appelant. Par exemple, l’en-tête Ocp-Apim-Subscription-Key est manquant ou la clé d’abonnement n’est pas valide.

Il y a redondance si plusieurs méthodes d’authentification sont spécifiées.

Si l’erreur est InvalidAuthorization, le code d’état HTTP est 401.
InsufficientAuthorization AuthorizationDisabled
AuthorizationExpired
Bing retourne InsufficientAuthorization lorsque l’appelant n’est pas autorisé à accéder à la ressource. Cela peut se produire si la clé d’abonnement a été désactivée ou a expiré.

Si l’erreur est InsufficientAuthorization, le code d’état HTTP est 403.

Codes de marché

Le tableau suivant répertorie les valeurs de code de marché que vous pouvez utiliser pour spécifier le paramètre de mkt requête. Bing retourne uniquement le contenu pour ces marchés. La liste est susceptible d’être modifiée.

Pour obtenir la liste des codes de pays que vous pouvez spécifier dans le paramètre de cc requête, consultez codes pays.

Pays/Région Langage Code du marché
Argentine Espagnol es-AR
Australie Anglais en-AU
Autriche Allemand de-AT
Belgique Néerlandais nl-BE
Belgique Français fr-BE
Brésil Portugais pt-br
Canada Anglais en-CA
Canada Français fr-CA
Chili Espagnol es-CL
Danemark Danois da-DK
Finlande Finnois fi-FI
France Français fr-FR
Allemagne Allemand de-DE
Hong Kong (R.A.S.) Chinois traditionnel zh-HK
Inde Anglais en-IN
Indonésie Anglais en-ID
Italie Italien it-IT
Japon Japonais ja-JP
Corée du Sud Coréen ko-KR
Malaisie Anglais en-MY
Mexique Espagnol es-MX
Pays-Bas Néerlandais nl-NL
Nouvelle-Zélande Anglais en-NZ
Norvège Norvégien no-NO
République populaire de Chine Chinois zh-CN
Pologne Polonais pl-PL
République des Philippines Anglais en-PH
Russie Russe ru-RU
Afrique du Sud Anglais en-ZA
Espagne Espagnol es-ES
Suède Suédois sv-SE
Suisse Français fr-CH
Suisse Allemand de-CH
Taïwan Chinois traditionnel zh-TW
Turquie Turc tr-TR
Royaume-Uni Anglais en-GB
États-Unis Anglais fr-FR
États-Unis Espagnol es-US

Codes de pays

Vous trouverez ci-dessous les codes pays que vous pouvez spécifier dans le paramètre de requête cc. La liste est susceptible d’être modifiée.

Pays/Région Indicatif de pays
Argentine AR
Australie AU
Autriche AT
Belgique BE
Brésil BR
Canada CA
Chili CL
Danemark DK
Finlande FI
France FR
Allemagne DE
Hong Kong (R.A.S.) HK
Inde IN
Indonésie id
Italie IT
Japon JP
Corée du Sud KR
Malaisie MY
Mexique MX
Pays-Bas NL
Nouvelle-Zélande NZ
Norvège Non
République populaire de Chine CN
Pologne PL
Portugal PT
République des Philippines PH
Russie RU
Arabie Saoudite SA
Afrique du Sud ZA
Espagne ES
Suède SE
Suisse CH
Taïwan TW
Turquie TR
Royaume-Uni Go
États-Unis US

langues prises en charge Bing

Voici les Bing langues prises en charge que vous pouvez spécifier dans le paramètre de setLang requête. La liste est susceptible d’être modifiée.

Langues prises en charge Code de langue
Arabe ar
Basque eu
Bengali bn
Bulgare bg
Catalan ca
Chinois (simplifié) zh-hans
Chinois (traditionnel) zh-hant
Croate hr
Tchèque cs
Danois da
Néerlandais nl
Anglais en
royaume English-United en-gb
Estonien et
Finnois fi
Français fr
Galicien gl
Allemand de
Goudjrati gu
Hébreu he
Hindi hi
Hongrois hu
Islandais is
Italien it
Japonais Jp
Kannada kn
Coréen ko
Letton lv
Lituanien lt
Malais ms
Malayalam ml
Marathi mr
Norvégien (bokmål) nb
Polonais pl
Portugais (Brésil) pt-br
Portugais (Portugal) pt-pt
Punjabi pa
Roumain ro
Russe ru
Serbe (Cyrylic) sr
Slovaque sk
Slovène sl
Espagnol es
Suédois sv
Tamoul ta
Télougou te
Thaï th
Turc tr
Ukrainien uk
Vietnamien vi