快速入門:傳送查詢至以 C# 撰寫的 Bing 當地商家搜尋 API
警告
2020 年 10 月 30 日,Bing 搜尋 API 已從 Azure AI 服務移至Bing 搜尋服務。 本文件僅供參考之用。 如需更新的文件,請參閱 Bing 搜尋 API 文件。 如需針對 Bing 搜尋建立新 Azure 資源的指示,請參閱透過 Azure Marketplace 建立 Bing 搜尋資源。
使用此快速入門了解如何向 Bing 當地企業搜尋 API 傳送要求,該 API 是 Azure 認知服務。 雖然此簡單應用程式是以 C# 撰寫,但 API 是一種與任何程式語言相容的 RESTful Web 服務,可產生 HTTP 要求,並剖析 JSON。
此範例應用程式會從 API 取得搜尋查詢的當地回應資料。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- 任何版本的 Visual Studio 2019。
- 如果您使用 Linux/MacOS,則可以使用 Mono 來執行此應用程式。
- 擁有 Azure 訂用帳戶之後,在 Azure 入口網站中建立 Bing 搜尋資源 ,以取得您的金鑰和端點。 在其部署後,按一下 [前往資源]。
建立要求
下列程式碼會建立 WebRequest
、設定存取金鑰標頭,並新增 "restaurant in Bellevue" 的查詢字串。 接著,它會傳送要求,並為字串指派包含 JSON 文字的回應。
// Replace the accessKey string value with your valid access key.
const string accessKey = "enter key here";
const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/localbusinesses/search";
const string searchTerm = "restaurant in Bellevue";
// Construct the URI of the search request
var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(searchQuery) + mkt=en-us;
// Run the Web request and get response.
WebRequest request = HttpWebRequest.Create(uriQuery);
request.Headers["Ocp-Apim-Subscription-Key"] = accessKey;
HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
string json = new StreamReader(response.GetResponseStream()).ReadToEnd();
執行完整應用程式
下列程式碼會使用 Bing 當地企業搜尋 API,從 Bing 搜尋引擎傳回本地化的搜尋結果。 您可以依照下列步驟執行此程式碼:
- 在 Visual Studio 中建立新的主控台解決方案 (Community Edition 即足夠使用)。
- 將 Program.cs 取代為下面提供的程式碼。
- 以訂用帳戶有效的存取金鑰來取代
accessKey
值。 - 執行程式。
using System;
using System.Collections.Generic;
using System.Text;
using System.Net;
using System.IO;
namespace localSearch
{
class Program
{
// **********************************************
// *** Update or verify the following values. ***
// **********************************************
// Replace the accessKey string value with your valid access key.
const string accessKey = "enter key here";
const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/localbusinesses/search";
const string searchTerm = "restaurant in Bellevue";
// Returns search results including relevant headers
struct SearchResult
{
public String jsonResult;
public Dictionary<String, String> relevantHeaders;
}
static void Main()
{
Console.OutputEncoding = System.Text.Encoding.UTF8;
Console.WriteLine("Searching locally for: " + searchTerm);
SearchResult result = BingLocalSearch(searchTerm, accessKey);
Console.WriteLine("\nRelevant HTTP Headers:\n");
foreach (var header in result.relevantHeaders)
Console.WriteLine(header.Key + ": " + header.Value);
Console.WriteLine("\nJSON Response:\n");
Console.WriteLine(JsonPrettyPrint(result.jsonResult));
Console.Write("\nPress Enter to exit ");
Console.ReadLine();
}
/// <summary>
/// Performs a Bing Local business search and return the results as a SearchResult.
/// </summary>
static SearchResult BingLocalSearch(string searchQuery, string key)
{
// Construct the URI of the search request
var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(searchQuery) + "&mkt=en-us";
// Perform the Web request and get the response
WebRequest request = HttpWebRequest.Create(uriQuery);
request.Headers["Ocp-Apim-Subscription-Key"] = key;
HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
string json = new StreamReader(response.GetResponseStream()).ReadToEnd();
// Create result object for return
var searchResult = new SearchResult();
searchResult.jsonResult = json;
searchResult.relevantHeaders = new Dictionary<String, String>();
// Extract Bing HTTP headers
foreach (String header in response.Headers)
{
if (header.StartsWith("BingAPIs-") || header.StartsWith("X-MSEdge-"))
searchResult.relevantHeaders[header] = response.Headers[header];
}
return searchResult;
}
/// <summary>
/// Formats the given JSON string by adding line breaks and indents.
/// </summary>
/// <param name="json">The raw JSON string to format.</param>
/// <returns>The formatted JSON string.</returns>
static string JsonPrettyPrint(string json)
{
if (string.IsNullOrEmpty(json))
return string.Empty;
json = json.Replace(Environment.NewLine, "").Replace("\t", "");
StringBuilder sb = new StringBuilder();
bool quote = false;
bool ignore = false;
int offset = 0;
int indentLength = 3;
foreach (char ch in json)
{
switch (ch)
{
case '"':
if (!ignore) quote = !quote;
break;
case '\'':
if (quote) ignore = !ignore;
break;
}
if (quote)
sb.Append(ch);
else
{
switch (ch)
{
case '{':
case '[':
sb.Append(ch);
sb.Append(Environment.NewLine);
sb.Append(new string(' ', ++offset * indentLength));
break;
case '}':
case ']':
sb.Append(Environment.NewLine);
sb.Append(new string(' ', --offset * indentLength));
sb.Append(ch);
break;
case ',':
sb.Append(ch);
sb.Append(Environment.NewLine);
sb.Append(new string(' ', offset * indentLength));
break;
case ':':
sb.Append(ch);
sb.Append(' ');
break;
default:
if (ch != ' ') sb.Append(ch);
break;
}
}
}
return sb.ToString().Trim();
}
}
}