Referenční informace k rozhraní API pro vyhledávání zpráv v7
Upozornění
Rozhraní API pro vyhledávání Bingu se přesouvají ze služeb Cognitive Services na Vyhledávací služby Bingu. Od 30. října 2020 je potřeba zřídit všechny nové instance vyhledávání Bingu podle postupu popsaného tady. Rozhraní API vyhledávání Bingu zřízená pomocí služeb Cognitive Services budou podporována po dobu následujících tří let nebo do konce smlouva Enterprise, podle toho, co nastane dříve. Pokyny k migraci najdete v tématu Vyhledávací služby Bingu.
Rozhraní API pro vyhledávání zpráv umožňuje odeslat vyhledávací dotaz do Bingu a získat zpět seznam relevantních zpravodajských článků. Tato část obsahuje technické podrobnosti o parametrech dotazu a hlavičkách, které použijete k vyžádání článků o novinkách, a objektech odpovědí JSON, které je obsahují. Příklady, které ukazují, jak vytvářet žádosti, najdete v tématu Hledání příspěvků na webu.
Informace o hlavičkách, které by měly požadavky obsahovat, najdete v tématu Hlavičky požadavků.
Informace o parametrech dotazu, které by měly požadavky obsahovat, najdete v tématu Parametry dotazu.
Informace o objektech JSON, které může odpověď obsahovat, najdete v tématu Objekty odpovědi.
Informace o povoleném použití a zobrazení výsledků najdete v tématu Požadavky na použití a zobrazení rozhraní API Bingu pro vyhledávání.
Poznámka
Vzhledem k tomu, že formáty a parametry adres URL se můžou změnit bez upozornění, použijte všechny adresy URL tak, jak jsou. Neměli byste přijímat závislosti na formátu nebo parametrech adresy URL, pokud není uvedeno.
Koncové body
Pokud chcete požádat o zpravodajské články, odešlete požadavek GET na jednu z následujících adres URL:
| URL | Popis |
|---|---|
https://api.cognitive.microsoft.com/bing/v7.0/news |
Vrátí nejčastější zpravodajské články podle kategorie. Můžete si například vyžádat nejlepší sportovní nebo zábavní články. Informace o zadávání kategorií najdete v parametru dotazu kategorie . |
https://api.cognitive.microsoft.com/bing/v7.0/news/search |
Vrátí články zpráv na základě vyhledávacího dotazu uživatele. Pokud je vyhledávací dotaz prázdný, volání vrátí nejdůležitější články zpráv. |
https://api.cognitive.microsoft.com/bing/v7.0/news/trendingtopics |
Vrátí populární témata zpráv, která jsou aktuálně populární na sociálních sítích. POZNÁMKA: K dispozici pouze na trzích en-US a zh-CN. |
V případě předplatných s více službami musíte v adrese URL zahrnout oblast. Příklad: westus.api.cognitive.microsoft.com. Viz Podporované oblasti.
Požadavek musí používat protokol HTTPS. Protokol HTTP se nepodporuje.
Poznámka
Maximální délka adresy URL je 2 048 znaků. Aby se zajistilo, že délka adresy URL nepřekročí limit, musí být maximální délka parametrů dotazu menší než 1 500 znaků. Pokud adresa URL přesahuje 2 048 znaků, server vrátí hodnotu 404 Nenalezena.
Hlavičky
Níže jsou uvedené hlavičky, které může požadavek a odpověď obsahovat.
| Hlavička | Description |
|---|---|
| Přijmout | Nepovinná hlavička požadavku. Výchozí typ média je application/json. Pokud chcete určit, že odpověď bude používat JSON-LD, nastavte hlavičku Accept na application/ld+json. |
| Accept-Language | Nepovinná hlavička požadavku. Čárkami oddělený seznam jazyků pro řetězce uživatelského rozhraní. Seznam je v sestupném pořadí podle priority. Další informace včetně očekávaného formátu najdete v RFC2616. Tato hlavička a parametr dotazu setLang se vzájemně vylučují – nezadávejte obojí. Pokud tuto hlavičku nastavíte, musíte zadat také parametr dotazu cc. K určení trhu, pro který se mají vracet výsledky, Bing použije první podporovaný jazyk, který najde v seznamu, a zkombinuje ho s hodnotou parametru cc. Pokud seznam jazyků podporovaný jazyk neobsahuje, Bing najde nejbližší jazyk a trh, který požadavek podporuje, nebo pro výsledky použije agregovaný nebo výchozí trh. Pokud chcete zjistit, který trh Bing použil, podívejte se do hlavičky BingAPIs-Market.Tuto hlavičku a parametr dotazu cc použijte jenom v případě, že zadáte více jazyků. Jinak použijte parametry dotazu mkt a setLang.Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědí JSON je několik řetězců uživatelského rozhraní. Zadaný jazyk použijí všechny odkazy na vlastnosti Bing.com v objektech odpovědi. |
| BingAPIs-Market | Hlavička odpovědi. Trh používaný požadavkem. Formulář je <languageCode-countryCode<>>. Například cs-CZ. Pokud zadáte trh, který není uvedený v kódech trhu, může se tato hodnota lišit od trhu, který jste zadali v parametru dotazu mkt . Totéž platí, pokud zadáte hodnoty cc a Accept-Language , které se nedají sloučit. |
| BingAPIs-TraceId | Hlavička odpovědi. ID položky protokolu obsahující podrobnosti požadavku. Pokud dojde k chybě, toto ID zachyťte. Pokud problém nedokážete určit a vyřešit, uveďte toto ID spolu s dalšími informacemi, které poskytnete týmu podpory. |
| Ocp-Apim-Subscription-Key | Povinná hlavička požadavku. Klíč předplatného, který jste dostali při registraci k této službě v Cognitive Services. |
| Pragma | Nepovinná hlavička požadavku Ve výchozím nastavení Bing vrátí obsah uložený v mezipaměti, pokud je k dispozici. Pokud chcete zabránit ukládání obsahu do mezipaměti, nastavte hlavičku Pragma na no-cache (například Pragma: no-cache). |
| Opakovat po | Hlavička odpovědi. Odpověď obsahuje tuto hlavičku, pokud překročíte počet povolených dotazů za sekundu (QPS) nebo za měsíc (QPM). Hlavička obsahuje počet sekund, které musíte počkat před odesláním dalšího požadavku. |
| User-Agent | Nepovinná hlavička požadavku. Uživatelský agent, ze kterého požadavek pochází. Bing používá uživatelského agenta k poskytnutí optimalizovaného prostředí pro mobilní uživatele. I když je tato hlavička nepovinná, doporučujeme ji vždy zadat. Uživatelský agent by měl být stejný řetězec, který odesílá kterýkoli běžně používaný prohlížeč. Informace o uživatelských agentech najdete v RFC 2616. Následují příklady řetězců uživatelského agenta.
|
| X-MSEdge-ClientID | Nepovinná hlavička požadavku a odpovědi Bing tuto hlavičku používá k tomu, aby uživatelům poskytoval konzistentní chování napříč voláními rozhraní API Bingu. Bing často testuje nové funkce a vylepšení a ID klienta používá jako klíč pro přiřazení provozu v různých testovacích verzích. Pokud nepoužíváte stejné ID klienta pro uživatele napříč více požadavky, pak může Bing uživatele přiřadit k více konfliktním testovacím verzím. Přiřazení k více konfliktním testovacím verzím může vést k nekonzistentnímu prostředí pro uživatele. Pokud třeba druhý požadavek má jiné přiřazení k testovací verzi než prví, může být prostředí neočekávané. Bing může také použít ID klienta k přizpůsobení webových výsledků historii hledání daného ID klienta, což uživateli poskytuje bohatší prostředí. Bing také tuto hlavičku používá ke zlepšování hodnocení výsledků díky analýze aktivity generované tímto ID klienta. Zlepšení relevance pomáhá zlepšit kvalitu výsledků poskytovaných rozhraním API Bingu a stejně tak umožňuje vyšší míru prokliků uživatele rozhraní API. DŮLEŽITÉ: I když je tato hlavička nepovinná, měli byste ji považovat za povinnou. Zachování ID klienta mezi více požadavky pro stejnou kombinaci koncového uživatele a zařízení umožňuje 1) aby uživatel rozhraní API získával konzistentní uživatelské prostředí a 2) vyšší míry prokliků díky kvalitnějším výsledkům z rozhraní API Bingu. Následují základní pravidla používání, která se na tuto hlavičku vztahují.
POZNÁMKA: Odpovědi Bingu tuto hlavičku mohou nebo nemusí obsahovat. Pokud odpověď tuto hlavičku obsahuje, ID klienta zachyťte a použijte pro všechny následné požadavky Bingu pro uživatele na tomto zařízení. POZNÁMKA: Pokud zahrnete X-MSEdge-ClientID, nesmíte do požadavku zahrnout soubory cookie. |
| X-MSEdge-ClientIP | Nepovinná hlavička požadavku. Adresa IPv4 nebo IPv6 klientského zařízení. IP adresa se používá ke zjištění polohy uživatele. Bing informace o poloze používá k určení chování bezpečného hledání. POZNÁMKA: I když je tato hlavička nepovinná, doporučujeme ji vždy zadat, stejně jako hlavičku X-Search-Location. Neprovádějte obfuskaci adresy (například změnou posledního oktetu na 0). Obfuskace adresy vede k tomu, že poloha nebude blízko skutečné polohy zařízení. Bing pak může dodávat chybné výsledky. |
| X-Search-Location | Nepovinná hlavička požadavku. Středníky oddělený seznam párů klíč/hodnota, které popisují zeměpisnou polohu klienta. Bing informace o poloze používá k určení chování bezpečného hledání a vracení relevantního místního obsahu. Pár klíč/hodnota zadejte jako <klíč>:<hodnota>. Následují klíče, které se používají k určení polohy uživatele.
POZNÁMKA: I když jsou mnohé klíče nepovinné, čím více informací zadáte, tím přesnější budou výsledky určení polohy. POZNÁMKA: I když je geografická poloha uživatele nepovinná, doporučujeme ji vždy zadat. Poskytnutí polohy je zvlášť důležité, pokud IP adresa klienta přesně neodráží fyzickou polohu uživatele (třeba pokud klient používá síť VPN). Pro optimální výsledky byste měli zahrnout tuto hlavičku a hlavičku X-Search-ClientIP, ale minimálně tuto hlavičku. |
Poznámka
Nezapomínejte, že podmínky použití vyžadují dodržování příslušných zákonů, včetně těch týkajících se použití těchto hlaviček. Například v určitých jurisdikcích, třeba v Evropě, se před umístěním určitých sledovacích zařízení do zařízení uživatelů požaduje získání souhlasu uživatele.
Parametry dotazů
Níže jsou uvedené parametry dotazu, které tento požadavek může zahrnovat. Sloupec Vyžadováno určuje, jestli je příslušný parametr nutné zadat. Hodnoty parametrů dotazů musíte zakódovat s použitím kódování URL.
| Name | Hodnota | Typ | Vyžadováno |
|---|---|---|---|
| cc | Dva znaky kódu země, odkud výsledky pochází. Seznam možných hodnot najdete v tématu Kódy trhu. Pokud tento parametr nastavíte, musíte zadat také hlavičku Accept-Language. Bing použije první podporovaný jazyk, který najde v zadaných jazycích, a zkombinuje ho s kódem země, aby určil trh, pro který se mají vracet výsledky. Pokud seznam jazyků podporovaný jazyk neobsahuje, najde Bing nejbližší jazyk a trh, který požadavek podporuje. Nebo bing může pro výsledky použít agregovaný nebo výchozí trh. Tento parametr dotazu a hlavičku použijte pouze v Accept-Language případě, že zadáte více jazyků. Jinak byste měli použít mkt parametry dotazu a setLang .Tento parametr a parametr dotazu mkt se vzájemně vylučují – nezadávejte obojí. |
Řetězec | No |
| Kategorie | Kategorie článků, které se mají vrátit. Například Sportovní články nebo Články o zábavě. Seznam možných kategorií najdete v tématu Kategorie zpráv podle trhu. Tento parametr používejte pouze u žádostí o kategorii zpráv (viz koncový bod /news). Pokud tento parametr nezadáte, odpověď bude obsahovat obě možnosti:
Pokud neurčujete headlineCount a trh podporuje osm kategorií, bude odpověď obsahovat až 44 článků a shluků (12 hlavních článků a shluků plus 32 článků a shluků specifických pro danou kategorii). Vzhledem k tomu, že cluster obsahuje více než jeden článek, může být počet článků v tomto příkladu 44 vyšší. Odpověď může například obsahovat 11 hlavních článků a jeden shluk, který obsahuje čtyři související hlavní články pro celkem 15 hlavních článků. |
Řetězec | No |
| Počet | Počet příspěvků, které se mají vrátit v odpovědi. Skutečné doručované číslo může být menší, než je požadováno. Výchozí hodnota je 10 a maximální hodnota je 100. U populárních témat jsou výchozím nastavením všechna populární témata zpráv (přibližně 55 článků). Tento parametr můžete použít společně s parametrem offset pro výsledky stránky. Pokud například uživatelské rozhraní zobrazuje 20 článků na stránku, nastavte count 20 a offset 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší offset o 20 (například 0, 20, 40). Je možné, že více stránek obsahuje určité překrývající se výsledky.POZNÁMKA: Clustery se počítají jako jedna položka. Pokud například nastavíte počet na 10, odpověď může obsahovat 9 článků a 1 cluster, ale cluster může obsahovat 5 článků. POZNÁMKA: Pokud požadujete kategorie zpráv, zadejte tento parametr pouze v případě, že zadáte parametr kategorie. Pokud nezadáte parametr kategorie, Bing tento parametr ignoruje. |
UnsignedShort | No |
| Čerstvost | Filtrujte příspěvky podle následujících věkových hodnot:
|
Řetězec | No |
| headlineCount | Počet hlavních článků a shluků, které se mají vrátit. Výchozí hodnota je 12. Tento parametr zadejte pouze v případě, že nezadáte parametr kategorie. Pokud zadáte parametr kategorie, Bing tento parametr ignoruje. Tento parametr používejte pouze u žádostí o kategorie zpráv. |
UnsignedShort | Ne |
| mkt | Trh, odkud pochází výsledky. Obvykle je země, mkt ze které uživatel vytváří požadavek. Pokud se však uživatel nenachází v zemi, ve které Bing doručuje výsledky, může to být jiná země. Trh musí být ve formátu <kódové>> kódy< země jazyka. Například cs-CZ. Řetězec nerozlišuje velká a velká písmena. Seznam možných hodnot trhu najdete v tématu Kódy trhu.POZNÁMKA: Pokud ho znáte, doporučujeme vždy zadat trh. Určení trhu pomáhá Bingu směrovat požadavek a vrátit odpovídající a optimální odpověď. Pokud zadáte trh, který není uvedený v kódech trhu, použije Bing kód trhu, který nejlépe vyhovuje, na základě interního mapování, které se může změnit. Tento parametr a parametr dotazu cc se vzájemně vylučují – nezadávejte oba parametry. |
Řetězec | Ne |
| Posun | Posun založený na nule, který označuje počet článků, které se mají přeskočit před vrácením článků. Výchozí hodnota je 0. Posun by měl být menší než (totalEstimatedMatches - count).Tento parametr použijte spolu s parametrem count pro výsledky stránky. Pokud například uživatelské rozhraní zobrazuje 20 článků na stránku, nastavte count 20 a offset 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší offset o 20 (například 0, 20, 40). Je možné, že více stránek obsahuje určité překrývající se výsledky.POZNÁMKA: Clustery se počítají jako jedna položka. Pokud například nastavíte počet na 10, odpověď může obsahovat 9 článků a 1 cluster, ale cluster může obsahovat 5 článků. POZNÁMKA: Pokud požadujete kategorie zpráv, zadejte tento parametr pouze v případě, že zadáte parametr kategorie. Pokud nezadáte parametr kategorie, Bing tento parametr ignoruje. |
Nepodepsaný krátký | No |
| originalImg | Logická hodnota, která určuje, jestli obrázek contentUrl obsahuje adresu URL, která odkazuje na miniaturu obrázku původního článku, nebo na samotný obrázek.Pokud článek obsahuje obrázek a tento parametr je nastavený na hodnotu true, vlastnost obrázku contentUrl obsahuje adresu URL, kterou můžete použít ke stažení původního obrázku z webu vydavatele. Pokud je tento parametr false, odkazuje adresa URL i thumbnailUrl obrázek contentUrl na stejný miniaturu.Výchozí hodnotou je hodnota false. Tento parametr používejte jenom s rozhraním API pro vyhledávání zpráv. Tento parametr nezadávejte při volání rozhraní API pro vyhledávání na webu. Populární témata tento parametr ignorují. |
Logická hodnota | Ne |
| Q | Termín hledaného dotazu uživatele. Pokud je termín prázdný (například q=), bude odpověď obsahovat nejdůležitější příspěvky. Termín řetězec může obsahovat rozšířené operátory Bingu. Pokud chcete například omezit zprávy na určitou doménu, použijte operátor site: . Pokud dostáváte příspěvky podle kategorie, nezahrnujte tento parametr. Populární témata tento parametr ignorují. |
Řetězec | Yes |
| safeSearch | Filtrujte příspěvky pro obsah pro dospělé. Níže jsou uvedené možné hodnoty filtru.
Výchozí hodnota je Moderate. POZNÁMKA: Pokud žádost pochází z trhu, který vyžaduje zásada pro dospělé Bingu, která safeSearch je nastavená na Striktní, Bing tuto hodnotu ignoruje safeSearch a použije Strict. |
Řetězec | Ne |
| setLang | Jazyk, který se má použít pro řetězce uživatelského rozhraní. Jazyk můžete zadat pomocí 2 nebo 4mísílového kódu. Upřednostňují se 4mísídkové kódy. Seznam podporovaných kódů jazyků najdete v tématu Jazyky podporované Bingem. Bing načte lokalizované řetězce, pokud setlang obsahuje platný kód neutrální jazykové verze (fr) o délce 2 písmen nebo platný kód jazykové verze specifické pro 4 písmena (fr-ca). Například pro fr-ca Bing načte řetězce kódu neutrální jazykové verze fr .Pokud setlang není platná (například zh) nebo Bing nepodporuje jazyk (například af, af-na), Bing ve výchozím nastavení nastaví en (angličtina).Pokud chcete zadat kód 2 písmen, nastavte tento parametr na kód jazyka ISO 639-1. Pokud chcete zadat kód se 4 písmeny, použijte formulář <language-country<>/region>, kde <jazyk> je kód jazyka ISO 639-1 (neutrální jazyková verze) a <země/oblast> je kód iso 3166 země/oblast (specifická jazyková verze). Například pro USA angličtinu použijte en-US. I když je jazyk volitelný, měli byste ho vždy zadat. Obvykle se setLang nastavuje na stejný jazyk, jaký určuje parametr mkt, pokud uživatel nechce řetězce uživatelského rozhraní zobrazené v jiném jazyce.Tento parametr a hlavička Accept-Language se vzájemně vylučují – nezadávejte obojí. Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědí JSON je několik řetězců uživatelského rozhraní. Zadaný jazyk použijí také všechny odkazy na vlastnosti Bing.com v objektech odpovědi. |
Řetězec | No |
| Protože | Čas epochy systému Unix (časové razítko Unixu), který Bing používá k výběru populárních témat. Bing vrací populární témata, která zjistila k zadanému datu a času nebo později, nikoli od data publikování tématu. Pokud chcete použít tento parametr, zadejte sortBy také parametr . |
Integer | No |
| sortBy | Pořadí, ve které se mají vrátit populární témata. Níže jsou uvedené možné hodnoty nerozlišující malá a velká písmena.
Pokud tento parametr nezadáte, neexistuje žádné konkrétní řazení. Bere se ale v úvahu aktuálnost témat, kategorie, globální zapojení uživatelů a přizpůsobené funkce. |
Řetězec | No |
| textDecorations | Logická hodnota, která určuje, jestli mají zobrazované řetězce obsahovat značky dekorací, jako je například zvýrazňování znaků. Pokud je hodnota true, mohou řetězce obsahovat značky. Výchozí hodnota je false. Pokud chcete určit, jestli se mají jako značky používat znaky Unicode nebo značky HTML, projděte si parametr dotazu textFormat . Informace o zvýrazňování přístupů najdete v tématu Zvýraznění přístupů. |
Logická hodnota | Ne |
| Textformat | Typ značek, které se mají použít pro dekoraci textu (viz textDecorations parametr dotazu).Níže jsou uvedené možné hodnoty.
Výchozí hodnota je Raw. Seznam značek najdete v tématu Zvýraznění hitů. U zobrazovaných řetězců, které obsahují znaky HTML, jako <jsou , >a &, pokud textFormat je nastaveno na HTML, Bing tyto znaky podle potřeby uvozuje (například < se uvozuje do <).Informace o zpracování řetězců s vloženými znaky Unicode najdete v tématu Zvýraznění přístupů. |
Řetězec | No |
Objekty odpovědí
Poznámka
Aby bylo v souladu s novou směrnicí EU o autorských právech ve Francii, musí web Bingu, zprávy, video, obrázky a všechna rozhraní API pro vlastní vyhledávání vynechat obsah z některých zdrojů zpráv EU pro francouzské uživatele. Odebraný obsah může obsahovat miniatury obrázků a videí, náhledy videí a fragmenty kódu, které doprovázejí výsledky hledání z těchto zdrojů. V důsledku toho můžou rozhraní API Bingu francouzským uživatelům poskytovat méně výsledků s miniaturami a videi, náhledy videí a fragmenty kódu.
Níže jsou uvedené objekty JSON, které může odpověď obsahovat. Pokud je požadavek úspěšný, je objektem nejvyšší úrovně v odpovědi objekt News , pokud je koncový bod /news/search nebo /news, a TrendingTopicAnswer , pokud je koncový bod /news/trendingtopics. Pokud požadavek selže, objekt nejvyšší úrovně je ErrorResponse objekt.
| Objekt | Description |
|---|---|
| Chyba | Definuje chybu, ke které došlo. |
| ErrorResponse | Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když požadavek selže. |
| Obrázek | Definuje miniaturu obrázku souvisejícího se zprávami. |
| MediaSize | Definuje velikost mediálního obsahu. |
| Novinky | Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když je požadavek na zprávy úspěšný. |
| NewsArticle | Definuje zpravodajský článek. |
| Organizace | Definuje poskytovatele, který spustil článek. |
| Dotaz | Definuje řetězec vyhledávacího dotazu. |
| Souvisejícítopic | Definuje seznam zpravodajských článků, které souvisejí s vyhledávacím dotazem. |
| Miniaturu | Definuje odkaz na související obrázek. |
| Téma | Definuje populární téma zpráv. |
| PopulárníTopics | Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když populární témata požadavek bude úspěšný. |
| Video Definuje video, které souvisí se zpravodajským článkem. |
Chyba
Definuje chybu, ke které došlo.
| Element | Popis | Typ |
|---|---|---|
| Kód | Kód chyby, který identifikuje kategorii chyby. Seznam možných kódů najdete v tématu Kódy chyb. | Řetězec |
| Zprávu | Popis chyby. | Řetězec |
| dalšíPodrobné informace | Popis, který poskytuje další informace o chybě. | Řetězec |
| Parametr | Parametr dotazu v požadavku, který způsobil chybu. | Řetězec |
| podkód | Kód chyby, který chybu identifikuje. Pokud je například code InvalidRequest, subCode může být ParameterInvalid nebo ParameterInvalidValue. |
Řetězec |
| Hodnotu | Hodnota parametru dotazu, která nebyla platná. | Řetězec |
ErrorResponse
Objekt nejvyšší úrovně, který odpověď zahrnuje, když požadavek selže.
| Name | Hodnota | Typ |
|---|---|---|
| _Typ | Napište nápovědu. | Řetězec |
| Chyby | Seznam chyb, které popisují důvody, proč požadavek selhal. | Chyba[] |
Image
Definuje miniaturu obrázku souvisejícího se zprávami.
| Name | Hodnota | Typ |
|---|---|---|
| Zprostředkovatel | Seznam vlastníků image. | Organizace |
| thumbnail | Odkaz na miniaturu obrázku. | Miniaturu |
| url | Adresa URL obrázku. | Řetězec |
MediaSize
Definuje velikost mediálního obsahu.
| Name | Hodnota | Typ |
|---|---|---|
| výška | Výška multimediálního obsahu v pixelech | Integer |
| šířka | Šířka multimediálního obsahu v pixelech | Integer |
Novinky
Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když je požadavek na zprávy úspěšný.
Pokud má služba podezření na útok dos, požadavek bude úspěšný (stavový kód HTTP je 200 OK), ale text odpovědi je prázdný.
| Name | Hodnota | Typ |
|---|---|---|
| _Typ | Napište nápovědu. | Řetězec |
| id | ID, které jedinečně identifikuje odpověď na zprávy. Informace o tom, jak toto pole používat, najdete v tématu Použití funkce Řazení k zobrazení výsledků v průvodci rozhraním API vyhledávání na webu. |
Řetězec |
| readLink | Adresa URL, která vrací tuto odpověď. Pokud chcete použít adresu URL, podle potřeby připojte parametry dotazu a zahrňte hlavičku Ocp-Apim-Subscription-Key . Toto pole obsahuje rozhraní API pro vyhledávání na webu. Adresu URL byste obvykle použili, pokud chcete přímo dotazovat rozhraní API pro vyhledávání zpráv. |
Řetězec |
| relatedTopics | Seznam zpravodajských článků, které souvisejí s hledaný termín. | RelatedTopic[] |
| Řazení | Seznam možností řazení zpravodajských článků. Můžete například řadit podle relevance (výchozí) nebo data. Pokud chcete zjistit, jaké pořadí řazení požadavek použil, projděte si isSelected toto pole. |
SortValue[] |
| totalEstimatedMatches | Odhadovaný počet zpravodajských článků, které jsou relevantní pro dotaz. Toto číslo použijte spolu s parametry dotazu count a offset k stránkování výsledků. Toto pole obsahuje pouze rozhraní API pro vyhledávání zpráv (rozhraní API pro vyhledávání na webu ne). |
Dlouhé |
| Hodnotu | Seznam zpravodajských článků, které jsou relevantní pro termín dotazu. Pokud nejsou k dispozici žádné výsledky, které by se pro požadavek vrátily, je pole prázdné. |
NewsArticle[] |
NewsArticle
Definuje zpravodajský článek.
| Name | Hodnota | Typ |
|---|---|---|
| Kategorie | Kategorie zpráv, do které článek patří. Například Sport. Pokud kategorii zpráv nelze určit, článek toto pole neobsahuje. Seznam možných kategorií najdete v tématu Kategorie zpráv podle trhu. Pokud vaše žádost určuje kategorii Sports-Tennis, category může vlastnost obsahovat Sports-Tennis nebo Sport. |
Řetězec |
| clusteredArticles | Seznam souvisejících zpravodajských článků. | Článek s novinkami[] |
| smluvní pravidla | Seznam pravidel, která musíte dodržovat, pokud zobrazíte článek. Pravidla můžou například řídit, jestli musíte zadat atribuci. Mohou platit následující smluvní pravidla. Pokud článek obsahuje smluvní pravidla, musíte se jimi řídit. POZNÁMKA: Smluvní pravidla obsahují pouze články vrácené rozhraním API pro vyhledávání na webu . Články vrácené koncovými body Zpráv nezahrnují smluvní pravidla. |
Objekt[] |
| datumPublikováno | Datum a čas, kdy Bing článek objevil. Datum je ve formátu RRRR-MM-DDTHH:MM:SS. | Řetězec |
| Popis | Krátký popis zpravodajského článku. | Řetězec |
| Titulek | Logická hodnota, která označuje, jestli je zpravodajský článek nadpisem. Pokud ano, článek je nadpisem. POZNÁMKA: Tento článek obsahuje toto pole pouze pro žádosti o kategorie zpráv, které nezadávají parametr dotazu kategorie . |
Logická hodnota |
| id | ID, které jednoznačně identifikuje tento článek v seznamu článků. Informace o tom, jak toto pole používat, najdete v tématu Použití funkce Řazení k zobrazení výsledků v průvodci rozhraním API pro vyhledávání na webu. |
Řetězec |
| Obrázek | Obrázek související s novým článkem Objekt Image v tomto kontextu obsahuje pouze thumbnail pole . |
Obrázek |
| Zmiňuje | Seznam entit (míst nebo osob) uvedených v článku | Věc[] |
| Jméno | Název článku. Tento název použijte spolu s adresou URL k vytvoření hypertextového odkazu, který po kliknutí uživatele přenese na zpravodajský článek. |
Řetězec |
| Zprostředkovatel | Seznam poskytovatelů, kteří spustili článek. | Organizace[] |
| Adresu url | Adresa URL zpravodajského článku. Tuto adresu URL použijte společně s name k vytvoření hypertextového odkazu, který po kliknutí uživatele přenese na zpravodajský článek. |
Řetězec |
| Video | Video, které souvisí se zpravodajským článkem. | Video |
Organizace
Definuje poskytovatele, který spustil článek.
| Name | Hodnota | Typ |
|---|---|---|
| _Typ | Napište nápovědu. | Řetězec |
| name | Název poskytovatele, který spustil článek. | Řetězec |
Dotaz
Definuje řetězec vyhledávacího dotazu.
| Name | Hodnota | Typ |
|---|---|---|
| Text | Řetězec dotazu, který vrací populární téma. | Řetězec |
Souvisejícítopic
Definuje seznam zpravodajských článků, které souvisejí s vyhledávacím dotazem.
| Name | Hodnota | Typ |
|---|---|---|
| relatedNews | Seznam souvisejících zpravodajských článků. | Článek s příspěvky |
| Jméno | Související termín dotazu, který vrátil související zpravodajské články. | Řetězec |
| adresa URL webového hledání | Adresa URL, která uživatele přenese na výsledky hledání Bingu pro související dotaz. | Řetězec |
Hodnota řazení
Definuje pořadí řazení, které se má použít pro požadavek.
| Name | Hodnota | Typ |
|---|---|---|
| id | Identifikátor, který identifikuje pořadí řazení článků. Níže jsou uvedené možné hodnoty.
|
Řetězec |
| Isselected | Logická hodnota, která určuje, zda odpověď použila toto pořadí řazení. Pokud je true, odpověď použila toto pořadí řazení. | Logická hodnota |
| name | Zobrazovaný název pořadí řazení | Řetězec |
| url | Adresa URL, kterou můžete použít k vytvoření stejného požadavku pomocí tohoto pořadí řazení. | Řetězec |
TextAttribution
Definuje smluvní pravidlo pro přiřazení ve formátu prostého textu.
Věc
Definuje entitu, kterou článek zmiňuje.
| Name | Hodnota | Typ |
|---|---|---|
| name | Název entity, kterou článek uvádí. | Řetězec |
Miniaturu
Definuje odkaz na související obrázek.
| Name | Hodnota | Typ |
|---|---|---|
| contentUrl | Adresa URL obrázku. | Řetězec |
| Výška | Výška obrázku v pixelech | Nepodepsaný krátký |
| Šířka | Šířka obrázku v pixelech | Nepodepsaný krátký |
Téma
Definuje populární téma zpráv.
| Name | Hodnota | Typ |
|---|---|---|
| Obrázek | Odkaz na související obrázek. Objekt Image v tomto kontextu obsahuje pouze url pole a provider . Pole provider je pole objektů organizace , které identifikují poskytovatele obrázků. |
Image |
| isBreakingNews | Logická hodnota, která označuje, jestli je téma považováno za nejnovější zprávy. Pokud je téma považováno za nejnovější zprávy, hodnota je true. | Logická hodnota |
| Jméno | Název populárního tématu. | Řetězec |
| newsSearchUrl | Adresa URL výsledků hledání Zpráv Bingu pro termín vyhledávacího dotazu (viz query pole). |
Řetězec |
| Dotazu | Výraz vyhledávacího dotazu, který vrací toto populární téma. | Dotaz |
| webSearchUrl | Adresa URL výsledků hledání Bingu pro termín hledaného dotazu (viz query pole). |
Řetězec |
PopulárníTopics
Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když populární témata požadavek bude úspěšný.
| Name | Hodnota | Typ |
|---|---|---|
| Hodnotu | Seznam populárních zpravodajských témat na Bingu. Pokud nejsou k dispozici žádné výsledky, které by se pro požadavek vrátily, je pole prázdné. |
Téma[] |
Video
Definuje video, které souvisí se zpravodajským článkem.
Poznámka
Vzhledem k tomu, že se formát a parametry adresy URL můžou změnit bez předchozího upozornění, použijte všechny adresy URL tak, jak jsou. Neměli byste přijímat závislosti na formátu nebo parametrech adresy URL.
| Name | Hodnota | Typ |
|---|---|---|
| allowHttpsEmbed | Logická hodnota, která určuje, jestli můžete vložit video (viz embedHtml pole) na stránky, které používají protokol HTTPS. |
Logická hodnota |
| embedHtml | Prvek iframe, který umožňuje vložit a spustit video na webovou stránku. | Řetězec |
| motionThumbnailUrl | Adresa URL animované miniatury, která zobrazuje náhled videa. Tuto adresu URL obvykle použijete k přehrání náhledu videa, když uživatel na stránce výsledků najede myší na miniaturu videa. | Řetězec |
| Jméno | Název videa. | Řetězec |
| thumbnail | Šířka a výška miniatury nebo pohybové miniatury. | MediaSize |
| thumbnailUrl | Adresa URL miniatury videa Informace o změně velikosti obrázku najdete v tématu Změna velikosti a oříznutí miniatur obrázků. | Řetězec |
Kategorie zpráv podle trhu
Níže jsou uvedené možné kategorie zpráv, na které můžete nastavit parametr dotazu kategorie . Můžete nastavit category nadřazenou kategorii, například Zábava, nebo některou z jejích podkategorií, jako je Entertainment_MovieAndTV. Pokud nastavíte category nadřazenou kategorii, bude obsahovat články z jedné nebo více jejích podkategorií. Pokud nastavíte category podkategorii, bude obsahovat jenom články z podkategorie.
| Trhu | Podporované kategorie |
|---|---|
| Austrálie (en-AU) |
|
| Kanada (cs-CA) |
|
| Čína (zh-CN) |
|
| Indie (en-IN) |
|
| Japonsko (ja-JP) |
|
| Spojené království (en-GB) |
|
| USA (en-US) |
|
Kódy chyb
Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrací.
| Stavový kód | Description |
|---|---|
| 200 | Úspěch. |
| 400 | Jeden z parametrů dotazu chybí nebo je neplatný. |
| 401 | Klíč předplatného chybí nebo není platný. |
| 403 | Uživatel je ověřený (například použil platný klíč předplatného), ale nemá oprávnění k požadovanému prostředku. Bing může tento stav vrátit také v případě, že volající překročil svou měsíční kvótu dotazů. |
| 410 | Požadavek použil místo protokolu HTTPS protokol HTTP. HTTPS je jediný podporovaný protokol. |
| 429 | Volající překročil kvótu dotazů za sekundu. |
| 500 | Neočekávaná chyba serveru. |
Pokud požadavek selže, odpověď obsahuje objekt ErrorResponse, který obsahuje seznam objektů Error, které popisují příčinu chyby. Pokud chyba souvisí s parametrem, parameter toto pole identifikuje parametr, u kterého se problém týká. A pokud chyba souvisí s hodnotou parametru value , pole identifikuje hodnotu, která není platná.
{
"_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."
}
]
}
Níže jsou uvedené možné hodnoty kódu chyby a dílčího kódu.
| Kód | Podkód | Description |
|---|---|---|
| Chyba serveru | UnexpectedError Chyba prostředku NotImplemented |
Stavový kód HTTP je 500. |
| InvalidRequest | ParameterMissing ParametrInvalidValue HttpNotAllowed Blokované |
Bing vrátí InvalidRequest vždy, když některá část požadavku není platná. Například chybí požadovaný parametr nebo hodnota parametru není platná. Pokud je chyba ParameterMissing nebo ParameterInvalidValue, stavový kód HTTP je 400. Pokud místo HTTPS použijete protokol HTTP, vrátí Bing httpNotAllowed a stavový kód HTTP je 410. |
| RateLimitExceeded | Žádné podprogramy | Bing vrátí hodnotu RateLimitExceeded pokaždé, když překročíte kvótu dotazů za sekundu (QPS) nebo dotazů za měsíc (QPM). Pokud překročíte QPS, Bing vrátí stavový kód HTTP 429, a pokud překročíte QPM, vrátí Bing 403. |
| Neplatná autorizace | AuthorizationMissing AuthorizationRedundancy |
Bing vrátí invalidAuthorization, když Bing nemůže ověřit volajícího. Například chybí hlavička Ocp-Apim-Subscription-Key nebo klíč předplatného není platný.K redundanci dochází, pokud zadáte více než jednu metodu ověřování. Pokud je chyba InvalidAuthorization, stavový kód HTTP je 401. |
| Nedostatečná autorizace | AuthorizationDisabled AuthorizationExpired |
Bing vrátí InsufficientAuthorization, pokud volající nemá oprávnění pro přístup k prostředku. K tomu může dojít v případě, že je klíč předplatného zakázaný nebo vypršela jeho platnost. Pokud je chyba InsufficientAuthorization, stavový kód HTTP je 403. |
Kódy trhu
/news/search Následující tabulka uvádí hodnoty kódu trhu, které můžete použít k zadání parametru mkt dotazu. Bing vrací obsah jenom pro tyto trhy. Seznam se může změnit.
Seznam kódů zemí, které můžete zadat v parametru cc dotazu, najdete v tématu Kódy zemí.
| Země/oblast | Jazyk | Kód trhu |
|---|---|---|
| Dánsko | Dánština | da-DK |
| Rakousko | Němčina | de-AT |
| Belgie | Nizozemština | nl-BE |
| Švýcarsko | Němčina | de-CH |
| Německo | Němčina | de-DE |
| Austrálie | Angličtina | en-AU |
| Kanada | Angličtina | en-CA |
| Spojené království | Angličtina | en-GB |
| Indonésie | Angličtina | en-ID |
| Irsko | Angličtina | en-IE |
| Indie | Angličtina | en-IN |
| Malajsie | Angličtina | en-MY |
| Nový Zéland | Angličtina | en-NZ |
| Filipínská republika | Angličtina | en-PH |
| Singapur | Angličtina | en-SG |
| USA | Angličtina | en-US |
| Angličtina | obecné | en-WW |
| Angličtina | obecné | en-XA |
| Jižní Afrika | Angličtina | en-ZA |
| Argentina | Španělština | es-AR |
| Chile | Španělština | es-CL |
| Španělsko | Španělština | es-ES |
| Mexiko | Španělština | es-MX |
| USA | Španělština | es-US |
| Španělština | obecné | es-XL |
| Finsko | Finština | fi-FI |
| Francie | Francouzština | fr-BE |
| Kanada | Francouzština | fr-CA |
| Švýcarsko | Francouzština | fr-CH |
| Francie | Francouzština | fr-FR |
| Itálie | Italština | it-IT |
| Hongkong – zvláštní administrativní oblast | Tradiční čínština | zh-HK |
| Tchaj-wan | Tradiční čínština | zh-TW |
| Japonsko | Japonština | ja-JP |
| Jižní Korea | Korejština | ko-KR |
| Nizozemsko | Nizozemština | nl-NL |
| Lidé Čínská republika | Čínština | zh-CN |
| Polsko | Polština | pl-PL |
| Brazílie | Portugalština | pt-BR |
| Rusko | Ruština | ru-RU |
| Švédsko | Švédština | sv-SE |
| Turecko | Turečtina | tr-TR |
/news Pro koncový bod jsou v následující tabulce uvedeny hodnoty kódu trhu, které můžete použít k zadání parametru mkt dotazu. Bing vrací obsah jenom pro tyto trhy. Seznam se může změnit.
Seznam kódů zemí, které můžete zadat v parametru cc dotazu, najdete v tématu Kódy zemí.
| Země/oblast | Jazyk | Kód trhu |
|---|---|---|
| Dánsko | Dánština | da-DK |
| Německo | Němčina | de-DE |
| Austrálie | Angličtina | en-AU |
| Spojené království | Angličtina | cs-CZ |
| USA | Angličtina | en-US |
| Angličtina | obecné | en-WW |
| Chile | Španělština | es-CL |
| Mexiko | Španělština | es-MX |
| USA | Španělština | es-US |
| Finsko | Finština | fi-FI |
| Kanada | Francouzština | fr-CA |
| Francie | Francouzština | fr-FR |
| Itálie | Italština | it-IT |
| Portugalština | Brazílie | pt-BR |
| Lidé Čínská republika | Čínština | zh-CN |
/news/trendingtopics Následující tabulka uvádí hodnoty kódu trhu, které můžete použít k zadání parametru mkt dotazu. Bing vrací obsah jenom pro tyto trhy. Seznam se může změnit.
Seznam kódů zemí, které můžete zadat v parametru cc dotazu, najdete v tématu Kódy zemí.
| Země/oblast | Jazyk | Kód trhu |
|---|---|---|
| Německo | Němčina | de-DE |
| Austrálie | Angličtina | en-AU |
| Spojené království | Angličtina | cs-CZ |
| USA | Angličtina | en-US |
| Kanada | Angličtina | en-CA |
| Indie | Angličtina | en-IN |
| Francie | Francouzština | fr-FR |
| Kanada | Francouzština | fr-CA |
| Portugalština | Brazílie | pt-BR |
| Lidé Čínská republika | Čínština | zh-CN |
Kódy zemí
Níže jsou uvedené kódy zemí, které můžete zadat v parametru cc dotazu. Seznam se může změnit.
| Země/oblast | Kód země |
|---|---|
| Argentina | AR |
| Austrálie | AU |
| Rakousko | AT |
| Belgie | BE |
| Brazílie | BR |
| Kanada | CA |
| Chile | CL |
| Dánsko | DK |
| Finsko | FI |
| Francie | FR |
| Německo | DE |
| Hongkong – zvláštní administrativní oblast | HK |
| Indie | IN |
| Indonésie | ID |
| Itálie | IT |
| Japonsko | JP |
| Jižní Korea | KR |
| Malajsie | MY |
| Mexiko | MX |
| Nizozemsko | NL |
| Nový Zéland | NZ |
| Norsko | NO |
| Čínská lidová republika | CN |
| Polsko | PL |
| Portugalsko | PT |
| Filipínská republika | PH |
| Rusko | RU |
| Saúdská Arábie | SA |
| Jižní Afrika | ZA |
| Španělsko | ES |
| Švédsko | SE |
| Švýcarsko | CH |
| Tchaj-wan | TW |
| Turecko | TR |
| Spojené království | GB |
| USA | USA |
Jazyky podporované Bingem
Níže jsou uvedené jazyky podporované Službou Bing, které můžete zadat v parametru setLang dotazu. Seznam se může změnit.
| Podporované jazyky | Kód jazyka |
|---|---|
| Arabština | ar ar |
| Baskičtina | Eu |
| Bengálština | Bn |
| Bulharština | Bg |
| Katalánština | Ca |
| Čínština (zjednodušená) | zh-hans |
| Čínština (tradiční) | zh-hant |
| Chorvatština | hod |
| Čeština | Cs |
| Dánština | Da |
| Holandština | Nl |
| angličtina | en |
| English-United Království | cs-CZ |
| Estonština | Et |
| Finština | Fi |
| Francouzština | Fr |
| Galicijština | Gl |
| Němčina | De |
| Gudžarátština | Gu |
| Hebrejština | hej, |
| Hindština | dobrý den |
| Maďarština | Hu |
| Islandština | is |
| Italština | je to |
| Japonština | Jp |
| Kannadština | kn |
| Korejština | Ko |
| Lotyština | Lv |
| Litevština | lt |
| Malajština | Paní |
| Malajalámština | ml |
| Maráthština | Pan |
| Norština (Bokmål) | Nb |
| Polština | Pl |
| Portugalština (Brazílie) | pt-br |
| Portugalština (Portugalsko) | pt-pt |
| Paňdžábština | Pa |
| Rumunština | Ro |
| Ruština | Ru |
| Srbština (Cyrylic) | Sr |
| Slovenština | Sk |
| Slovinština | Sl |
| španělština | es |
| Švédština | sv |
| Tamilština | ta |
| Telugština | Te |
| Thajština | Th |
| Turečtina | Tr |
| Ukrajinština | Uk |
| Vietnamština | Vi |