Introduction - Bing



right25908000Schema Tabular Documentation for Bing Search APIIntroductionThe Bing Search API offers multiple source types, or types of search results, that correspond to the service operations Web, Image, Video, News, RelatedSearch, and SpellingSuggestions. You can request a single source type or multiple source types with each query.This document provides the following information about source types: the search URL, input parameters, results, and options for input parameters.Note: This service supports fixed queries. Some queries may include required input parameters. For more information about query types, see Fixed and Flexible Query Types.Contents TOC \o "1-3" \h \z \u Introduction PAGEREF _Toc324439339 \h 1Search URL PAGEREF _Toc324439340 \h 4Bing Search API Data: input parameters and results PAGEREF _Toc324439341 \h 6Web service operation PAGEREF _Toc324439342 \h 6Input parameters PAGEREF _Toc324439343 \h 6Results PAGEREF _Toc324439344 \h 8Image service operation PAGEREF _Toc324439345 \h 8Input parameters PAGEREF _Toc324439346 \h 8Results PAGEREF _Toc324439347 \h 10Video service operation PAGEREF _Toc324439348 \h 11Input parameters PAGEREF _Toc324439349 \h 11Results PAGEREF _Toc324439350 \h 14News service operation PAGEREF _Toc324439351 \h 15Input parameters PAGEREF _Toc324439352 \h 15Results PAGEREF _Toc324439353 \h 18RelatedSearch service operation PAGEREF _Toc324439354 \h 18Input parameters PAGEREF _Toc324439355 \h 18Results PAGEREF _Toc324439356 \h 20SpellingSuggestions service operation PAGEREF _Toc324439357 \h 20Input parameters PAGEREF _Toc324439358 \h 20Results PAGEREF _Toc324439359 \h 22Bing Search API Data - Web Results Only: input parameters and results PAGEREF _Toc324439360 \h 22Web service operation PAGEREF _Toc324439361 \h 22Input parameters PAGEREF _Toc324439362 \h 22Results PAGEREF _Toc324439363 \h 24Options for input parameters PAGEREF _Toc324439364 \h 24Adult PAGEREF _Toc324439365 \h 25ImageFilters PAGEREF _Toc324439366 \h 25Market PAGEREF _Toc324439367 \h 26NewsCategory PAGEREF _Toc324439368 \h 29NewsSortOption PAGEREF _Toc324439369 \h 30VideoFilters PAGEREF _Toc324439370 \h 30VideoSortOption PAGEREF _Toc324439371 \h 31WebFileType PAGEREF _Toc324439372 \h 31Search URLThe root URL for Bing Search API queries is . The root URL for Bing Search API (Web Results Only) queries is target a particular data source, append the service operation to the root URL. For example, if the targeted data source is "web," append the service operation Web to the end of your query URL as follows:? query URL is expressed via the Open Data Protocol (OData) specification. The differences between this specification and Bing Search API 2.0 are as follows:Because string parameters will be used to generate a URL, they must be URL encoded. So instead of being enclosed in apostrophes ('), the string parameters are surrounded by the ASCII equivalent %27. For instance:: If the query text might contain non-alphanumeric characters, you should URL encode the entire string.The names of the count and offset parameters have been changed to comply with the OData standard. Furthermore, instead of having a different query URL for each response type (JSON versus XML), a special OData parameter is used. The following table lists the OData parameters.Reserved parameterDescriptionEquivalent in Bing Search API 2.0Default valueValue rangeExample$topSpecifies the number of results to return.&count=Web: 50Image: 50Video: 50News: 15Web: 1–50Image: 1–50Video: 1–50News: 1–15;$top=10$skipSpecifies the offset requested for the starting point of results returned.&offset=Web: 0Image: 0Video: 0News: 0Web: 0–1000Image: 0–1000Video: 0–1000News: Between 0 and 1 less than the total number of results;$top=10&$skip=20$formatSpecifies the format of the OData response. Current options are Atom (for XML) or JSON.Alternative formats were accomplished with different query URLs (for example, xml.aspx and json.aspx)AtomNot applicable'Xbox'&$top=10&$skip=20&$format=ATOMFor more information about OData, visit the OData website.Note: Bing API DataMarket supports HTTP compression to save on transfer data volume and delivery. To enable HTTP compression, add header “Accept-Encoding: gzip” to your HTTP request. The service operations available in the Bing Search API DataMarket are listed in the following table.Service OperationEquivalent in Bing Search API 2.0ExampleWebWeb?$top=10ImageImage?$top=10VideoVideo?$top=10NewsNews?$top=10SpellingSuggestionSpell?$top=10RelatedSearchRelatedSearch?$top=10Composite;$top=1Note: To request multiple data sources in a single query, specify the service operation named “Composite” followed by its required parameter named “Sources”. The value applied to “Sources” are the name of the service operations concatenated with a + character. See the table above for an example of a single query requesting web & news. Also note that the number of results returned with the OData reserved parameter $top refer to all data sources specified in the query except News. News will always return a fixed number of 15 news results when used in a query with a Composite service operation.Bing Search API Data: input parameters and resultsWeb service operationInput parametersThe following table lists input parameters for the Web service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.WebFileTypeXLSStringNoNot applicableFile name extensions to return.For a list of values for supported file name extensions, see REF _Ref322697471 \h \* MERGEFORMAT WebFileType.ResultsThe following table lists results for the Web service operation.NameTypeDescriptionIDGuidIdentifierTitleStringText specified in the HTML <title> tag of the pageDescriptionStringDescription text of the web resultDisplayUrlStringWeb URL to display to the userUrlStringFull URL of the web resultImage service operationInput parametersThe following table lists input parameters for the Image service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.ImageFiltersSize:SmallStringNoNot applicableArray of strings that filter the response that the API sends based on size, aspect, color, style, face, or any combination thereof.For a list of the values for this parameter, see REF _Ref322698312 \h \* MERGEFORMAT ImageFilters.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.ResultsThe following table lists results for the Image service operation.NameTypeDescriptionIDGuidIdentifierTitleStringTitle of the imageMediaUrlStringURL of the full-size imageSourceUrlStringURL of the website that contains a returned imageDisplayUrlStringURL that is displayed on the search results pageWidthInt32Width of the full-size image in pixels, if availableHeightInt32Height of the full-size image in pixels, if availableFileSizeInt64Size of the full-size image file in bytes, if availableContentTypeStringMIME type of an image, if availableThumbnailThumbnailThumbnail properties of the multimedia elementVideo service operationInput parametersThe following table lists input parameters for the Video service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.VideoFiltersDuration:ShortStringNoNot applicableArray of strings that filter the response that the API sends based on duration, aspect, resolution, or any combination thereof.In the query URL, you use a plus sign (+) to indicate multiple filters. For example: videofilters=Aspect:Standard+Duration:ShortFor a list of the values for this parameter, see REF _Ref322700241 \h \* MERGEFORMAT VideoFilters.Note: You cannot include more than one value for duration in the same request.VideoSortByDateStringNoVideoSortOption: Contains members that can affect the sort order of video resultsSort order of results returned.For more information about the members of the VideoSortOption enumeration, see REF _Ref322700813 \h \* MERGEFORMAT VideoSortOption.ResultsThe following table lists results for the Video service operation.NameTypeDescriptionIDGuidIdentifierTitleStringSource of the videoMediaUrlStringURL of the original videoDisplayUrlStringURL of this video from the Bing Video pageRunTimeInt32Playback length of the multimedia elementThumbnailThumbnailThumbnail properties of the multimedia elementNews service operationInput parametersThe following table lists input parameters for the News service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports. For the news source type, if a value is not specified, Bing attempts to return a selection of local news headlines.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.NewsCategoryrt_BusinessStringNoNot applicableCategory of news for which to provide results.If no results match the input provided for this parameter, Bing returns the default set of results, which is news that belongs to a mix of categories.Applicable only in the en-US market.For a list of the valid values, see REF _Ref322701435 \h \* MERGEFORMAT NewsCategory.NewsLocationOverrideUS.WAStringNoNot applicableOverrides Bing location detection. Applicable only in the en-US market.NewsSortByDateStringNoNewsSortOption: Contains members that can affect the sort order of news resultsSort order of results returned.For more information about the members of the NewsSortOption enumeration, see REF _Ref322700982 \h \* MERGEFORMAT NewsSortOption.ResultsThe following table lists results for the News service operation.NameTypeDescriptionIDGuidIdentifierTitleStringHeadline for this resultUrlStringURL of this articleSourceStringOrganization responsible for this articleDescriptionStringRepresentative sample of this resultDateDateTimeDate on which this article was indexedRelatedSearch service operationInput parametersThe following table lists input parameters for the RelatedSearch service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.ResultsThe following table lists results for the RelatedSearch service operation.NameTypeDescriptionIDGuidIdentifierTitleStringSource of the videoBingUrlStringURL of this video from the Bing Video pageSpellingSuggestions service operationInput parametersThe following table lists input parameters for the SpellingSuggestions service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxbloxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.ResultsThe following table lists results for the SpellingSuggestions service operation.NameTypeDescriptionIDGuidIdentifierValueStringValueBing Search API Data - Web Results Only: input parameters and resultsTo target the web data source, append the service operation Web to the end of your query URL as follows: service operationInput parametersThe following table lists input parameters for the Web service operation.NameSample valuesTypeRequiredEnumerationsDescriptionQueryxboxStringYesNot applicableBing search query. The query can contain any valid query text that the Bing Engine supports.AdultModerateStringNoAdultOption: Contains members that specify the level of AdultOption filtering used in this querySetting used for filtering sexually explicit content.Not specifying the level of filtering means that the API will use the default level for a particular market, which may vary per market. In addition, for certain markets, the level should not be lower than the predefined value for that market. For example, in the de-DE market, the level is always set to Strict.For more information about the levels for this parameter, see REF _Ref322696155 \h \* MERGEFORMAT Adult.Latitude47.603450DoubleNoNot applicableLatitude (north/south coordinate).Valid input values range from –90 to 90.Longitude-122.329696DoubleNoNot applicableLongitude (east/west coordinate).Valid input values range from –180 to 180.Marketen-USStringNoNot applicableMarket.If the parameter is not specified, the API attempts to determine an applicable market through the use of logic such as the IP address of the request, cookies, and other elements.For a list of the markets, see REF _Ref322696714 \h \* MERGEFORMAT Market.Note: Not all sources support all markets.WebFileTypeXLSStringNoNot applicableFile name extensions to return.For a list of values for supported file name extensions, see REF _Ref322697471 \h \* MERGEFORMAT WebFileType.ResultsThe following table lists results for the Web service operation.NameTypeDescriptionIDGuidIdentifierTitleStringText specified in the HTML <title> tag of the pageDescriptionStringDescription text of the web resultDisplayUrlStringWeb URL to display to the userUrlStringFull URL of the web resultOptions for input parametersThe following sections describe members and values that you can use to customize input parameters.AdultMembers of the Adult parameter specify the level of AdultOption filtering used in the query.Member name Description Off Specifies that filtering is not used in a queryModerate Specifies that results of a query should not include sexually explicit images or videos, but may include sexually explicit textStrict Specifies that results of a query should not include sexually explicit text, images, or videosImageFiltersValues of the ImageFilters parameter restrict results.Value Restricts results to images Size:Small Small in sizeSize:Medium Medium in sizeSize:Large Large in sizeSize:Height:<Height>Of the specified height in pixels, where <Height> is an unsigned int value Size:Width:<Width>Of the specified width in pixels, where <Width> is an unsigned int valueAspect:Square That have standard aspect ratioAspect:Wide That have widescreen aspect ratioAspect:Tall That have tall aspect ratioColor:Color That are in colorColor:MonochromeThat are black and whiteStyle:Photo That contain photosStyle:Graphics That contain graphics or illustrationsFace:Face That contain facesFace:Portrait That contain portraits (head and shoulders)Face:Other That are different from the other Face categoriesMarketValues of the Market parameter indicate languages and countries/regions.Market name LanguageCountry/region ar-XAArabicArabiabg-BGBulgarianBulgariacs-CZCzechCzech Republicda-DKDanishDenmarkde-ATGermanAustriade-CHGermanSwitzerlandde-DEGermanGermanyel-GRGreekGreeceen-AUEnglishAustraliaen-CAEnglishCanadaen-GBEnglishUnited Kingdomen-IDEnglishIndonesiaen-IEEnglishIrelanden-INEnglishIndiaen-MYEnglishMalaysiaen-NZEnglishNew Zealanden-PHEnglishPhilippinesen-SGEnglishSingaporeen-USEnglishUnited Statesen-XAEnglishArabiaen-ZAEnglishSouth Africaes-ARSpanishArgentinaes-CLSpanishChilees-ESSpanishSpaines-MXSpanishMexicoes-USSpanishUnited Stateses-XLSpanishLatin Americaet-EEEstonianEstoniafi-FIFinnishFinlandfr-BEFrenchBelgiumfr-CAFrenchCanadafr-CHFrenchSwitzerlandfr-FRFrenchFrancehe-ILHebrewIsraelhr-HRCroatianCroatiahu-HUHungarianHungaryit-ITItalianItalyja-JPJapaneseJapanko-KRKoreanKorealt-LTLithuanianLithuanialv-LVLatvianLatvianb-NONorwegianNorwaynl-BEDutchBelgiumnl-NLDutchNetherlandspl-PLPolishPolandpt-BRPortugueseBrazilpt-PTPortuguesePortugalro-RORomanianRomaniaru-RURussianRussiask-SKSlovakSlovak Republicsl-SLSlovenianSloveniasv-SESwedishSwedenth-THThaiThailandtr-TRTurkishTurkeyuk-UAUkrainianUkrainezh-CNChineseChinazh-HKChineseHong Kong SARzh-TWChineseTaiwanNewsCategoryValid values for the NewsCategory parameter include:rt_Business rt_Entertainment rt_Health rt_Politics rt_Sports rt_US rt_World rt_ScienceAndTechnology NewsSortOptionMembers of the NewsSortOption enumeration affect the sort order of news results.Member name Description Date Specifies that news results be returned in chronological orderRelevance Specifies that news results be returned by relevance of the response to the queryVideoFiltersValues of the VideoFilters parameter restrict results.Value Restricts results to videos Duration:Short The runtime of which is less than 300 seconds Duration:Medium The runtime of which is between 300 seconds and 12,000 seconds Duration:Long The runtime of which is greater than 12,000 seconds Aspect:Standard That have standard aspect ratioAspect:Widescreen That have widescreen aspect ratioResolution:Low That have low resolutionResolution:Medium That have medium resolutionResolution:High That have high resolutionVideoSortOptionMembers of the VideoSortOption enumeration affect the sort order of video results.Member name Description Date Specifies that video results be returned in chronological orderRelevance Specifies that video results be returned by relevance of the response to the queryWebFileTypeValues of the WebFileType parameter are based on supported file name extensions.File type Value Microsoft Word DocumentDOCAutodesk Drawing FileDWFReally Simple Syndication (RSS) FeedFEEDHypertext Markup Language (.htm) FileHTMHypertext Markup Language (.html) FileHTMLAdobe Acrobat Portable DocumentPDFMicrosoft PowerPoint PresentationPPTMicrosoft Rich Text Format DocumentRTFGeneric Text (.text) FileTEXTGeneric Text (.txt) FileTXTMicrosoft Excel WorkbookXLS ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download