Freigeben über

Referenz für die API für die Bing-Suche nach ortsansässigen Unternehmen v7

  • Artikel

Warnung

Am 30. Oktober 2020 wurden die Bing-Suche-APIs aus den Azure KI Services in die Bing-Suchdienste verschoben. Diese Dokumentation wird nur zu Referenzzwecken bereitgestellt. Eine aktualisierte Dokumentation finden Sie in der Dokumentation zu den Bing-Suche-APIs. Anweisungen zum Erstellen neuer Azure-Ressourcen für die Bing-Suche finden Sie unter Erstellen einer Ressource für die Bing-Suche über Azure Marketplace.

Die API für die Suche nach ortsansässigen Unternehmen sendet eine Suchabfrage an Bing, um Ergebnisse zu erhalten, die Restaurants, Hotels oder andere lokale Unternehmen umfassen. Für Orte kann die Abfrage den Namen des ortsansässigen Unternehmens oder eine Kategorie angeben (z.B. Restaurants in meiner Nähe). Entitätsergebnisse enthalten Personen, Orte oder Gegenstände. Orte sind in diesem Zusammenhang Geschäftsentitäten, Staaten, Länder/Regionen, usw.

Dieser Abschnitt enthält technische Details zu Antwortobjekten und die Abfrageparameter und Header, die die Suchergebnisse beeinflussen. Beispiele zum Ausführen von Abfragen finden Sie in Schnellstart: Suche nach ortsansässigen Unternehmen mit C# oder Schnellstart: Suche nach ortsansässigen Unternehmen mit Java.

Informationen zu Headern, die in Anforderungen enthalten sein sollten, finden Sie unter Header.

Informationen zu Abfrageparametern, die in Anforderungen enthalten sein sollten, finden Sie unter Abfrageparameter.

Weitere Informationen zu den JSON-Objekten, die die Antwort enthält, finden Sie unter Antwortobjekte.

Informationen zur zulässigen Verwendung und Anzeige der Ergebnisse finden Sie unter Verwendungs- und Anzeigeanforderungen.

Endpunkt

Um Ergebnisse für ortsansässige Unternehmen zu erhalten, senden Sie eine GET-Anforderung an:

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

Die Anforderung muss das HTTPS-Protokoll verwenden.

Hinweis

Die maximale URL-Länge beträgt 2.048 Zeichen. Um sicherzustellen, dass die URL-Länge diesen Grenzwert nicht überschreitet, sollte die maximale Länge Ihrer Abfrageparameter weniger als 1.500 Zeichen betragen. Wenn die URL länger als 2.048 Zeichen ist, gibt der Server „404: Nicht gefunden“ zurück.

Header

Die folgenden Header kann eine Anforderung und Antwort möglicherweise enthalten.

Header BESCHREIBUNG
Akzeptieren Optionaler Anforderungsheader.

Der Standardmedientyp ist application/json. Um anzugeben, dass die Antwort JSON-LD verwenden soll, legen Sie den Accept-Header auf application/ld+json fest.
Accept-Language Optionaler Anforderungsheader.

Eine durch Kommas getrennte Liste mit Sprachen, die für Zeichenfolgen der Benutzeroberfläche verwendet werden sollen. Die Liste ist absteigend nach Präferenz sortiert. Weitere Informationen hierzu (sowie zum erwarteten Format) finden Sie unter RFC2616.

Dieser Header und der Abfrageparameter setLang schließen sich gegenseitig aus. Geben Sie daher nicht beide an.

Wenn Sie diesen Header festlegen, müssen Sie auch den Abfrageparameter „cc“ angeben. Bing verwendet die erste unterstützte Sprache aus der Liste, um den Markt zu bestimmen, für den Ergebnisse zurückgegeben werden sollen, und kombiniert sie mit dem Parameterwert cc. Enthält die Liste keine unterstützte Sprache, sucht Bing die nächstgelegene Sprache und den nächstgelegenen Markt, die bzw. der die Anforderung unterstützt. Alternativ dazu wird für die Ergebnisse ein aggregierter oder Standardmarkt verwendet. Wenn Sie sehen möchten, welchen Markt Bing verwendet hat, untersuchen Sie den Header „BingAPIs-Market“.

Verwenden Sie diesen Header und den cc-Abfrageparameter nur, wenn Sie mehrere Sprachen angeben. Verwenden Sie andernfalls die Abfrageparameter mkt und setLang.

Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. Die JSON-Antwortobjekte enthalten nur wenige Zeichenfolgen für Benutzeroberflächen. Die Links zu Eigenschaften von „bing.com“ in den Antwortobjekten verwenden die angegebene Sprache.
BingAPIs-Market Antwortheader.

Der von der Anforderung verwendete Markt. Das Format lautet <Sprachcode><Ländercode>. Beispiel: en-US.
BingAPIs-TraceId Antwortheader.

Die ID des Protokolleintrags, der die Details der Anforderung enthält. Erfassen Sie diese ID, wenn ein Fehler auftritt. Wenn Sie das Problem nicht ermitteln und beheben können, übermitteln Sie diese ID und weitere Informationen an das Supportteam.
Ocp-Apim-Subscription-Key Erforderlicher Anforderungsheader.

Der Abonnementschlüssel, den Sie bei der Registrierung für diesen Dienst in Azure KI Services erhalten haben.
Pragma Optionaler Anforderungsheader.

Als Standardeinstellung gibt Bing zwischengespeicherte Inhalte (sofern vorhanden) zurück. Wenn Sie dies verhindern möchten, legen Sie den Pragma-Header auf „no-cache“ fest (z.B. „Pragma: no-cache“).
User-Agent Optionaler Anforderungsheader.

Der Benutzer-Agent, von dem die Anforderung stammt. Bing verwendet den Benutzer-Agent, um die Erfahrung mobiler Benutzer zu optimieren. Auch wenn dies optional ist, sollten Sie diesen Header immer angeben.

Der Benutzer-Agent sollte der Zeichenfolge entsprechen, die alle häufig verwendeten Browser senden. Informationen zu Benutzer-Agents finden Sie in RFC 2616.

Nachfolgend einige Beispiele für Zeichenfolgen für Benutzer-Agents.
  • Windows Phone – Mozilla/5.0 (kompatibel; 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; wie Gecko) Version/4.0 Mobile Safari/533.1

  • iPhone – Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 wie Mac OS X) AppleWebKit/536.26 (KHTML; wie 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) wie Gecko

  • iPad – Mozilla/5.0 (iPad; CPU OS 7_0 wie Mac OS X) AppleWebKit/537.51.1 (KHTML, wie Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID Optionaler Anforderungs- und Antwortheader.

Bing verwendet diesen Header, um Benutzern beim Aufrufen der Bing-API ein konsistentes Verhalten bereitzustellen. Bing testet häufig neue Funktionen und Verbesserungen und verwendet dabei die Client-ID als Schlüssel für die Zuweisung von Datenverkehr an verschiedene Flights. Wenn Sie für einen Benutzer bei unterschiedlichen Anforderungen nicht dieselbe Client-ID verwenden, weist Bing den Benutzer möglicherweise mehreren widersprüchlichen Flights zu. Die Zuweisung zu mehreren widersprüchlichen Flights kann zu einer inkonsistenten Benutzererfahrung führen. Weist die zweite Anforderung beispielsweise eine andere Flight-Zuweisung als die erste auf, kann dies zu einer unerwarteten Benutzererfahrung führen. Außerdem kann Bing die Client-ID zur Anpassung der Webergebnisse an den Suchverlauf dieser Client-ID verwenden. Dies führt zu einer noch besseren Benutzererfahrung.

Bing verwendet den Header auch, um die Rangfolge der Ergebnisse zu verbessern, indem es die Aktivität der Client-ID analysiert. Durch die verbesserte Relevanz erhöht sich die Qualität der von Bing-APIs bereitgestellten Ergebnisse, was wiederum zu höheren Durchklickraten für den API-Consumer führt.

WICHTIG: Auch wenn er optional ist, sollten Sie diesen Header als erforderlich betrachten. Das Beibehalten der Client-ID für dieselbe Kombination aus Benutzer und Gerät über mehrere Anforderungen hinweg ermöglicht 1) dem API-Consumer eine konsistente Benutzererfahrung sowie 2) höhere Durchklickraten durch eine bessere Qualität der Bing-API-Ergebnisse.

Die folgenden Grundregeln gelten bei der Verwendung dieses Headers.
  • Jeder Benutzer, der die Anwendung auf dem Gerät verwendet, muss über eine eindeutige, von Bing generierte Client-ID verfügen.

    Wenn Sie diesen Header nicht in die Anforderung einfügen, generiert Bing eine ID, die im Antwortheader „X-MSEdge-ClientID“ zurückgegeben wird. Der einzige Zeitpunkt, zu dem dieser Header NICHT in eine Anforderung eingeschlossen werden sollte, ist bei der erstmaligen Verwendung der App auf dem Gerät.

  • Verwenden Sie die Client-ID für jede Anforderung der Bing-API, die die App für diesen Benutzer auf dem Gerät durchführt.

  • ACHTUNG: Vergewissern Sie sich, dass die Client-ID nicht mit authentifizierbaren Benutzerkontoinformationen verknüpft werden kann.

  • Behalten Sie die Client-ID bei. Verwenden Sie ein permanentes HTTP-Cookie, um sicherzustellen, dass die ID in einer Browser-App bei allen Sitzungen verwendet wird. Verwenden Sie kein Sitzungscookie. Verwenden Sie für andere Apps wie z.B. mobile Apps den permanenten Speicher des Geräts, um die ID beizubehalten.

    Rufen Sie bei der nächsten Verwendung der App auf dem Gerät durch den Benutzer die gespeicherte Client-ID ab.

HINWEIS: Bing-Antworten können diesen Header enthalten, müssen es aber nicht. Enthält die Antwort diesen Header, erfassen Sie die Client-ID, und verwenden Sie sie für alle nachfolgenden Bing-Anforderungen des Benutzers auf diesem Gerät.

HINWEIS: Wenn Sie den Header „X-MSEdge-ClientID“ einfügen, dürfen Sie in die Anforderung nicht gleichzeitig Cookies einschließen.
X-MSEdge-ClientIP Optionaler Anforderungsheader.

Die IPv4- oder IPv6-Adresse des Clientgeräts. Die IP-Adresse wird verwendet, um den Standort des Benutzers zu ermitteln. Bing verwendet die Standortinformationen für ein sicheres Suchverhalten.

HINWEIS: Auch wenn dies optional ist, sollten Sie diesen Header und den Header „X-Search-Location“ immer angeben.

Verschleiern Sie nicht die Adresse (z.B. durch Ändern des letzten Oktetts in 0). Durch Verschleiern der Adresse stimmen Ihr Standort und der tatsächliche Gerätestandort nicht überein, wodurch Bing möglicherweise fehlerhafte Ergebnisse anzeigt.
X-Search-Location Optionaler Anforderungsheader.

Eine durch Semikolons getrennte Liste mit Schlüssel/Wert-Paaren, die den geografischen Standort des Clients beschreiben. Bing verwendet die Standortinformationen für ein sicheres Suchverhalten und zur Rückgabe von lokalen relevanten Inhalten. Geben Sie das Schlüssel-Wert-Paar im Format <Schlüssel>:<Wert> an. Verwenden Sie die folgenden Schlüssel zur Angabe des Benutzerstandorts.

  • lat – Der Breitengrad des Clientstandorts (in Grad). Der Breitengrad muss größer als oder gleich -90,0 und kleiner als oder gleich +90,0 sein. Negative Werte geben südliche Breitengrade und positive Werte nördliche Breitengrade an.

  • long – Der Längengrad des Clientstandorts (in Grad). Der Längengrad muss größer als oder gleich -180,0 und kleiner als oder gleich +180,0 sein. Negative Werte geben westliche Längengrade und positive Werte östliche Längengrade an.

  • re – Der Radius (in Metern), der die horizontale Genauigkeit der Koordinaten angibt. Übergeben Sie den Wert, der vom Standortdienst des Geräts zurückgegeben wird. Typische Werte sind 22 m für GPS/WLAN, 380 m für die Funkmasttriangulation und 18.000 m für die umgekehrte IP-Suche.

  • ts – Der UTC UNIX-Zeitstempel des Zeitpunkts, zu dem sich der Client am Standort befand. (Der UNIX-Zeitstempel gibt die Anzahl der Sekunden seit dem 1. Januar 1970 an.)

  • head – optional. Relatives Ziel oder Reiserichtung des Clients. Geben Sie die Reiserichtung von 0 bis 360 (in Grad) im Uhrzeigersinn ausgehend vom geografischen Norden an. Geben Sie diesen Schlüssel nur an, wenn der sp-Schlüssel ungleich 0 ist.

  • sp – Die horizontale Geschwindigkeit (in Metern pro Sekunde), mit der das Clientgerät unterwegs ist.

  • alt – Die Höhe des Clientgeräts (in Metern).

  • are – optional. Der Radius (in Metern), der die vertikale Genauigkeit der Koordinaten angibt. Der Standardwert für den Radius ist 50 Kilometer. Geben Sie diesen Schlüssel nur an, wenn Sie auch den alt-Schlüssel angeben.

HINWEIS: Auch wenn diese Schlüssel optional sind, werden die Standortergebnisse immer genauer, je mehr Informationen Sie bereitstellen.

HINWEIS: Sie sollten den geografischen Standort des Benutzers immer angeben. Besonders wichtig ist die Standortangabe dann, wenn die IP-Adresse des Clients den physischen Standort des Benutzers nicht exakt wiedergibt (wenn der Client beispielsweise VPN verwendet). Für optimale Ergebnisse sollten Sie diesen Header und den Header „X-MSEdge-ClientIP“ einfügen. Auf jeden Fall sollten Sie aber zumindest diesen Header verwenden.

Hinweis

Beachten Sie, dass die Nutzungsbedingungen die Einhaltung aller geltenden Gesetze erfordert. Dies gilt auch für die Verwendung dieses Headers. Die Rechtsprechung in bestimmten Ländern (z.B. in Europa) erfordert etwa die Zustimmung des Benutzers, um bestimmte Tracking-Geräte auf Benutzergeräten platzieren zu dürfen.

Abfrageparameter

Die Anforderung kann die folgenden Abfrageparameter enthalten. Die erforderlichen Parameter Finden Sie in der Spalte „Erforderlich“. Sie müssen die Abfrageparameter URL-codieren.

Name Wert Typ Erforderlich
count Die Anzahl der zurückzugebenden Ergebnisse, beginnend mit dem durch den Parameter offset angegebenen Index. String Nein
localCategories Liste der Optionen, die die Suche nach Unternehmenskategorie definieren. Weitere Informationen finden Sie unter Kategorien für die Suche nach ortsansässigen Unternehmen. String Nein
mkt Der Markt, aus dem die Ergebnisse stammen.

Eine Liste der möglichen Marktwerte finden Sie unter „Marktcodes“.

HINWEIS: Die API für die Suche nach ortsansässigen Unternehmen unterstützt zurzeit nur den Markt und die Sprache „en-us“.

 String Ja
offset Der Index, der die Ergebnisse startet, die durch den Parameter count angegeben werden. Integer Nein
q Der Suchbegriff des Benutzers. String Nein
responseFormat Der Medientyp, der für die Antwort verwendet werden soll. Die folgenden Werte (ohne Beachtung von Groß-/Kleinschreibung) sind möglich.
  • JSON
  • JSONLD

Der Standardwert ist JSON. Weitere Informationen zu den JSON-Objekten, die die Antwort enthält, finden Sie unter Antwortobjekte.

Wenn Sie JsonLd angeben, enthält der Antworttext die JSON-LD-Objekte, die die Suchergebnisse enthalten. Informationen zu JSON-LD finden Sie unter JSON-LD.		 String Nein
safeSearch Ein Filter für nicht jugendfreie Inhalte. Die folgenden Filterwerte (ohne Beachtung von Groß-/Kleinschreibung) sind möglich.
  • Off – Es werden Webseiten mit nicht jugendfreiem Text oder Bildern zurückgegeben.

  • Moderate – Webseiten mit nicht jugendfreiem Text werden zurückgegeben, nicht jugendfreie Bilder oder Videos jedoch nicht.

  • Strict – Es werden keine Webseiten mit nicht jugendfreiem Text bzw. nicht jugendfreien Bildern oder Videos zurückgegeben.

Die Standardeinstellung ist „Moderate“.

HINWEIS: Stammt die Anforderung aus einem Markt, für den laut Bing-Richtlinien zu nicht jugendfreien Inhalten für safeSearch die Einstellung „Strict“ erforderlich ist, ignoriert Bing den safeSearch-Wert und verwendet stattdessen „Strict“.

HINWEIS: Bei Verwendung des Abfrageoperators site: kann es vorkommen, dass die Antwort unabhängig von der Einstellung des safeSearch-Abfrageparameters nicht jugendfreie Inhalte enthält. Verwenden Sie site: nur, wenn Sie wissen, welche Inhalte die Website enthält, und wenn in Ihrem Szenario ggf. auch nicht jugendfreie Inhalte zulässig sind.		 String Nein
setLang Die Sprache, die für Zeichenfolgen der Benutzeroberfläche verwendet werden soll. Geben Sie die Sprache mithilfe des zweistelligen Sprachcodes nach ISO 639-1 an. Der Sprachcode für Englisch lautet z.B. „EN“. Der Standardwert ist „EN“ (Englisch).

Auch wenn dies optional ist, sollten Sie immer eine Sprache angeben. In der Regel wird bei setLang dieselbe Sprache angegeben wie bei mkt, sofern der Benutzer die Zeichenfolgen der Benutzeroberfläche nicht in einer anderen Sprache anzeigen möchte.

Dieser Parameter und der Header Accept-Language schließen sich gegenseitig aus. Geben Sie daher nicht beide an.

Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. Die JSON-Antwortobjekte enthalten nur wenige Zeichenfolgen für Benutzeroberflächen. Die angegebene Sprache wird auch in Links zu Eigenschaften von „bing.com“ in den Antwortobjekten verwendet.		 String Nein

Antwortobjekte

Im Folgenden finden Sie die JSON-Antwortobjekte, die die Antwort enthalten können. Wenn die Anforderung erfolgreich ist, ist das Objekt der obersten Ebene in der Antwort das SearchResponse Objekt. Wenn die Anforderung fehlschlägt, ist das Objekt auf oberster Ebene das ErrorResponse-Objekt.

Object BESCHREIBUNG
Place Definiert Informationen zu einem ortsansässigen Unternehmen, z.B. ein Restaurant oder Hotel.

Fehler

Definiert den aufgetretenen Fehler.

Element BESCHREIBUNG type
code Der Fehlercode, der die Kategorie des Fehlers angibt. Eine Liste der möglichen Codes finden Sie unter Fehlercodes. String
message Eine Beschreibung des Fehlers. String
moreDetails Eine Beschreibung, die zusätzliche Informationen zum Fehler enthält. String
parameter Der Abfrageparameter in der Anforderung, der den Fehler verursacht hat. String
subCode Der Fehlercode, der den Fehler identifiziert. Wenn code z.B. InvalidRequest ist, kann subCode ParameterInvalid oder ParameterInvalidValue sein. String
value Der Wert des Abfrageparameters, der ungültig war. String

ErrorResponse

Das Objekt auf oberster Ebene, das die Antwort enthält, wenn die Anforderung fehlschlägt.

Name Wert type
_type Der Typhinweis. String
errors Eine Liste von Fehlern, die die Gründe beschreiben, warum die Anforderung fehlgeschlagen ist. Error[]

Lizenz

Definiert die Lizenz, unter der der Text oder das Foto verwendet werden kann.

Name Wert type
name Der Name der Lizenz. String
url Die URL zu einer Website, auf der der Benutzer weitere Informationen zur Lizenz erhalten kann.

Verwenden Sie den Namen und die URL, um einen Link zu erstellen.		 String

Definiert die Komponenten eines Links.

Name Wert type
_type Der Typhinweis. String
text Der Anzeigetext. String
url Eine URL. Verwenden Sie die URL und den Anzeigetext, um einen Link zu erstellen. String

Organization

Definiert einen Herausgeber.

Beachten Sie, dass ein Herausgeber möglicherweise seinen Namen oder seine Website oder beide Angaben bereitstellt.

Name Wert type
name Der Name des Herausgebers. String
url Die URL zur Website des Herausgebers.

Beachten Sie, dass der Herausgeber möglicherweise keine Website bereitstellt.		 String

Ort

Definiert Informationen zu einem ortsansässigen Unternehmen, z.B. ein Restaurant oder Hotel.

Name Wert type
_type Der Typhinweis, die auf einen der folgenden Werte festgelegt werden kann:

  • Hotel
  • LocalBusiness
  • Restaurant
  		•  String
    address Die Postadresse, an der sich die Entität befindet. PostalAddress
    entityPresentationInfo Weitere Informationen zur Entität z.B. Hinweise, die Sie zum Bestimmen des Entitätstypen verwenden können. Beispielsweise, ob es sich um ein Restaurant oder Hotel handelt. Die Feld entityScenario auf „ListItem“ festgelegt. EntityPresentationInfo
    name Der Name der Entität. String
    telephone Die Telefonnummer der Entität. String
    url Die URL zur Website der Entität.

    Verwenden Sie diese URL zusammen mit dem Namen der Entität, um einen Hyperlink zu erstellen, der den Benutzer beim Anklicken auf die Website der Entität führt.    		 String
    webSearchUrl Die URL zum Bing-Suchergebnis für diesen Ort. String

    QueryContext

    Definiert den Abfragekontext, den Bing für die Anforderung verwendet hat.

    Element BESCHREIBUNG type
    adultIntent Ein boolescher Wert, der angibt, ob die angegebene Abfrage nicht jugendfreie Inhalte aufweist. Der Wert ist TRUE, wenn die Abfrage nicht jugendfreie Inhalte aufweist, andernfalls ist er FALSE. Boolean
    alterationOverrideQuery Die zu verwendende Abfragezeichenfolge, um Bing zu zwingen, die ursprüngliche Zeichenfolge zu verwenden. Wenn die Abfragezeichenfolge z.B. saling downwind lautet, lautet die Abfragezeichenfolge zum Überschreiben +saling downwind. Denken Sie daran, die Abfragezeichenfolge mit den Ergebnissen in %2Bsaling+downwind zu codieren.

    Dieses Feld ist nur enthalten, wenn die ursprüngliche Abfragezeichenfolge einen Rechtschreibfehler enthält.    		 String
    alteredQuery Die Abfragezeichenfolge, die von Bing verwendet wird, um die Abfrage auszuführen. Bing verwendet die geänderte Abfragezeichenfolge, wenn die ursprüngliche Abfragezeichenfolge Rechtschreibfehler enthielt. Wenn die Abfragezeichenfolge z.B. saling downwind lautet, lautet die geänderten Abfragezeichenfolge sailing downwind.

    Dieses Feld ist nur enthalten, wenn die ursprüngliche Abfragezeichenfolge einen Rechtschreibfehler enthält.    		 String
    askUserForLocation Ein boolescher Wert, der angibt, ob Bing den Standort des Benutzers benötigt, um genaue Ergebnisse bereitzustellen. Wenn Sie den Standort des Benutzers mithilfe der X-MSEdge-ClientIP- und X-Search-Location-Header angegeben haben, können Sie dieses Feld ignorieren.

    Für standortaktivierte Abfragen (z.B. „Wetter heute“ oder „Restaurants in meiner Nähe“), die den Standort des Benutzers benötigen, um genaue Ergebnisse zu liefern, ist dieses Feld auf TRUE festgelegt.

    Für standortaktivierte Abfragen, die den Standort beinhalten (z.B. „Wetter in Seattle“), ist dieses Feld auf FALSE festgelegt. Dieses Feld wird auch für Abfragen auf FALSE festgelegt, die nicht standortaktiviert sind, z.B. „Beste Verkäufer“.    		 Boolean
    originalQuery Die Abfragezeichenfolge wie in der Anforderung angegeben. String

    Identifiable

    Name Wert type
    id Ein Ressourcenbezeichner. String

    RankingGroup

    Definiert eine Suchergebnisgruppe, z.B. „mainline“.

    Name Wert type
    items Eine Liste der Suchergebnisse, die in der Gruppe angezeigt werden sollen. RankingItem

    RankingItem

    Definiert ein anzuzeigendes Suchergebniselement.

    Name Wert type
    resultIndex Ein nullbasierter Index des Elements in der Antwort, das angezeigt werden soll. Wenn das Element dieses Feld nicht enthält, werden alle Elemente in der Antwort angezeigt. Beispielsweise werden alle Artikel in der News-Antwort angezeigt. Integer
    answerType Die Antwort, die das anzuzeigende Element enthält. Beispiel: News.

    Verwenden Sie den Typ, um nach der Antwort im SearchResponse-Objekt zu suchen. Der Typ ist der Name eines SearchResponse-Felds.

    Verwenden Sie diesen Antworttyp jedoch nur, wenn dieses Objekt das value-Feld enthält. Ignorieren Sie ihn andernfalls.    		 String
    textualIndex Der Index der Antwort in textualAnswers, die angezeigt werden soll. Ganze Zahl ohne Vorzeichen
    value Die ID, die eine anzuzeigende Antwort oder ein anzuzeigendes Element einer Antwort identifiziert. Wenn die ID eine Antwort identifiziert, werden alle Elemente der Antwort angezeigt. Identifiable

    RankingResponse

    Definiert, wo auf der Suchergebnisseite Inhalt platziert werden soll und in welcher Reihenfolge.

    Name Wert
    mainline Die Suchergebnisse, die in der Hauptlinie angezeigt werden sollen.
    pole Die Suchergebnisse, die am sichtbarsten sein sollen (die z.B. über der Hauptlinie und der Randleiste angezeigt werden).
    sidebar Die Suchergebnisse, die in der Randleiste angezeigt werden sollen.

    SearchResponse

    Definiert das Objekt auf oberster Ebene, das die Antwort enthält, wenn die Anforderung erfolgreich ist.

    Beachten Sie Folgendes: Wenn der Dienst einen Denial-of-Service-Angriff vermutet, ist die Anforderung erfolgreich (HTTP-Statuscode: 200 OK). Der Antworttext ist jedoch leer.

    Name Wert type
    _type Der Typhinweis, der auf SearchResponse festgelegt wird. String
    places Eine Liste der Entitäten, die für die Suchabfrage relevant sind. JSON-Objekt
    queryContext Ein Objekt, das die Abfragezeichenfolge enthält, die Bing für die Anforderung verwendet.

    Dieses Objekt enthält die Abfragezeichenfolge, wie Sie vom Benutzer eingegeben wurde. Es kann auch eine geänderte Abfragezeichenfolge enthalten, die Bing für die Abfrage verwendet hat, wenn die Abfragezeichenfolge einen Rechtschreibfehler enthält.    		 QueryContext

    Fehlercodes

    Im Folgenden finden Sie die möglichen HTTP-Statuscodes, die eine Anforderung zurückgeben kann.

    Statuscode BESCHREIBUNG
    200 Erfolg.
    400 Einer der Abfrageparameter fehlt oder ist ungültig.
    401 Der Abonnementschlüssel fehlt oder ist ungültig.
    403 Der Benutzer ist authentifiziert (er hat z.B. einen gültigen Abonnementschlüssel verwendet), aber er ist nicht für die angeforderte Ressource berechtigt.

    Bing gibt diesen Status möglicherweise auch zurück, wenn der Aufrufer sein Kontingent für Abfragen pro Monat überschritten hat.
    410 Die Anforderung hat HTTP anstelle des HTTPS-Protokolls verwendet. HTTPS ist das einzige unterstützte Protokoll.
    429 Der Aufrufer hat sein Kontingent für Abfragen pro Sekunde überschritten.
    500 Unerwarteter Serverfehler.

    Wenn die Anforderung fehlschlägt, enthält die Antwort ein ErrorResponse-Objekt, das eine Liste der Fehler-Objekte enthält, die beschreiben, was den Fehler verursacht hat. Wenn sich der Fehler auf einen Parameter bezieht, identifiziert das parameter-Feld den Parameter, der das Problem darstellt. Wenn sich der Fehler auf einen Parameterwert bezieht, identifiziert das value-Feld den Wert, der ungültig ist.

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

    Die folgenden Werte sind für den Fehlercode und Unterfehlercodes möglich.

    Code SubCode BESCHREIBUNG
    ServerError UnexpectedError
    ResourceError
    NotImplemented    		 Der HTTP-Statuscode ist 500.
    InvalidRequest ParameterMissing
    ParameterInvalidValue
    HttpNotAllowed
    Blockiert    		 Bing gibt InvalidRequest zurück, wenn ein beliebiger Teil der Anforderung ungültig ist. Beispielsweise, wenn ein erforderlicher Parameter fehlt oder ein Parameterwert ungültig ist.

    Wenn der Fehler ParameterMissing oder ParameterInvalidValue ist, lautet der HTTP-Statuscode 400.

    Wenn Sie das HTTP-Protokoll anstelle von HTTPS verwenden, gibt Bing HttpNotAllowed zurück, und der HTTP-Statuscode ist 410.
    RateLimitExceeded Keine Untercodes Bing gibt RateLimitExceeded zurück, wenn Sie Ihr Kontingent für Abfragen pro Sekunde (Queries Per Second, QPS) oder Abfragen pro Monat (Queries Per Month, QPM) überschreiten.

    Wenn Sie QPS überschreiten, gibt Bing den HTTP-Statuscode 429 zurück. Wenn Sie QPM überschreiten, wird 403 von Bing zurückgegeben.
    InvalidAuthorization AuthorizationMissing
    AuthorizationRedundancy    		 Bing gibt InvalidAuthorization zurück, wenn Bing den Aufrufer nicht authentifizieren kann. Beispielsweise, wenn der Ocp-Apim-Subscription-Key-Header fehlt oder der Abonnementschlüssel ungültig ist.

    Redundanz tritt auf, wenn Sie mehrere Authentifizierungsmethoden angeben.

    Wenn der Fehler InvalidAuthorization ist, lautet der HTTP-Statuscode 401.
    InsufficientAuthorization AuthorizationDisabled
    AuthorizationExpired    		 Wenn der Aufrufer nicht über Berechtigungen für den Zugriff auf die Ressource verfügt, gibt Bing InsufficientAuthorization zurück. Dies kann der Fall sein, wenn der Abonnementschlüssel deaktiviert wurde oder abgelaufen ist.

    Wenn der Fehler InsufficientAuthorization ist, lautet der HTTP-Statuscode 403.

    Nächste Schritte