News Search API v7 リファレンス

警告

Bing Search APIs は Cognitive Services から Bing Search サービスに移行しています。 2020 年10月 30 日以降、Bing Search の新しいインスタンスは、 ここに記載されている手順に従ってプロビジョニングする必要があります。 Cognitive Services を使用してプロビジョニングされた Bing Search APIs は、次の3年間、またはマイクロソフトエンタープライズ契約の終わり (どちらか早い方) にサポートされます。 移行手順については、「 Bing Search Services」を参照してください。

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

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

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

応答に含めることができる JSON オブジェクトの詳細については、「 応答オブジェクト」を参照してください。

結果の使用と表示の許可の詳細については、「 BING SEARCH API の使用と表示の要件」を参照してください。

注意

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

エンドポイント

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

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

注: En-us および zh-tw の市場でのみご利用いただけます。

マルチサービスサブスクリプションの場合は、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 言語 の値を指定した場合も同様です。
BingAPIs-TraceId 応答ヘッダー。

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

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

既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。 キャッシュされたコンテンツを防止するには、プラグマヘッダーを no cache (たとえば、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 によって使用されます。 キーと値のペアは、<key>:<value> の形式で指定します。 ユーザーの場所の指定に使用するキーは次のとおりです。

  • 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 キーを指定する場合にのみ指定します。

  • 変位 — (省略可能)。 フォーム内のユーザーの地理的な場所 (変位: <City、州>)。 たとえば、"変位: Seattle, ワシントン" のようになります。 これは、lat/長いキーを使用して指定したユーザーの場所の表示テキストバージョンです。 この値が lat/long 座標と競合する場合、Bing では、ユーザーの場所として変位値が使用されます。

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

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

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

注意

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

クエリ パラメーター

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

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

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

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

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

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

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

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

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

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

傾向を示すトピックの場合、既定ではすべてのトレンドニューストピック (約55の記事) が対象となります。

このパラメーターをパラメーターと共に使用すると、 offset 結果をページに表示できます。 たとえば、ユーザーインターフェイスにページごとに20個の記事が表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。 それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。 複数のページに、結果に重複が含まれている可能性があります。

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

注: ニュースカテゴリを要求している場合は、category パラメーターを指定した場合にのみ、このパラメーターを指定します。 Category パラメーターを指定しない場合、Bing はこのパラメーターを無視します。
UnsignedShort いいえ
鮮度 次の年齢値でニュース記事をフィルター:
  • 日 — 過去24時間以内に Bing が発見したニュース記事を返します
  • 毎週 — Bing が過去7日間に検出したニュース記事を返します
  • 月 — 過去30日以内に Bing が発見したニュース記事を返します
String いいえ
headlineCount 返す見出しアーティクルとクラスターの数。 既定値は 12 です。

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

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

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

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

このパラメーターをパラメーターと共に使用して、 count ページの結果を表示します。 たとえば、ユーザーインターフェイスにページごとに20個の記事が表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。 それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。 複数のページに、結果に重複が含まれている可能性があります。

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

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

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

既定値は false です。

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

用語の文字列には、 Bing 高度なオペレーターを含めることができます。 たとえば、ニュースを特定のドメインに限定するには、 site: 演算子を使用します。

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

  • 中程度 — のニュース記事を成人向けのテキストと共に返しますが、成人向けの画像やビデオは返しません。

  • 厳密 — には、アダルトテキスト、画像、またはビデオを含むニュース記事は返しません。

既定値は Moderate です。

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

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

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

setlangが有効でない場合 (たとえば、 zh-tw ) や bing がこの言語をサポートしていない場合 (例: af , af-na )、bing の既定値は en (英語) です。

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

4文字のコードを指定するに は、<国/地域> を使用します。ここで、 は 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 クエリパラメーターを参照)。

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

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

既定値は Raw です。

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

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

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

応答オブジェクト

注意

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

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

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

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

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

MediaSize

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

Name
体高 メディアコンテンツの高さ (ピクセル単位)。 Integer
width メディアコンテンツの幅 (ピクセル単位)。 Integer

News

ニュース要求が成功したときに応答に含まれるトップレベルのオブジェクトを定義します。

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

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

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

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

このフィールドが含まれるのは、News Search API だけです (Web Search API ではありません)。
Long
value クエリ用語に関連するニュース記事の一覧。

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

NewsArticle

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

Name
アーティクルが属しているニュースカテゴリ。 たとえば、「スポーツ」とします。 [ニュース] カテゴリを特定できない場合、この記事にはこのフィールドは含まれません。

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

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

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

この記事で契約規則が提供されている場合は、それを遵守する必要があります。

注:WEB SEARCH APIによって返される記事にのみ、契約規則が含まれています。 ニュースエンドポイントから返される記事には、契約ルールは含まれていません。
Object[]
datePublished Bing が記事を検出した日付と時刻。 日付は YYYY-MM-YYYY-MM-DDTHH: MM: SS という形式になっています。 String
記述 ニュース記事の簡単な説明。 String
見出し ニュース記事が見出しであるかどうかを示すブール値です。 True の場合、アーティクルは見出しになります。

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

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

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

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

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

Organization

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

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

クエリ

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

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

関連性のあるトピック

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

Name
関連性のあるニュース 関連するニュース記事の一覧。 NewsArticle
指定 関連するニュース記事を返した関連するクエリ用語。 String
webSearchUrl 関連するクエリの Bing 検索結果に対してユーザーを取得する URL。 String

SortValue

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

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

TextAttribution

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

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

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

Thing

アーティクルによってメンションされるエンティティを定義します。

Name Type
name アーティクルによってメンションされたエンティティの名前。 String

サムネイル

関連する画像へのリンクを定義します。

Name
contentUrl 画像への URL です。 String
上下 イメージの高さ (ピクセル単位)。 Unsigned Short
イメージの幅 (ピクセル単位)。 Unsigned Short

トピック

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

Name
関連する画像へのリンク。

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

TrendingTopics

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

Name
value Bing のトレンドニューストピックの一覧。

要求に対して返される結果がない場合、配列は空になります。
トピック[]

ビデオ

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

注意

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

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

市場別のニュースカテゴリ

カテゴリクエリパラメーターを設定できるニュースカテゴリは次のとおりです。 categoryエンターテインメントなどの親カテゴリや、Entertainment_MovieAndTV などのサブカテゴリの1つに設定できます。 categoryを親カテゴリに設定すると、サブカテゴリの1つ以上のアーティクルが含まれます。 をサブカテゴリに設定した場合は、 category サブカテゴリの記事だけが含まれます。

Market サポートされるカテゴリ
オーストラリア (en-us)
  • オーストラリア
  • Business
  • エンターテイメント
  • 政治
  • スポーツ
  • World
カナダ (en-us)
  • Business
  • カナダ
  • エンターテイメント
  • スタイル
  • 政治
  • ScienceAndTechnology
  • スポーツ
  • World
中国 (zh-tw-CN)
  • Auto
  • Business
  • 中国
  • Education
  • エンターテイメント
  • 軍事機関
  • RealEstate
  • ScienceAndTechnology
  • 社会
  • スポーツ
  • World
インド (en-us)
  • 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 です。

市場コード

/news/searchEndpointhe 場合、次の表に、クエリパラメーターの指定に使用できる市場コード値の一覧を示し 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
ブラジル Portuguese 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

/news/trendingtopicsEndpointhe 場合、次の表に、クエリパラメーターの指定に使用できる市場コード値の一覧を示し 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
Canada 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
Bulgarian bg
カタロニア語 ca
簡体中国語 zh-hans
繁体中国語 zh-hant
Croatian hr
Czech cs
Danish da
Dutch nl
English en
イギリス-イギリス en-gb
Estonian et
Finnish fi
French fr
ガリシア語 gl
German de
グジャラート語 gu
ヘブライ語 he
ヒンディー語 hi
Hungarian hu
アイスランド語 is
Italian it
Japanese Jp
カンナダ語 kn
Korean ko
Latvian lv
Lithuanian lt
マレー語 ms
マラヤーラム語  ml
マラーティー語 mr
ノルウェー語 (ブークモール) nb
Polish pl
ポルトガル語 (ブラジル) pt-br
ポルトガル語 (ポルトガル) pt-pt
パンジャーブ語 pa
Romanian ro
Russian ru
セルビア語 (キリリック) sr
Slovak sk
Slovenian sl
Spanish es
Swedish sv
タミル語 ta
テルグ語 te
Thai th
Turkish tr
ウクライナ語 uk
ベトナム語 vi