Udostępnij za pośrednictwem


Dokumentacja interfejsu API wyszukiwania lokalnego firmy Bing w wersji 7

Ostrzeżenie

30 października 2020 r. interfejsy API Wyszukiwanie Bing zostały przeniesione z usług Azure AI do usług Wyszukiwanie Bing Services. Ta dokumentacja jest dostarczana tylko do celów referencyjnych. Aby uzyskać zaktualizowaną dokumentację, zobacz dokumentację interfejsu API wyszukiwania Bing. Aby uzyskać instrukcje dotyczące tworzenia nowych zasobów platformy Azure na potrzeby wyszukiwania Bing, zobacz Tworzenie zasobu Wyszukiwanie Bing za pomocą Azure Marketplace.

Interfejs API wyszukiwania lokalnego firmy wysyła zapytanie wyszukiwania do usługi Bing, aby uzyskać wyniki, które obejmują restauracje, hotele lub inne lokalne firmy. W przypadku miejsc zapytanie może określić nazwę lokalnej firmy lub kategorii (na przykład restauracje w pobliżu mnie). Wyniki dotyczące jednostek to między innymi osoby, miejsca i rzeczy. Miejsce w tym kontekście to jednostki biznesowe, stany, kraje/regiony itp.

Ta sekcja zawiera szczegółowe informacje techniczne dotyczące obiektów odpowiedzi oraz parametry zapytania i nagłówki wpływające na wyniki wyszukiwania. Przykłady pokazujące, jak wysyłać żądania, zobacz Przewodnik Szybki start dotyczący wyszukiwania lokalnego w języku C# lub Przewodnik Szybki start dotyczący wyszukiwania w usłudze Local Business Search Java.

Aby uzyskać informacje o nagłówkach, które powinny zawierać żądania, zobacz Nagłówki.

Aby uzyskać informacje o parametrach zapytania, które powinny zawierać żądania, zobacz Parametry zapytania.

Aby uzyskać informacje o obiektach JSON, które zawiera odpowiedź, zobacz Obiekty odpowiedzi.

Aby uzyskać informacje o dozwolonym użyciu i wyświetlaniu wyników, zobacz Wymagania dotyczące używania i wyświetlania.

Punkt końcowy

Aby zażądać lokalnych wyników biznesowych, wyślij żądanie GET do:

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

Żądanie musi korzystać z protokołu HTTPS.

Uwaga

Maksymalna długość adresu URL wynosi 2048 znaków. Aby upewnić się, że długość adresu URL nie przekracza limitu, maksymalna długość parametrów zapytania powinna być mniejsza niż 1500 znaków. Jeśli adres URL przekracza 2048 znaków, serwer zwraca wartość 404 Nie znaleziono.

Nagłówki

Poniżej przedstawiono nagłówki, które może zawierać żądanie i odpowiedź.

Nagłówek Opis
Zaakceptuj Opcjonalny nagłówek żądania.

Domyślnym typem nośnika jest application/json. Aby określić, że odpowiedź używa formatu JSON-LD, ustaw nagłówek Accept na wartość application/ld+json.
Accept-Language Opcjonalny nagłówek żądania.

Rozdzielana przecinkami lista języków dla ciągów interfejsu użytkownika. Lista jest zorganizowana w malejącym porządku preferencji. Aby uzyskać więcej informacji, łącznie z oczekiwanym formatem, zobacz RFC2616.

Ten nagłówek i parametr zapytania setLang wzajemnie się wykluczają — nie należy określać obu tych parametrów.

Jeśli ustawisz ten nagłówek, musisz także określić parametr zapytania cc. Aby ustalić rynek, dla którego mają zostać zwrócone wyniki, usługa Bing używa pierwszego obsługiwanego języka znalezionego na liście i łączy go z wartością parametru cc. Jeśli lista nie zawiera obsługiwanego języka, usługa Bing znajduje najbliższy język i rynek, które obsługują żądanie, lub używa rynku zagregowanego bądź domyślnego. Aby sprawdzić, jakiego rynku użyła usługa Bing, zobacz nagłówek BingAPIs-Market.

Używaj tego nagłówka i parametru zapytania cc tylko wtedy, gdy określasz wiele języków. W przeciwnym razie użyj parametrów zapytania mkt i setLang.

Ciąg interfejsu użytkownika to ciąg, który jest używany jako etykieta w interfejsie użytkownika. W obiektach odpowiedzi JSON istnieje kilka ciągów interfejsu użytkownika. Wszelkie linki do właściwości witryny Bing.com w obiektach odpowiedzi także stosują określony język.
BingAPIs-Market Nagłówek odpowiedzi.

Rynek używany przez żądanie. Formularz to <languageCode-countryCode<>>. Na przykład en-US.
BingAPIs-TraceId Nagłówek odpowiedzi.

Identyfikator wpisu dziennika, który zawiera szczegółowe informacje o żądaniu. Gdy wystąpi błąd, przechwyć ten identyfikator. Jeśli nie możesz określić i rozwiązać problemu, dołącz ten identyfikator wraz z innymi informacjami, które podasz zespołowi pomocy technicznej.
Ocp-Apim-Subscription-Key Wymagany nagłówek żądania.

Klucz subskrypcji otrzymany podczas tworzenia konta tej usługi w usługach Azure AI.
Pragma Opcjonalny nagłówek żądania

Usługa Bing domyślnie zwraca zawartość buforowaną, jeśli jest dostępna. Aby zapobiec zwracaniu zawartości buforowanej przez usługę Bing, dla nagłówka Pragma ustaw wartość no-cache (na przykład Pragma: no-cache).
User-Agent Opcjonalny nagłówek żądania.

Agent użytkownika, od którego pochodzi żądanie. Usługa Bing korzysta z agenta użytkownika, aby zapewnić zoptymalizowane środowisko obsługi dla użytkowników urządzeń przenośnych. Mimo że ten nagłówek jest opcjonalny, zachęcamy, aby go zawsze określać.

Nagłówek user-agent powinien być takim samym ciągiem, jaki wysyła każda powszechnie używana przeglądarka. Aby uzyskać informacje na temat agentów użytkownika, zobacz RFC 2616.

Poniżej przedstawiono przykłady ciągów nagłówka user-agent.
  • Windows Phone — Mozilla/5.0 (zgodne; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; RAMIĘ; Touch; NOKIA; Lumia 822)

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

  • iPhone — Mozilla/5.0 (iPhone; Procesor iPhone OS 6_1, taki jak Mac OS X) AppleWebKit/536.26 (KHTML; na przykład 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) jak Gecko

  • iPad — Mozilla/5.0 (iPad; Procesor CPU OS 7_0, taki jak Mac OS X) AppleWebKit/537.51.1 (KHTML, na przykład Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID Opcjonalny nagłówek żądania i odpowiedzi.

Usługa Bing używa tego nagłówka, aby zapewnić użytkownikom spójne zachowanie dla wywołań interfejsu API usługi Bing. Usługa Bing często testuje nowe funkcje i ulepszenia i używa identyfikatora klienta jako klucza do przypisywania ruchu dla różnych pakietów testowych. Jeśli nie będziesz używać tego samego identyfikatora klienta dla użytkownika w wielu żądaniach, usługa Bing może przypisać użytkownika do różnych, konfliktowych pakietów testowych. Przypisanie do wielu konfliktowych pakietów testowych może prowadzić do niespójnego środowiska użytkownika. Jeśli na przykład drugie żądanie ma przypisany inny pakiet testowy, niż pierwsze, środowisko obsługi może być nieoczekiwane. Ponadto usługa Bing może używać identyfikatora klienta, aby dopasować wyniki internetowe do historii wyszukiwania tego identyfikatora, zapewniając użytkownikowi bogatsze środowisko obsługi.

Usługa Bing używa także tego nagłówka, aby ulepszyć pozycjonowanie wyników, analizując aktywność generowaną przez identyfikator klienta. Ulepszenia istotności pomagają zwiększyć jakość wyników dostarczanych przez interfejsy API usługi Bing, co w rezultacie daje wyższą częstotliwość kliknięć dla użytkownika interfejsu API.

WAŻNE: Mimo że ten nagłówek jest opcjonalny, można go uważać za wymagany. Utrwalenie identyfikatora klienta dla wielu żądań dla połączenia tego samego użytkownika końcowego i urządzenia umożliwia (1) zapewnienie użytkownikowi interfejsu API spójnego środowiska obsługi oraz (2) uzyskanie wyższej częstotliwości kliknięć dzięki lepszej jakość wyników z interfejsów API usługi Bing.

Poniżej przedstawiono podstawowe reguły użycia, które mają zastosowanie do tego nagłówka.
  • Każdy użytkownik, który korzysta z Twojej aplikacji na urządzeniu, musi mieć unikatowy identyfikator klienta wygenerowany przez usługę Bing.

    Jeśli nie uwzględnisz tego nagłówka w żądaniu, usługa Bing wygeneruje identyfikator i zwróci go w nagłówku odpowiedzi X-MSEdge-ClientID. Jedyną sytuacją, w której NIE należy uwzględniać tego nagłówka w żądaniu, jest pierwsze użycie Twojej aplikacji przez danego użytkownika na danym urządzeniu.

  • Używaj identyfikatora klienta dla każdego żądania interfejsu API usługi Bing, które Twoja aplikacja wykonuje dla tego użytkownika na danym urządzeniu.

  • UWAGĘ: Musisz upewnić się, że ten identyfikator klienta nie jest łączony z żadnymi uwierzytelnianymi informacjami o koncie użytkownika.

  • Utrwal identyfikator klienta. Aby utrwalić identyfikator w aplikacji przeglądarki, użyj trwałego pliku cookie HTTP, aby mieć pewność, że dany identyfikator będzie używany we wszystkich sesjach. Nie należy używać plików cookie sesji. W przypadku innych aplikacji, takich jak aplikacje mobilne, użyj magazynu trwałego urządzenia, aby utrwalić identyfikator.

    Następnym razem, gdy użytkownik będzie używać Twojej aplikacji na tym urządzeniu, uzyskaj utrwalony identyfikator klienta.

UWAGA: Odpowiedzi usługi Bing mogą zawierać ten nagłówek lub nie. Jeśli odpowiedź zawiera ten nagłówek, przechwyć identyfikator klienta i używaj go dla wszystkich kolejnych żądań usługi Bing dla tego użytkownika na tym urządzeniu.

UWAGA: jeśli dodasz nagłówek X-MSEdge-ClientID, nie możesz uwzględnić w żądaniu plików cookie.
X-MSEdge-ClientIP Opcjonalny nagłówek żądania.

Adres IPv4 lub IPv6 na urządzeniu klienckim. Adres IP jest używany w celu odnalezienia lokalizacji użytkownika. Usługa Bing używa informacji o lokalizacji, aby określić sposób bezpiecznego wyszukiwania.

UWAGA: Mimo że ten nagłówek jest opcjonalny, zachęcamy, aby go zawsze określać wraz z nagłówkiem X-Search-Location.

Nie należy zaciemniać adres (na przykład zamieniając ostatni oktet na 0). Zaciemnianie adresu powoduje, że ustalona lokalizacja nie jest nawet przybliżona do rzeczywistej lokalizacji urządzenia, przez co usługa Bing może zwracać błędne wyniki.
X-Search-Location Opcjonalny nagłówek żądania.

Rozdzielana średnikami lista par klucz/wartość, które opisują geograficzną lokalizację klienta. Usługa Bing używa informacji o lokalizacji, aby określić sposób bezpiecznego wyszukiwania i aby zwracać odpowiednią zawartość lokalną. Parę klucz/wartość określ w formacie <klucz>:<wartość>. Poniżej przedstawiono klucze, które służą do określania lokalizacji użytkownika.

  • lat — szerokość geograficzna lokalizacji klienta w stopniach. Szerokość geograficzna musi być większa niż lub równa -90.0 i mniejsza niż lub równa +90.0. Wartości ujemne wskazują południową szerokość geograficzną, a wartości dodatnie wskazują północną szerokość geograficzną.

  • long — długość geograficzna lokalizacji klienta w stopniach. Długość geograficzna musi być większa niż lub równa -180.0 i mniejsza niż lub równa +180.0. Wartości ujemne wskazują zachodnią długość geograficzną, a wartości dodatnie wskazują wschodnią długość geograficzną.

  • re — promień w metrach, który określa poziomą dokładność współrzędnych. Przekaż wartość zwróconą przez usługę lokalizacji urządzenia. Typowe wartości mogą wynosić 22 m dla sieci GPS/Wi-Fi, 380 m dla triangulacji wieży sieci komórkowej i 18 000 m dla wstecznego wyszukiwania adresu IP.

  • ts — sygnatura czasowa utc systemu UNIX, kiedy klient znajdował się w lokalizacji. (Sygnatura czasowa systemu UNIX to liczba sekund od 1 stycznia 1970 r.).

  • head — opcjonalne. Względny kierunek przemieszczania się klienta. Określ kierunek ruchu jako liczbę stopni z zakresu od 0 do 360, zliczanych zgodnie z ruchem wskazówek zegara względem prawdziwej północy. Określ ten klucz tylko wtedy, gdy wartość klucza sp jest różna od zera.

  • sp — prędkość pozioma (prędkość) w metrach na sekundę, którą podróżuje urządzenie klienckie.

  • alt — wysokość urządzenia klienckiego, w metrach.

  • are — opcjonalne. Promień, w metrach, który określa pionową dokładność współrzędnych. Wartość domyślna promienia to 50 kilometrów. Określ ten klucz tylko wtedy, gdy wartość klucza alt także została określona.

UWAGA: Chociaż te klucze są opcjonalne, tym więcej informacji podajesz, tym dokładniejsze są wyniki lokalizacji.

UWAGA: Zachęcamy do zawsze określenia lokalizacji geograficznej użytkownika. Podanie lokalizacji jest szczególnie ważne, jeśli adres IP klienta nie odzwierciedla precyzyjnie fizycznej lokalizacji użytkownika (na przykład, jeśli klient korzysta z sieci VPN). Aby uzyskać optymalne wyniki należy uwzględnić ten nagłówek i nagłówek X-MSEdge-ClientIP, a co najmniej należy uwzględnić ten nagłówek.

Uwaga

Pamiętaj, że Warunki użytkowania wymagają zgodności ze wszystkimi obowiązującymi przepisami prawa, w tym dotyczącymi korzystania z tych nagłówków. W niektórych systemach prawnych, na przykład w Europie, wymagane jest uzyskania zgody użytkownika przed umieszczeniem narzędzi śledzących na urządzeniu użytkownika.

Parametry zapytania

Żądanie może zawierać następujące parametry zapytania. Zobacz kolumnę Wymagane dla wymaganych parametrów. Musisz zakodować parametry zapytania za pomocą adresu URL.

Nazwa Wartość Typ Wymagane
Liczba Liczba wyników do zwrócenia, zaczynając od indeksu określonego offset przez parametr . Ciąg Nie
localCategories Lista opcji definiujących wyszukiwanie według kategorii biznesowej. Zobacz Wyszukiwanie lokalnych kategorii biznesowych Ciąg Nie
mkt Rynek, z którego pochodzą wyniki.

Aby uzyskać listę możliwych wartości rynkowych, zobacz Kody rynku.

UWAGA: Interfejs API wyszukiwania lokalnych firm obecnie obsługuje tylko rynek i język en-us.

Ciąg Tak
Przesunięcie Indeks, który ma uruchomić wyniki określone przez count parametr . Liczba całkowita Nie
P Wyszukiwany termin użytkownika. Ciąg Nie
Responseformat Typ nośnika do użycia dla odpowiedzi. Poniżej przedstawiono możliwe wartości bez uwzględniania wielkości liter.
  • JSON
  • JSONLD

Wartość domyślna to JSON. Aby uzyskać informacje o obiektach JSON, które zawiera odpowiedź, zobacz Obiekty odpowiedzi.

W przypadku określenia wartości JsonLd treść odpowiedzi zawiera obiekty JSON-LD zawierające wyniki wyszukiwania. Aby uzyskać informacje o pliku JSON-LD, zobacz JSON-LD.
Ciąg Nie
safeSearch Filtr używany do odfiltrowania zawartości dla dorosłych. Poniżej przedstawiono możliwe wartości filtru bez uwzględniania wielkości liter.
  • Wyłączone — zwracaj strony internetowe z tekstem dla dorosłych, obrazami lub filmami wideo.

  • Moderowanie — zwracanie stron internetowych z tekstem dla dorosłych, ale nie z obrazami dla dorosłych ani filmami wideo.

  • Ścisłe — nie zwracaj stron internetowych z tekstem dla dorosłych, obrazami ani filmami wideo.

Wartość domyślna to Moderate.

UWAGA: Jeśli żądanie pochodzi z rynku, którego zasady dla dorosłych Bing wymagają safeSearch ustawienia Strict, usługa Bing ignoruje safeSearch wartość i używa wartości Strict.

UWAGA: Jeśli używasz operatora zapytania site:, istnieje ryzyko, że odpowiedź będzie zawierać zawartość dla dorosłych niezależnie od ustawienia parametru zapytania safeSearch. Operatora site: używaj tylko wtedy, gdy znasz zawartość witryny i w swoim scenariuszu uwzględniasz możliwość pojawienia się zawartości dla dorosłych.
Ciąg Nie
setLang Język ciągów interfejsu użytkownika. Określ język przy użyciu 2-literowego kodu języka w standardzie ISO 639-1. Na przykład kod języka dla języka angielskiego to EN. Wartość domyślna to EN (język angielski).

Mimo, że jest to opcjonalne, należy zawsze określić język. Na ogół dla parametru setLang ustawia się język określony przez parametr mkt, chyba że użytkownik chce, aby ciągi interfejsu użytkownika były wyświetlane w innym języku.

Ten parametr i nagłówek Accept-Language wzajemnie się wykluczają — nie należy określać obu tych parametrów.

Ciąg interfejsu użytkownika to ciąg, który jest używany jako etykieta w interfejsie użytkownika. W obiektach odpowiedzi JSON istnieje kilka ciągów interfejsu użytkownika. Ponadto wszelkie linki do właściwości witryny Bing.com w obiektach odpowiedzi także stosują określony język.
Ciąg Nie

Obiekty odpowiedzi

Poniżej przedstawiono obiekty odpowiedzi JSON, które mogą zawierać odpowiedź. Jeśli żądanie powiedzie się, obiekt najwyższego poziomu w odpowiedzi jest obiektem SearchResponse . Jeśli żądanie zakończy się niepowodzeniem, obiekt najwyższego poziomu jest obiektem ErrorResponse .

Obiekt Opis
Miejsce Definiuje informacje o lokalnej firmie, takiej jak restauracja lub hotel.

Błąd

Definiuje błąd, który wystąpił.

Element Opis Typ
Kod Kod błędu identyfikujący kategorię błędu. Aby uzyskać listę możliwych kodów, zobacz Kody błędów. Ciąg
Komunikat Opis błędu. Ciąg
moreDetails Opis, który zawiera dodatkowe informacje o błędzie. Ciąg
Parametr Parametr zapytania w żądaniu, który spowodował błąd. Ciąg
Subcode Kod błędu identyfikujący błąd. Jeśli na przykład code jest InvalidRequest, subCode może to być parametrInvalid lub ParametrInvalidValue. Ciąg
Wartość Wartość parametru zapytania, która była nieprawidłowa. Ciąg

ErrorResponse

Obiekt najwyższego poziomu, który zawiera odpowiedź, gdy żądanie zakończy się niepowodzeniem.

Nazwa Wartość Typ
_Typu Wpisz wskazówkę. Ciąg
Błędy Lista błędów opisujących przyczyny niepowodzenia żądania. Błąd[]

Licencja

Definiuje licencję, w ramach której może być używany tekst lub zdjęcie.

Nazwa Wartość Typ
name Nazwa licencji. Ciąg
url Adres URL witryny internetowej, w której użytkownik może uzyskać więcej informacji o licencji.

Użyj nazwy i adresu URL, aby utworzyć hiperlink.
Ciąg

Definiuje składniki hiperłącza.

Nazwa Wartość Typ
_Typu Wpisz wskazówkę. Ciąg
tekst Tekst wyświetlany. Ciąg
url Adres URL. Użyj adresu URL i wyświetlania tekstu, aby utworzyć hiperlink. Ciąg

Organizacja

Definiuje wydawcę.

Należy pamiętać, że wydawca może podać swoją nazwę lub swoją witrynę internetową lub obie te elementy.

Nazwa Wartość Typ
name Nazwa wydawcy. Ciąg
url Adres URL witryny internetowej wydawcy.

Należy pamiętać, że wydawca może nie udostępniać witryny sieci Web.
Ciąg

Miejsce

Definiuje informacje o lokalnej firmie, takie jak restauracja lub hotel.

Nazwa Wartość Typ
_Typu Wskazówka typu, która może być ustawiona na jedną z następujących opcji:

  • Hotel
  • LocalBusiness
  • Restaurant
  • Ciąg
    adres Adres pocztowy lokalizacji jednostki. PostalAddress
    entityPresentationInfo Dodatkowe informacje o jednostce, takie jak wskazówki, których można użyć do określenia typu jednostki. Na przykład niezależnie od tego, czy jest to restauracja, czy hotel. Pole entityScenario jest ustawione na ListItem. EntityPresentationInfo
    name Nazwa jednostki. Ciąg
    telefon Numer telefonu jednostki. Ciąg
    url Adres URL witryny internetowej jednostki.

    Użyj tego adresu URL wraz z nazwą jednostki, aby utworzyć hiperlink, który po kliknięciu powoduje przejście użytkownika do witryny internetowej jednostki.
    Ciąg
    webSearchUrl Adres URL do wyniku wyszukiwania usługi Bing dla tego miejsca. Ciąg

    QueryContext

    Definiuje kontekst zapytania używany przez usługę Bing dla żądania.

    Element Opis Typ
    adultIntent Wartość logiczna wskazująca, czy określone zapytanie ma intencję dla dorosłych. Wartość jest prawdziwa , jeśli zapytanie ma intencję dla dorosłych; w przeciwnym razie , fałsz. Wartość logiczna
    zmianaOverrideQuery Ciąg zapytania do użycia w celu wymuszenia użycia oryginalnego ciągu przez usługę Bing. Jeśli na przykład ciąg zapytania działa w dół, przesłonięć ciąg zapytania będzie +saling downwind. Pamiętaj, aby zakodować ciąg zapytania, który powoduje spadek o %2Bsaling+downwind.

    To pole jest uwzględniane tylko wtedy, gdy oryginalny ciąg zapytania zawiera błąd pisowni.
    Ciąg
    alteredQuery Ciąg zapytania używany przez usługę Bing do wykonywania zapytania. Usługa Bing używa zmienionego ciągu zapytania, jeśli oryginalny ciąg zapytania zawierał błędy pisowni. Jeśli na przykład ciąg zapytania to saling downwind, zmieniony ciąg zapytania będzie mieć sailing downwindwartość .

    To pole jest uwzględniane tylko wtedy, gdy oryginalny ciąg zapytania zawiera błąd pisowni.
    Ciąg
    askUserForLocation Wartość logiczna wskazująca, czy usługa Bing wymaga lokalizacji użytkownika w celu zapewnienia dokładnych wyników. Jeśli określono lokalizację użytkownika przy użyciu nagłówków X-MSEdge-ClientIP i X-Search-Location , możesz zignorować to pole.

    W przypadku zapytań obsługujących lokalizację, takich jak "dzisiejsza pogoda" lub "restauracje w pobliżu mnie", które wymagają lokalizacji użytkownika w celu zapewnienia dokładnych wyników, to pole jest ustawione na wartość true.

    W przypadku zapytań obsługujących lokalizację, które zawierają lokalizację (na przykład "Pogoda w Seattle"), to pole jest ustawione na wartość false. To pole jest również ustawione na wartość false dla zapytań, które nie są świadome lokalizacji, takich jak "bestsellery".
    Wartość logiczna
    originalQuery Ciąg zapytania określony w żądaniu. Ciąg

    Zidentyfikowania

    Nazwa Wartość Typ
    identyfikator Identyfikator zasobu Ciąg

    RankingGroup

    Definiuje grupę wyników wyszukiwania, taką jak linia główna.

    Nazwa Wartość Typ
    elementy Lista wyników wyszukiwania do wyświetlenia w grupie. RankingItem

    RankingItem

    Definiuje element wyników wyszukiwania do wyświetlenia.

    Nazwa Wartość Typ
    resultIndex Zerowy indeks elementu w odpowiedzi na wyświetlenie. Jeśli element nie zawiera tego pola, wyświetl wszystkie elementy w odpowiedzi. Na przykład wyświetl wszystkie artykuły z wiadomościami w odpowiedzi wiadomości. Liczba całkowita
    answerType Odpowiedź zawierająca element do wyświetlenia. Na przykład Wiadomości.

    Użyj typu , aby znaleźć odpowiedź w obiekcie SearchResponse. Typ to nazwa pola SearchResponse.

    Należy jednak użyć typu odpowiedzi tylko wtedy, gdy ten obiekt zawiera pole wartości; w przeciwnym razie zignoruj go.
    Ciąg
    textualIndex Indeks odpowiedzi w tekścieAnswers do wyświetlenia. Liczba całkowita bez znaku
    wartość Identyfikator identyfikujący odpowiedź do wyświetlenia lub element odpowiedzi do wyświetlenia. Jeśli identyfikator identyfikuje odpowiedź, wyświetl wszystkie elementy odpowiedzi. Zidentyfikowania

    RankingResponse

    Określa, gdzie na stronie wyników wyszukiwania należy umieścić zawartość i w jakiej kolejności.

    Nazwa Wartość
    Mainline Wyniki wyszukiwania do wyświetlenia w wierszu głównym.
    Biegun Wyniki wyszukiwania, które powinny być dostępne najbardziej widoczne (na przykład wyświetlane powyżej linii głównej i paska bocznego).
    Pasku bocznym Wyniki wyszukiwania do wyświetlenia na pasku bocznym.

    SearchResponse

    Definiuje obiekt najwyższego poziomu, który zawiera odpowiedź po pomyślnym zakończeniu żądania.

    Należy pamiętać, że jeśli usługa podejrzewa atak typu "odmowa usługi", żądanie zakończy się powodzeniem (kod stanu HTTP to 200 OK); jednak treść odpowiedzi będzie pusta.

    Nazwa Wartość Typ
    _Typu Wskazówka dotycząca typu, która jest ustawiona na wartość SearchResponse. Ciąg
    składa Lista jednostek, które są istotne dla zapytania wyszukiwania. Obiekt JSON
    queryContext Obiekt, który zawiera ciąg zapytania używany przez usługę Bing dla żądania.

    Ten obiekt zawiera ciąg zapytania wprowadzony przez użytkownika. Może również zawierać zmieniony ciąg zapytania, którego usługa Bing użyła dla zapytania, jeśli ciąg zapytania zawierał błąd pisowni.
    ZapytanieKontekst

    Kody błędów

    Poniżej przedstawiono możliwe kody stanu HTTP zwracane przez żądanie.

    Kod stanu Opis
    200 Powodzenie.
    400 Brakuje jednego z parametrów zapytania lub jest on nieprawidłowy.
    401 Brak klucza subskrypcji lub jest nieprawidłowy.
    403 Użytkownik jest uwierzytelniany (na przykład używał prawidłowego klucza subskrypcji), ale nie ma uprawnień do żądanego zasobu.

    Usługa Bing może również zwrócić ten stan, jeśli obiekt wywołujący przekroczył limit przydziału zapytań miesięcznie.
    410 Żądanie używało protokołu HTTP zamiast protokołu HTTPS. Protokół HTTPS jest jedynym obsługiwanym protokołem.
    429 Obiekt wywołujący przekroczył limit przydziału na sekundę.
    500 Nieoczekiwany błąd serwera.

    Jeśli żądanie zakończy się niepowodzeniem, odpowiedź zawiera obiekt ErrorResponse , który zawiera listę obiektów Błędów opisujących przyczyny błędu. Jeśli błąd jest związany z parametrem, parameter pole identyfikuje parametr, który jest problemem. A jeśli błąd jest związany z wartością parametru, value pole identyfikuje nieprawidłową wartość.

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

    Poniżej przedstawiono możliwe wartości kodu błędu i kodu podrzędnego błędu.

    Kod SubCode Opis
    Błąd serwera Nieoczekiwany błąd
    Błąd zasobu
    Nieimplementowane
    Kod stanu HTTP to 500.
    InvalidRequest ParametrMissing
    ParameterInvalidValue
    HttpNotAllowed
    Zablokowane
    Usługa Bing zwraca wartość InvalidRequest zawsze, gdy jakakolwiek część żądania jest nieprawidłowa. Na przykład brakuje wymaganego parametru lub wartość parametru jest nieprawidłowa.

    Jeśli błąd to ParameterMissing lub ParameterInvalidValue, kod stanu HTTP to 400.

    Jeśli używasz protokołu HTTP zamiast HTTPS, usługa Bing zwraca wartość HttpNotAllowed, a kod stanu HTTP to 410.
    RateLimitExceeded Brak kodów podrzędnych Usługa Bing zwraca wartość RateLimitExceededed przy każdym przekroczeniu limitu przydziału zapytań na sekundę (QPS) lub zapytań miesięcznie (QPM).

    Jeśli przekroczysz QPS, usługa Bing zwraca kod stanu HTTP 429, a jeśli przekroczysz QPM, funkcja Bing zwraca wartość 403.
    Nieprawidłowa autoryzacja AuthorizationMissing
    AuthorizationRedundancy
    Usługa Bing zwraca wartość InvalidAuthorization, gdy usługa Bing nie może uwierzytelnić elementu wywołującego. Na przykład brakuje nagłówka Ocp-Apim-Subscription-Key lub klucz subskrypcji jest nieprawidłowy.

    Nadmiarowość występuje, jeśli określisz więcej niż jedną metodę uwierzytelniania.

    Jeśli błąd to InvalidAuthorization, kod stanu HTTP to 401.
    Niewystarczające uwierzytelnianie AuthorizationDisabled
    AuthorizationExpired
    Usługa Bing zwraca wartość InsufficientAuthorization, gdy obiekt wywołujący nie ma uprawnień dostępu do zasobu. Może się to zdarzyć, jeśli klucz subskrypcji został wyłączony lub wygasł.

    Jeśli błąd to InsufficientAuthorization, kod stanu HTTP to 403.

    Następne kroki