News Search API v7 リファレンス

警告

Bing Search API は、Cognitive Services から Bing Search Services に移行されます。 2020 年 10 月 30 日以降、Bing Search の新しいインスタンスは、こちらに記載されているプロセスに従ってプロビジョニングする必要があります。 Cognitive Services を使用してプロビジョニングされた Bing Search API は、次の 3 年間、または Enterprise Agreement の終わり (どちらか先に発生した方) までサポートされます。 移行手順については、Bing Search Services に関する記事を参照してください。

News Search API を使用すると、検索クエリをBingに送信し、関連するニュース記事の一覧を取得できます。 このセクションでは、ニュース記事の要求に使用するクエリ パラメーターとヘッダー、およびそれらを含む JSON 応答オブジェクトに関する技術的な詳細について説明します。 要求の作成方法を示す例については、「 Web でニュースを検索する」を参照してください。

要求に含める必要があるヘッダーの詳細については、「 要求ヘッダー」を参照してください。

要求に含める必要があるクエリ パラメーターの詳細については、「 クエリ パラメーター」を参照してください。

応答に含まれる可能性がある JSON オブジェクトの詳細については、「 応答オブジェクト」を参照してください。

許可された使用と結果の表示については、「 search API の使用と表示の要件Bing」を参照してください。

Note

URL の書式とパラメーターは、予告なしで変更されることがあるため、すべての URL をそのまま使用してください。 明記されている場合を除いて、URL の書式またはパラメーターに依存しないでください。

エンドポイント

ニュース記事を要求するには、次のいずれかの URL に GET 要求を送信します。

URL 説明
https://api.cognitive.microsoft.com/bing/v7.0/news カテゴリ別に上位のニュース記事を返します。 たとえば、上位のスポーツやエンターテイメントの記事を要求できます。 カテゴリの指定の詳細については、category クエリ パラメーターに関する ページ を参照してください。
https://api.cognitive.microsoft.com/bing/v7.0/news/search ユーザーの検索クエリに基づいてニュース記事を返します。 検索クエリが空の場合、呼び出しではトップ ニュース記事が返されます。
https://api.cognitive.microsoft.com/bing/v7.0/news/trendingtopics ソーシャル ネットワークで現在トレンドになっているトレンドニューストピックを返します。

メモ: en-US および zh-CN 市場でのみ使用できます。

マルチサービス サブスクリプションの場合は、URL にリージョンを含める必要があります。 例: westus.api.cognitive.microsoft.com。 「サポートされているリージョン」を参照してください。

要求では HTTPS プロトコルを使用する必要があります。HTTP はサポートされていません。

注意

URL の最大長は 2,048 文字です。 URL の長さが上限を超えないよう、クエリ パラメーターの最大長は 1,500 文字未満にする必要があります。 URL が 2,048 文字を超えた場合、サーバーが 404 Not found を返します。

ヘッダー

要求と応答に含まれる可能性があるヘッダーを次に示します。

ヘッダー 説明
Accept 省略可能な要求ヘッダー。

既定のメディアの種類は application/json です。 応答で JSON-LD が使用されるよう指定するには、Accept ヘッダーを application/ld+json に設定します。
Accept-Language 省略可能な要求ヘッダー。

ユーザー インターフェイス文字列に使用する言語のコンマ区切りリストです。 リストでは優先度の高いものから順に指定します。 有効な形式など、詳細については RFC2616 を参照してください。

このヘッダーと setLang クエリ パラメーターは相互に排他的なので、両方は指定しないでください。

このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。 結果が返される市場を特定するために、Bing によってリストから検出された最初のサポート対象言語が使用され、それが cc パラメーター値と組み合わされます。 サポート対象言語がリストに含まれていない場合、要求がサポートされる最も近い言語と市場が Bing によって検出されるか、集計された市場または既定の市場が結果に使用されます。 Bing によって使用された市場を確認するには、BingAPIs-Market ヘッダーを調べます。

このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用します。 それ以外の場合は、mkt クエリ パラメーターおよび setLang クエリ パラメーターを使用します。

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。 応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。
BingAPIs-Market 応答ヘッダー。

要求で使用された市場。 形式は <languageCode>-<countryCode> です。 たとえば、en-US などです。

市場コードに記載されていない市場を指定した場合、この値は mkt クエリ パラメーターで指定した市場と異なる場合があります。 cc Accept-Language の値を調整できない値を指定した場合も同様です。
BingAPIs-TraceId 応答ヘッダー。

要求の詳細が含まれたログ エントリの ID。 エラーが発生した場合、この ID をキャプチャします。 問題を特定して解決できない場合は、その他の情報と共にこの ID をサポート チームに提供します。
Ocp-Apim-Subscription-Key 必須の要求ヘッダー。

Cognitive Services でこのサービスにサインアップしたときに受け取ったサブスクリプション キーです。
Pragma 省略可能な要求ヘッダー

既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。 キャッシュされたコンテンツを防ぐには、Pragma ヘッダーをキャッシュなし (Pragma: no-cache など) に設定します。
Retry-After 応答ヘッダー。

1 秒あたりに許可されるクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) を超えた場合、応答にはこのヘッダーが含まれます。 ヘッダーには、別の要求を送信する前に待機する必要がある秒数が含まれています。
User-Agent 省略可能な要求ヘッダー。

要求送信元のユーザー エージェント。 Bing では、モバイル ユーザーに最適なエクスペリエンスを提供するためにユーザー エージェントが使用されます。 省略可能ですが、このヘッダーは常に指定することをお勧めします。

ユーザーエージェントは、よく使用されるブラウザーによって送信されるのと同じ文字列にする必要があります。 ユーザー エージェントについては、RFC 2616 を参照してください。

ユーザーエージェント文字列の例を次に示します。
  • Windows Phone - Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)

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

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

  • iPad - Mozilla/5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID 省略可能な要求および応答ヘッダー。

このヘッダーは、Bing API の呼び出し間で一貫性のある動作をユーザーに提供するために Bing によって使用されます。 Bing によって、新しい機能と改善点が頻繁にフライト化されます。そして、トラフィックを異なるフライトに割り当てるためのキーとして、クライアント ID が使用されます。 複数の要求に対してユーザーの同じクライアント ID を使用しないと、ユーザーが複数の競合するフライトに割り当てられる可能性があります。 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスの一貫性がなくなる場合があります。 たとえば、2 番目の要求に 1 番目とは異なるフライトが割り当てられていると、エクスペリエンスが予期しないものになる可能性があります。 また、Bingはクライアント ID を使用して、そのクライアント ID の検索履歴に合わせて Web 結果を調整し、ユーザーに豊富なエクスペリエンスを提供できます。

このヘッダーは、クライアント ID で生成されたアクティビティを分析して結果の順位付けを向上させるために Bing によって使用されることもあります。 関連性の向上は、Bing API によって提供される結果の品質向上に役立ち、API コンシューマーのクリックスルー率の向上を実現します。

重要: このヘッダーは省略可能ですが、必須であると考える必要があります。 同じエンド ユーザーとデバイスの組み合わせによる複数の要求に対してクライアント ID を保持することで、1) API コンシューマーが一貫性のあるユーザー エクスペリエンスを受け取ることができ、2) Bing API からの結果の品質向上を通じてクリックスルー率の向上が実現します。

このヘッダーに適用される基本的な使用規則を次に示します。
  • デバイスでアプリケーションを使用する各ユーザーは、Bing によって生成された一意のクライアント ID を持っている必要があります。

    このヘッダーを要求に含めない場合、Bing によって ID が生成され、それが X-MSEdge-ClientID 応答ヘッダーで返されます。 このヘッダーを要求に含めるべきでない唯一の場合は、ユーザーがそのデバイスでアプリを初めて使用するときです。

  • 注意: このクライアント ID は認証可能なユーザー アカウント情報にリンクできないようにする必要があります。

  • そのユーザーのためにアプリによってデバイスで実行される各 Bing API 要求で、クライアント ID を使用します。

  • クライアント ID を保持します。 ブラウザー アプリで ID を永続化するには、永続的な HTTP Cookie を使用して ID がすべてのセッションで確実に使用されるようにします。 セッション Cookie は使用しないようにしてください。 モバイル アプリなど、他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。

    次にそのデバイスでユーザーがアプリを使用するときに、保持したクライアント ID を取得します。

注: Bing の応答には、このヘッダーが含まれる場合と含まれない場合があります。 このヘッダーが応答に含まれる場合、クライアント ID をキャプチャして、ユーザーのためにそのデバイスで実行される後続のすべての Bing 要求でそれを使用します。

注: X-MSEdge-ClientID を含める場合、要求には Cookie を含めないようにしてください。
X-MSEdge-ClientIP 省略可能な要求ヘッダー。

クライアント デバイスの IPv4 アドレスまたは IPv6 アドレス。 IP アドレスは、ユーザーの位置情報の検出に使用されます。 位置情報は、安全な検索動作を決定するために Bing によって使用されます。

注: 省略可能ですが、このヘッダーと X-Search-Location ヘッダーは常に指定することをお勧めします。

(最後のオクテットを 0 に変更するなど) アドレスを難読化しないようにしてください。 アドレスを難読化すると、デバイスの実際の場所から離れた場所が検出され、Bing から誤った結果が提供される可能性があります。
X-Search-Location 省略可能な要求ヘッダー。

クライアントの地理的な場所を示す、キーと値のペアのセミコロン区切りリストです。 位置情報は、安全な検索動作を決定して関連するローカル コンテンツを返すために、Bing によって使用されます。 キーと値のペアは、<キー>:<値> の形式で指定します。 ユーザーの場所の指定に使用するキーは次のとおりです。

  • lat—必須。 クライアントの場所の緯度です (度単位)。 緯度は、-90.0 以上、+90.0 以下である必要があります。 負の値は南半球の緯度を示し、正の値は北半球の緯度を示します。

  • long—必須。 クライアントの場所の経度です (度単位)。 経度は、-180.0 以上、+180.0 以下である必要があります。 負の値は西半球の経度を示し、正の値は東半球の経度を示します。

  • re—必須。 座標の水平方向の精度を指定する半径 (m) です。 デバイスの位置情報サービスによって返される値を渡します。 一般的な値は、GPS/Wi-Fi の 22 m、携帯電話基地局の三角測量の 380 m、IP 逆引き参照の 18,000 m などです。

  • ts—省略可能。 クライアントがその場所にいたときの UTC UNIX タイムスタンプです。 (UNIX タイムスタンプは、1970 年 1 月 1 日からの経過秒数です)。

  • head - 省略可能。 クライアントの相対的な先頭方向または移動方向。 移動方向は、真北を基準として時計回りに 0 から 360 度で指定します。 このキーは、sp キーが 0 以外の場合にのみ指定します。

  • sp—省略可能。 クライアント デバイスが移動している水平方向の速度 (m/秒) です。

  • alt—省略可能。 クライアント デバイスの高度 (m) です。

  • are - 省略可能。 座標の垂直方向の精度を指定する半径 (m)。 このキーは、alt キーを指定する場合にのみ指定します。

  • disp — 省略可能。 disp:<City、State> という形式のユーザーの地理的な場所。 たとえば、disp:Seattle、Washington などです。 これは、lat/long キーを使用して指定したユーザーの場所の表示テキスト バージョンです。 この値が緯度/長座標と競合する場合、Bingは disp 値をユーザーの位置として使用します。

メモ: クエリに場所が含まれている場合、Bingはこのヘッダーを無視します。 たとえば、このヘッダーにユーザーの場所がサンフランシスコとして反映されているが、クエリが seattle のレストランである場合、Bingはワシントン州シアトルにあるレストランを返します。

注: 多くのキーは省略可能ですが、提供する情報が多いほど、場所の結果の正確さが増します。

注: 省略可能ですが、ユーザーの地理的な場所は常に指定することをお勧めします。 位置情報を提供することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントによって VPN が使用されている場合) に特に重要です。 最適な結果を得るには、このヘッダーと X-Search-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。

注意

利用規約ですべての該当法規 (これらのヘッダーの使用に関するものなど) への準拠が要求されていることに注意してください。 たとえば、ヨーロッパなどの特定の地域では、特定の追跡デバイスをユーザー デバイスに組み込む前に、ユーザーの同意を得る必要があります。

クエリ パラメーター

要求に含めることができるクエリ パラメーターを次に示します。 必須列は、パラメーターを指定する必要があるかどうかを示します。 クエリ パラメーターの値を URL エンコードする必要があります。

Name 種類 必須
cc 結果を取得する国の 2 文字の国番号です。 使用可能な値の一覧については、「 市場コード」を参照してください。

このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bingは、指定した言語で検索された最初のサポートされている言語を使用し、それを国コードと組み合わせて、結果を返す市場を決定します。 言語一覧にサポートされている言語が含まれない場合、Bing は要求をサポートする最も近い言語と市場を検索します。 または、Bing結果に集計された市場または既定の市場を使用できます。

複数の言語を指定する場合にのみ、 Accept-Language このクエリ パラメーターと ヘッダーを使用します。 それ以外の場合は、 パラメーターと setLang クエリ パラメーターを使用するmkt必要があります。

このパラメーターと mkt クエリ パラメーターは相互に排他的なので、両方指定することはできません。
String いいえ
カテゴリ 返す記事のカテゴリ。 たとえば、スポーツ記事やエンターテイメント記事などです。 使用可能なカテゴリの一覧については、「 市場別のニュース カテゴリ」を参照してください。

このパラメーターは、ニュース カテゴリ要求でのみ使用します (/news エンドポイントを参照)。

このパラメーターを指定しない場合、応答には次の両方が含まれます。
  • 見出し記事は通常、どのカテゴリからでも過去 24 時間以内に公開されますが、一部の記事は古い可能性があります。

    記事が見出しの場合、記事の 見出し フィールドは true に設定されます。 既定では、応答には最大 12 個のヘッドライン記事とクラスターが含まれます。 返す見出し記事の数を指定するには、クエリ パラメーターを headlineCount 設定します。

  • 各親カテゴリの記事 (各カテゴリの最大 4 つの記事とクラスター)。

指定 headlineCount せず、市場で 8 つのカテゴリがサポートされている場合、応答には最大 44 個の記事とクラスター (12 個の見出し記事とクラスターに加えて、32 個のカテゴリ固有の記事とクラスター) が含まれます。 クラスターには複数のアーティクルが含まれているため、この例のアーティクルの数 (44) が多い可能性があります。 たとえば、回答には 11 個の見出し記事と 1 つのクラスターが含まれる場合があります。これには、4 つの関連する見出し記事が含まれており、合計で 15 の見出し記事が含まれます。
String いいえ
count 応答で返されるニュース記事の数。 配信される実際の数は、要求した数よりも少ない可能性があります。 既定値は 10 で、最大値は 100 です。

トレンドトピックの場合、既定値はすべてのトレンドニューストピック(約55記事)です。

このパラメーターは、 パラメーターと共に offset 使用して結果をページングできます。 たとえば、ユーザー インターフェイスに 1 ページあたり 20 個のアーティクルが表示される場合、結果の最初のページを取得するには 20 と offset 0 に設定countします。 後続のページごとに、20 ずつインクリメント offset します (0、20、40 など)。 複数のページで結果に重複を含めることができます。

メモ: クラスターは 1 つの項目としてカウントされます。 たとえば、カウントを 10 に設定した場合、応答には 9 つのアーティクルと 1 つのクラスターが含まれることがありますが、クラスターには 5 つのアーティクルが含まれる場合があります。

メモ: ニュース カテゴリを要求する場合は、category パラメーターを指定する場合にのみ、このパラメーターを指定します。 category パラメーターを指定しない場合、Bingはこのパラメーターを無視します。
UnsignedShort いいえ
鮮度 次の年齢値でニュース記事をフィルター処理します。
  • Day - 過去 24 時間以内に検出Bingニュース記事を返します
  • 週 — 過去 7 日以内に検出Bingニュース記事を返します
  • 月 - 過去 30 日以内に検出Bingニュース記事を返します
String いいえ
headlineCount 返すヘッドライン記事とクラスターの数。 既定値は 12 です。

category パラメーターを指定しない場合にのみ、このパラメーターを指定します。 category パラメーターを指定すると、Bingはこのパラメーターを無視します。

このパラメーターは、ニュース カテゴリ要求でのみ使用します。
UnsignedShort いいえ
mkt 結果の取得元の市場。 通常は、 mkt ユーザーが要求を行っている国です。 ただし、ユーザーが結果を提供する国にいない場合は、別の国Bing可能性があります。 マーケットは、言語コードと国コード><>の形式<である必要があります。 たとえば、en-US などです。 文字列では大文字と小文字が区別されません。 使用可能な市場価値の一覧については、「 市場コード」を参照してください。

メモ: 既知の場合は、常に市場を指定することをお勧めします。 市場を指定すると、Bing が要求をルーティングして最適な応答を返すのに役立ちます。 市場コードに記載されていない市場を指定した場合、Bingは、変更される可能性がある内部マッピングに基づいて最適な市場コードを使用します。

このパラメーターと cc クエリ パラメーターは相互に排他的なので、両方指定することはできません。
String いいえ
offset 記事を返す前にスキップするニュース記事の数を示す 0 から始まるオフセット。 既定値は 0 です。 オフセットは (totalEstimatedMatches - count) 未満にする必要があります。

このパラメーターを パラメーターと共に count 使用して、結果をページングします。 たとえば、ユーザー インターフェイスに 1 ページあたり 20 個のアーティクルが表示される場合、結果の最初のページを取得するには 20 と offset 0 に設定countします。 後続のページごとに、20 ずつインクリメント offset します (0、20、40 など)。 複数のページで結果に重複を含めることができます。

メモ: クラスターは 1 つの項目としてカウントされます。 たとえば、カウントを 10 に設定した場合、応答には 9 つのアーティクルと 1 つのクラスターが含まれることがありますが、クラスターには 5 つのアーティクルが含まれる場合があります。

メモ: ニュース カテゴリを要求する場合は、category パラメーターを指定する場合にのみ、このパラメーターを指定します。 category パラメーターを指定しない場合、Bingはこのパラメーターを無視します。
Unsigned Short いいえ
originalImg イメージのに、元のアーティクルの画像の contentUrl サムネイルまたは画像自体を指す URL が含まれているかどうかを決定するブール値。

アーティクルに画像が含まれており、このパラメーターが true に設定されている場合、イメージの プロパティには、発行元の contentUrl Web サイトから元のイメージをダウンロードするために使用できる URL が含まれます。 それ以外の場合、このパラメーターが false の場合、イメージの contentUrl URL と thumbnailUrl URL の両方が同じサムネイル画像を指します。

既定値は false です。

このパラメーターは、News Search API でのみ使用してください。 Web Search API を呼び出すときは、このパラメーターを指定しないでください。 傾向トピックでは、このパラメーターは無視されます。
ブール型 いいえ
q ユーザーの検索クエリ用語。 用語が空の場合 (q=など)、応答には上位のニュース 記事が含まれます。

文字列という用語には 、高度な演算子Bing含まれる場合があります。 たとえば、ニュースを特定のドメインに制限するには、 site: 演算子を使用します。

カテゴリ別にニュース記事を取得する場合は、このパラメーターを含めないでください。 傾向トピックでは、このパラメーターは無視されます。
String はい
safeSearch 成人向けコンテンツのニュース記事をフィルター処理します。 可能なフィルター値を次に示します。
  • オフ - 成人向けのテキスト、画像、またはビデオを含むニュース記事を返します。

  • Moderate - 成人向けテキストを含むニュース記事を返しますが、成人向けの画像やビデオは返しません。

  • Strict - 成人向けのテキスト、画像、またはビデオを含むニュース記事を返さないでください。

既定値は Moderate です。

注:safeSearch が Strict に設定されるよう Bing の成人向けコンテンツ ポリシーによって強制される市場が要求元の場合、Bing によって safeSearch の値が無視され、Strict が使用されます。
String いいえ
setLang ユーザー インターフェイス文字列に使用する言語。 言語は、2 文字または 4 文字のコードを使用して指定できます。 4 文字のコードを使用することをお勧めします。

サポートされている言語コードの一覧については、「サポートされている言語 Bing」を参照してください。

Bing、有効な 2 文字のニュートラル カルチャ コード (fr) または有効な 4 文字の固有カルチャ コード (fr-ca) が含まれている場合setlangは、ローカライズされた文字列を読み込みます。 たとえば、 fr-ca の場合、Bingは fr ニュートラル カルチャ コード文字列を読み込みます。

が有効でない場合 (zh など)、またはBingが言語 (afaf-na など) をサポートしていない場合setlangは、既定値は en (英語) Bing。

2 文字のコードを指定するには、このパラメーターを ISO 639-1 言語コードに設定します。

4 文字のコードを指定するには、language-country<>/region <> という形式<を使用します。language> は ISO 639-1 言語コード (ニュートラル カルチャ) で、<国/地域>は ISO 3166 国/地域 (特定のカルチャ) コードです。 たとえば、英語の場合は en-US 米国使用します。

省略可能ですが、常に言語を指定することをお勧めします。 ユーザー インターフェイス文字列が別の言語で表示されることをユーザーが望まない限り、通常、setLangmkt で指定されるのと同じ言語に設定します。

このパラメーターと Accept-Language ヘッダーは相互に排他的なので、両方は指定しないでください。

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。 また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。
String いいえ
since トレンド トピックの選択に使用Bing Unix エポックタイム (Unix タイムスタンプ)。 Bingは、トピックが発行された日付ではなく、指定した日時以降に検出されたトレンド トピックを返します。

このパラメーターを使用するには、 パラメーターも指定 sortBy します。
Integer いいえ
sortBy トレンド トピックを返す順序。 次の値を指定できます。大文字と小文字は区別されません。
  • 日付 - 最新から最も古い順に日付順に並べ替えられたトレンド トピックを返します

このパラメーターを指定しない場合、特定の順序はありません。 ただし、トピックの鮮度、カテゴリ、グローバル ユーザー エンゲージメント、パーソナライズされた機能が考慮されます。
String いいえ
textDecorations 表示文字列に、ヒット強調表示文字などの装飾マーカーを含めるかどうかを決定するブール値。 true の場合、文字列にはマーカーを含めることができます。 既定値は false です。

マーカーとして Unicode 文字または HTML タグのどちらを使用するかを指定するには、 textFormat クエリ パラメーターを参照してください。

ヒット 強調表示の詳細については、「ヒット 強調表示」を参照してください。
ブール型 いいえ
textFormat テキスト装飾に使用するマーカーの種類 (クエリ パラメーターを textDecorations 参照)。

使用できる値を次に示します。
  • 生 — Unicode 文字を使用して、特別な書式設定が必要なコンテンツをマークします。 Unicode 文字の範囲は E000 ~ E019 です。 たとえば、Bingでは、E000 と E001 を使用して、クエリ用語の先頭と末尾にヒット強調表示のマークを付けます。

  • HTML — HTML タグを使用して、特別な書式設定が必要なコンテンツをマークします。 たとえば、b> タグを使用して<、表示文字列内のクエリ用語を強調表示します。

既定値は Raw です。

マーカーの一覧については、「 ヒット強調表示」を参照してください。

、 などの<>&エスケープ可能な HTML 文字を含む表示文字列の場合、 が HTML に設定されている場合textFormat、Bingは文字を適切にエスケープします (たとえば、 < lt;に&エスケープされます)。

Unicode 文字が埋め込まれた文字列の処理については、「 ヒット強調表示」を参照してください。
String いいえ

応答オブジェクト

注意

フランスの新しい EU 著作権指令に準拠するには、Bing Web、ニュース、ビデオ、画像、およびすべてのカスタム検索 API で、フランス語ユーザー向けの特定の EU ニュース ソースの一部のコンテンツを省略する必要があります。 削除されたコンテンツには、サムネイル画像とビデオ、ビデオプレビュー、およびこれらのソースからの検索結果に付随するスニペットが含まれる場合があります。 その結果、Bing API は、サムネイル画像とビデオ、ビデオ プレビュー、スニペットを使用してフランス語ユーザーに提供される結果が少なくなる可能性があります。

応答に含まれる可能性がある JSON オブジェクトを次に示します。 要求が成功した場合、応答の最上位オブジェクトは、エンドポイントが /news/search または /news の場合は News オブジェクト、エンドポイントが /news/trendingtopics の場合は TrendingTopicAnswer です。 要求が失敗した場合、最上位レベルのオブジェクトは ErrorResponse オブジェクトになります。

Object 説明
Error 発生したエラーを定義します。
ErrorResponse 要求が失敗したときに応答に含まれる最上位のオブジェクトを定義します。
イメージ ニュース関連の画像のサムネイルを定義します。
MediaSize メディア コンテンツのサイズを定義します。
ニュース ニュース要求が成功したときに応答に含まれる最上位オブジェクトを定義します。
NewsArticle ニュース記事を定義します。
組織 アーティクルを実行したプロバイダーを定義します。
クエリ 検索クエリ文字列を定義します。
RelatedTopic 検索クエリに関連するニュース記事の一覧を定義します。
サムネイル 関連するイメージへのリンクを定義します。
トピック トレンドニューストピックを定義します。
TrendingTopics トレンド トピック要求が成功したときに応答に含まれる最上位オブジェクトを定義します。
ビデオニュース記事に関連するビデオを定義します。

エラー

発生したエラーを定義します。

要素 説明 Type
code エラーのカテゴリを特定するエラー コード。 考えられるコードの一覧については、「エラー コード」を参照してください。 String
message エラーの説明。 String
moreDetails エラーに関する追加情報を提供する説明。 String
parameter エラーを引き起こした要求内のクエリ パラメーター。 String
subCode エラーを特定するエラー コード。 たとえば、code が InvalidRequest の場合、subCode は ParameterInvalid か ParameterInvalidValue の場合があります。 String
value 有効でなかったクエリ パラメーター値。 String

ErrorResponse

要求が失敗したときの応答に含まれている最上位レベルのオブジェクト。

名前 Type
_type 種類のヒント。 String
errors 要求が失敗した理由を示すエラーの一覧。 Error[]

Image

ニュース関連の画像のサムネイルを定義します。

名前 種類
provider イメージの所有者の一覧。 組織
thumbnail 画像のサムネイルへのリンク。 サムネイル
url 画像への URL です。 String

MediaSize

メディア コンテンツのサイズを定義します。

名前 種類
height メディア コンテンツの高さ (ピクセル単位)。 Integer
width メディア コンテンツの幅 (ピクセル単位)。 Integer

News

ニュース要求が成功したときに応答に含まれる最上位オブジェクトを定義します。

サービスがサービス拒否攻撃の疑いがある場合、要求は成功します (HTTP 状態コードは 200 OK)、応答の本文は空です。

名前 Type
_type 種類のヒント。 String
id ニュースの回答を一意に識別する ID。

このフィールドの使用方法については、Web Search API ガイドの 「順位付けを使用して結果を表示する 」を参照してください。
String
readLink この回答を返す URL。 URL を使用するには、必要に応じてクエリ パラメーターを追加し、 Ocp-Apim-Subscription-Key ヘッダーを含めます。

Web Search API には、このフィールドが含まれています。 通常、News Search API に直接クエリを実行する場合は、URL を使用します。
String
relatedTopics 検索語句に関連するニュース記事の一覧。 RelatedTopic[]
並べ替え ニュース記事を並べ替えるためのオプションの一覧。 たとえば、関連性 (既定) または日付で並べ替えます。 要求で使用された並べ替え順序を確認するには、 フィールドを isSelected 参照してください。 SortValue[]
totalEstimatedMatches クエリに関連するニュース記事の推定数。 この数値を count および offset クエリ パラメーターと共に使用して、結果をページングします。

ニュース検索 API にのみこのフィールドが含まれます (Web Search API には含まれません)。
Long
value クエリ用語に関連するニュース記事の一覧。

要求に対して返される結果がない場合、配列は空です。
NewsArticle[]

NewsArticle

ニュース記事を定義します。

名前 種類
カテゴリ 記事が属するニュース カテゴリ。 たとえば、スポーツです。 ニュース カテゴリを特定できない場合、記事にはこのフィールドは含まれません。

使用可能なカテゴリの一覧については、「 市場別のニュース カテゴリ」を参照してください。

要求で Sports-Tennis カテゴリが指定されている場合、プロパティには category Sports-Tennis または Sports が含まれている可能性があります。
String
clusteredArticles 関連するニュース記事の一覧。 NewsArticle[]
契約ルール 記事を表示する場合に従う必要があるルールの一覧。 たとえば、属性を指定する必要があるかどうかは、ルールによって制御される場合があります。

以下の契約規則が適用される場合があります。

記事に契約規則が記載されている場合は、その規則に従う必要があります。

メモ:Web Search API によって返される記事にのみ契約規則が含まれています。 ニュース エンドポイントによって返される記事には、契約上の規則は含まれていません。
Object[]
datePublished 記事を検出Bing日時。 日付の形式は YYYY-MM-DDTHH:MM:SS です。 String
説明 ニュース記事の簡単な説明。 String
見出し ニュース記事が見出しであるかどうかを示すブール値。 true の場合、記事は見出しです。

メモ: この記事には、 カテゴリ クエリ パラメーターを指定しないニュース カテゴリ要求に対してのみ、このフィールドが含まれています。
Boolean
id 記事の一覧でこの記事を一意に識別する ID。

このフィールドの使用方法については、Web Search API ガイドの 「順位付けを使用して結果を表示する 」を参照してください。
String
イメージ 新しい記事に関連する画像。

Imageこのコンテキストの オブジェクトには、 フィールドのみがthumbnail含まれます。
イメージ
言及 記事に記載されているエンティティ (場所または人物) の一覧。 Thing[]
名前 アーティクルの名前。

この名前を URL と共に使用して、クリックするとユーザーがニュース記事に移動するハイパーリンクを作成します。
String
プロバイダー 記事を実行したプロバイダーの一覧。 Organization[]
Url ニュース記事の URL。

この URL を と name 共に使用して、クリックするとユーザーがニュース記事に移動するハイパーリンクを作成します。
String
ビデオ ニュース記事に関連するビデオ。 ビデオ

組織

アーティクルを実行したプロバイダーを定義します。

名前 Type
_type 種類のヒント。 String
name アーティクルを実行したプロバイダーの名前。 String

クエリ

検索クエリ文字列を定義します。

名前 種類
テキスト トレンド トピックを返すクエリ文字列。 String

RelatedTopic

検索クエリに関連するニュース記事の一覧を定義します。

名前 種類
relatedNews 関連するニュース記事の一覧。 NewsArticle
名前 関連するニュース記事を返した関連クエリ用語。 String
webSearchUrl 関連するクエリのBing検索結果にユーザーを移動する URL。 String

SortValue

要求に使用する並べ替え順序を定義します。

名前 Type
id アーティクルの並べ替え順序を識別する識別子。 使用できる値を次に示します。
  • date — 日付で並べ替え
  • 関連性 — 関連性で並べ替える
String
Isselected 応答がこの並べ替え順序を使用したかどうかを決定するブール値。 true の場合、応答はこの並べ替え順序を使用します。 Boolean
name 並べ替え順序の表示名。 String
url この並べ替え順序を使用して同じ要求を行うために使用できる URL。 String

TextAttribution

プレーンテキスト属性の契約規則を定義します。

名前 Type
_type 種類のヒント。これは TextAttribution に設定されます。 String
テキスト 属性のテキスト。

テキスト属性はニュース記事全体に適用され、記事のプレゼンテーションの直後に表示されます。 ターゲットが指定されていないテキスト属性またはリンク属性の規則が複数ある場合、"Data from: " ラベルを使ってそれらを連結して表示する必要があります。
String

Thing

アーティクルが言及するエンティティを定義します。

名前 Type
name アーティクルが言及するエンティティの名前。 String

サムネイル

関連するイメージへのリンクを定義します。

名前 種類
contentUrl 画像への URL です。 String
高さ 画像の高さ (ピクセル単位)。 Unsigned Short
画像の幅 (ピクセル単位)。 Unsigned Short

トピック

トレンドニューストピックを定義します。

名前 種類
イメージ 関連する画像へのリンク。

Imageこのコンテキストの オブジェクトには、 フィールドと provider フィールドのみがurl含まれます。 フィールドは provider 、イメージ プロバイダーを識別する Organization オブジェクトの配列です。
Image
isBreakingNews トピックがニュース速報と見なされるかどうかを示すブール値。 トピックがニュース速報と見なされる場合、値は true です Boolean
名前 トレンド トピックのタイトル。 String
newsSearchUrl 検索クエリ用語のBingニュース検索結果の URL (フィールドを query 参照)。 String
query このトレンド トピックを返す検索クエリ用語。 クエリ
webSearchUrl 検索クエリ用語のBing検索結果の URL (フィールドを query 参照)。 String

TrendingTopics

トレンド トピック要求が成功したときに応答に含まれる最上位オブジェクトを定義します。

名前 種類
value Bingに関する注目のニュース トピックの一覧。

要求に対して返される結果がない場合、配列は空です。
Topic[]

ビデオ

ニュース記事に関連するビデオを定義します。

注意

URL の形式とパラメーターは予告なく変更される可能性があるため、すべての URL をそのまま使用してください。 URL の形式またはパラメーターに依存しないようにしてください。

名前 種類
allowHttpsEmbed HTTPS プロトコルを使用するページにビデオを埋め込む (フィールドを embedHtml 参照) かどうかを決定するブール値。 Boolean
embedHtml Web ページにビデオを埋め込んで実行できる iframe。 String
motionThumbnailUrl ビデオのプレビューを示すアニメーションサムネイルの URL。 通常、この URL を使用して、ユーザーが結果ページのビデオのサムネイルにマウス ポインターを合わせると、ビデオのプレビューを再生します。 String
name ビデオの名前 String
サムネイル サムネイル画像またはモーション サムネイルの幅と高さ。 MediaSize
thumbnailUrl ビデオのサムネイル画像への URL。 画像のサイズ変更の詳細については、「サムネイル画像の サイズ変更とトリミング」を参照してください。 String

市場別ニュースカテゴリ

カテゴリ クエリ パラメーターを に設定できるニュース カテゴリ を次に示します。 エンターテイメントなどの親カテゴリ、またはそのサブカテゴリ (Entertainment_MovieAndTV など) に設定 category できます。 親カテゴリに設定 category すると、そのサブカテゴリの 1 つ以上の記事が含まれます。 サブカテゴリに設定 category すると、サブカテゴリからの記事のみが含まれます。

Market サポートされているカテゴリ
オーストラリア (en-AU)
  • オーストラリア
  • Business
  • エンターテイメント
  • 政治
  • スポーツ
  • World
カナダ (en-CA)
  • Business
  • カナダ
  • エンターテイメント
  • ライフ スタイル
  • 政治
  • ScienceAndTechnology
  • スポーツ
  • World
中国 (zh-CN)
  • 自動
  • Business
  • 中国
  • Education
  • エンターテイメント
  • 軍事
  • 不動産
  • ScienceAndTechnology
  • 社会
  • スポーツ
  • World
インド (en-IN)
  • Business
  • エンターテイメント
  • インド
  • ライフ スタイル
  • 政治
  • ScienceAndTechnology
  • スポーツ
  • World
日本 (ja-JP)
  • Business
  • エンターテイメント
  • 日本
  • ライフ スタイル
  • 政治
  • ScienceAndTechnology
  • スポーツ
  • World
英国 (en-GB)
  • Business
  • エンターテイメント
  • 健康
  • 政治
  • ScienceAndTechnology
  • スポーツ
  • 英国
  • World
米国 (en-US)
  • Business
  • エンターテイメント
    • Entertainment_MovieAndTV
    • Entertainment_Music
  • 健康
  • 政治
  • 製品
  • ScienceAndTechnology
    • テクノロジ
    • 科学
  • スポーツ
    • Sports_Golf
    • Sports_MLB
    • Sports_NBA
    • Sports_NFL
    • Sports_NHL
    • Sports_Soccer
    • Sports_Tennis
    • Sports_CFB
    • Sports_CBB
  • US
    • US_Northeast
    • US_South
    • US_Midwest
    • US_West
  • World
  • World_Africa
  • World_Americas
  • World_Asia
  • World_Europe
  • World_MiddleEast

エラー コード

要求によって返される可能性のある HTTP 状態コードを次に示します。

状態コード 説明
200 正常終了しました。
400 クエリ パラメーターの 1 つが欠落しているか無効です。
401 サブスクリプション キーが見つからないか、無効です。
403 (たとえば、有効なサブスクリプション キーを使用して) ユーザーは認証されたものの、要求されたリソースへのアクセス許可がありません。

また、呼び出し元が 1 か月あたりのクエリ数のクォータを超えた場合にも、Bing はこの状態を返します。
410 HTTPS プロトコルではなく HTTP プロトコルが使用された要求。 サポートされるプロトコルは HTTPS のみです。
429 呼び出し元が 1 秒あたりのクエリ数のクォータを超えました。
500 予期しないサーバー エラーです。

要求が失敗すると、応答に ErrorResponse オブジェクトが含まれます。このオブジェクトには、エラーの原因を示す Error オブジェクトの一覧が含まれています。 エラーがパラメーターに関連している場合、parameter フィールドで、問題であるパラメーターが特定されます。 エラーがパラメーター値に関連している場合、value フィールドで、無効な値が特定されます。

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

考えられるエラー コードとサブエラー コードの値を次に示します。

コード サブコード 説明
ServerError UnexpectedError
ResourceError
NotImplemented
HTTP 状態コードは 500 です。
InvalidRequest ParameterMissing
ParameterInvalidValue
HttpNotAllowed
Blocked
要求の一部が有効でない場合に Bing は InvalidRequest を返します。 たとえば、必要なパラメーターが不足している場合や、パラメーター値が無効な場合です。

エラーが ParameterMissing または ParameterInvalidValue の場合、HTTP 状態コードは 400 です。

HTTPS プロトコルではなく HTTP プロトコルを使用すると、Bing は HttpNotAllowed を返し、HTTP 状態コードは 410 になります。
RateLimitExceeded No sub-codes 1 秒あたりのクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) のクォータを超えると、Bing は RateLimitExceeded を返します。

QPS を超えた場合、Bing は HTTP 状態コード 429 を返します。また、QPM を超えた場合、Bing は 403 を返します。
InvalidAuthorization AuthorizationMissing
AuthorizationRedundancy
Bing は、呼び出し元を認証できない場合に InvalidAuthorization を返します。 たとえば、Ocp-Apim-Subscription-Key ヘッダーがない場合や、サブスクリプション キーが無効な場合です。

冗長性は、複数の認証方法を指定した場合に発生します。

エラーが InvalidAuthorization の場合、HTTP 状態コードは 401 です。
InsufficientAuthorization AuthorizationDisabled
AuthorizationExpired
呼び出し元がリソースに対するアクセス許可を備えていない場合、Bing は InsufficientAuthorization を返します。 これは、サブスクリプション キーが無効になっているか、期限が切れている場合に発生することがあります。

エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。

市場コード

endpointhe の次の /news/search 表に、クエリ パラメーターを指定するために使用できる市場コード値を mkt 示します。 Bing はこれらの市場に対してのみコンテンツを返します。 一覧は変更されることがあります。

cc クエリ パラメーターで指定できる国番号の一覧については、「国番号」をご覧ください。

国/地域 Language 市場コード
デンマーク デンマーク語 da-DK
オーストリア ドイツ語 de-AT
ベルギー オランダ語 nl-BE
スイス ドイツ語 de-CH
ドイツ ドイツ語 de-DE
オーストラリア 英語 en-AU
Canada 英語 en-CA
イギリス 英語 en-GB
インドネシア 英語 en-ID
アイルランド 英語 en-IE
インド 英語 en-IN
マレーシア 英語 en-MY
ニュージーランド 英語 en-NZ
フィリピン共和国 英語 en-PH
シンガポール 英語 en-SG
United States 英語 ja-JP
英語 全般 en-WW
英語 全般 en-XA
南アフリカ 英語 en-ZA
アルゼンチン スペイン語 es-AR
チリ スペイン語 es-CL
スペイン スペイン語 es-ES
メキシコ スペイン語 es-MX
United States スペイン語 es-US
スペイン語 全般 es-XL
フィンランド フィンランド語 fi-FI
フランス フランス語 fr-BE
Canada フランス語 fr-CA
スイス フランス語 fr-CH
フランス フランス語 fr-FR
イタリア イタリア語 it-IT
香港特別行政区 Traditional Chinese zh-HK
台湾 Traditional Chinese zh-TW
日本 日本語 ja-JP
韓国 韓国語 ko-KR
オランダ オランダ語 nl-NL
中華人民共和国 Chinese zh-CN
ポーランド ポーランド語 pl-PL
ブラジル ポルトガル語 pt-BR
ロシア ロシア語 ru-RU
スウェーデン スウェーデン語 sv-SE
トルコ トルコ語 tr-TR

/news エンドポイントについて、mkt クエリ パラメーターを指定するために使用できる市場コード値の一覧を次の表に示します。 Bing はこれらの市場に対してのみコンテンツを返します。 一覧は変更されることがあります。

cc クエリ パラメーターで指定できる国番号の一覧については、「国番号」をご覧ください。

国/地域 Language 市場コード
デンマーク デンマーク語 da-DK
ドイツ ドイツ語 de-DE
オーストラリア 英語 en-AU
イギリス 英語 en-GB
United States 英語 ja-JP
英語 全般 en-WW
チリ スペイン語 es-CL
メキシコ スペイン語 es-MX
United States スペイン語 es-US
フィンランド フィンランド語 fi-FI
Canada フランス語 fr-CA
フランス フランス語 fr-FR
イタリア イタリア語 it-IT
ポルトガル語 ブラジル pt-BR
中華人民共和国 Chinese zh-CN

endpointhe の次の /news/trendingtopics 表に、クエリ パラメーターを指定するために使用できる市場コード値を mkt 示します。 Bing はこれらの市場に対してのみコンテンツを返します。 一覧は変更されることがあります。

cc クエリ パラメーターで指定できる国番号の一覧については、「国番号」をご覧ください。

国/地域 Language 市場コード
ドイツ ドイツ語 de-DE
オーストラリア 英語 en-AU
イギリス 英語 en-GB
United States 英語 ja-JP
Canada 英語 en-CA
インド 英語 en-IN
フランス フランス語 fr-FR
Canada フランス語 fr-CA
ポルトガル語 ブラジル pt-BR
中華人民共和国 Chinese zh-CN

国コード

cc クエリ パラメーターで指定できる国番号を次に示します。 一覧は変更されることがあります。

国/地域 国番号
アルゼンチン AR
オーストラリア AU
オーストリア AT
ベルギー BE
ブラジル BR
カナダ CA
チリ CL
デンマーク DK
フィンランド FI
フランス FR
ドイツ DE
香港特別行政区 HK
インド IN
インドネシア id
イタリア IT
日本 JP
韓国 KR
マレーシア MY
メキシコ MX
オランダ NL
ニュージーランド NZ
ノルウェー NO
中華人民共和国 CN
ポーランド PL
ポルトガル PT
フィリピン共和国 PH
ロシア RU
サウジアラビア SA
南アフリカ ZA
スペイン ES
スウェーデン SE
スイス CH
台湾 TW
トルコ TR
イギリス GB
United States US

サポートされている言語をBingする

クエリ パラメーターで指定できるBingサポートされている言語を次に setLang 示します。 一覧は変更されることがあります。

サポートされている言語 言語コード
アラビア語 ar
バスク語 eu
ベンガル語 bn
ブルガリア語 bg
カタロニア語 ca
簡体中国語 zh-hans
繁体中国語 zh-hant
クロアチア語 hr
チェコ語 cs
デンマーク語 da
オランダ語 nl
英語 en
English-United王国 en-gb
エストニア語 et
フィンランド語 fi
フランス語 fr
ガリシア語 gl
ドイツ語 de
グジャラート語 gu
ヘブライ語 he
ヒンディー語 hi
ハンガリー語 hu
アイスランド語 :
イタリア語 it
日本語 Jp
カンナダ語 kn
韓国語 ko
ラトビア語 lv
リトアニア語 lt
マレー語 ms
マラヤーラム語 ml
マラーティー語 mr
ノルウェー語 - ブークモール nb
ポーランド語 pl
ポルトガル語 (ブラジル) pt-br
ポルトガル語 (ポルトガル) pt-pt
パンジャブ語 pa
ルーマニア語 ro
ロシア語 ru
セルビア語 (Cyrylic) sr
スロバキア語 sk
スロベニア語 sl
スペイン語 es
スウェーデン語 sv
タミル語 ta
テルグ語 te
タイ語 th
トルコ語 tr
ウクライナ語 uk
ベトナム語 vi