News Search API のアップグレード ガイド

  • [アーティクル]

警告

2020 年 10 月 30 日に、Bing Search API は Azure AI サービスから Bing Search サービスに移行されました。 このドキュメントは、参考用としてのみ提供されています。 更新されたドキュメントについては、Bing search API のドキュメントを参照してください。 Bing 検索用の新しい Azure リソースを作成する手順については、「Azure Marketplace から Bing Search リソースを作成する」を参照してください。

このアップグレード ガイドでは、Bing News Search API のバージョン 5 とバージョン 7 の間の変更点を識別します。 このガイドは、バージョン 7 を使用するために更新する必要のあるアプリケーションの部分を識別するのに役立ちます。

重大な変更

エンドポイント

  • エンドポイントのバージョン番号は、v5 から v7 に変更されました。 たとえば、「 https://api.cognitive.microsoft.com/bing/v7.0/news/search 」のように入力します。

エラー応答オブジェクトとエラー コード

  • すべての失敗した要求には、応答本文内に ErrorResponse オブジェクトが含まれるようになりました。

  • Error オブジェクトに次のフィールドが追加されました。

    • subCode—エラー コードを別個のバケットに分割します (可能な場合)
    • moreDetails—message フィールドで説明されているエラーに関する追加情報

  • v5 エラー コードを次の可能な code および subCode 値に置き換えました。

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

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

エラーが HttpNotAllowed の場合、HTTP 状態コードは 410 です。
RateLimitExceeded 1 秒あたりのクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) のクォータを超えると、Bing は RateLimitExceeded を返します。

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

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

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

エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。
  • 以前のエラー コードと新しいコードのマッピングを次に示します。 v5 エラー コードに依存していた場合は、コードを適宜更新してください。
バージョン 5 コード バージョン 7 コード.サブコード
RequestParameterMissing InvalidRequest.ParameterMissing
RequestParameterInvalidValue InvalidRequest.ParameterInvalidValue
ResourceAccessDenied InsufficientAuthorization
ExceededVolume RateLimitExceeded
ExceededQpsLimit RateLimitExceeded
無効 InsufficientAuthorization.AuthorizationDisabled
UnexpectedError ServerError.UnexpectedError
DataSourceErrors ServerError.ResourceError
AuthorizationMissing InvalidAuthorization.AuthorizationMissing
HttpNotAllowed InvalidRequest.HttpNotAllowed
UserAgentMissing InvalidRequest.ParameterMissing
NotImplemented ServerError.NotImplemented
InvalidAuthorization InvalidAuthorization
InvalidAuthorizationMethod InvalidAuthorization
MultipleAuthorizationMethod InvalidAuthorization.AuthorizationRedundancy
ExpiredAuthorizationToken InsufficientAuthorization.AuthorizationExpired
InsufficientScope InsufficientAuthorization
Blocked InvalidRequest.Blocked

オブジェクトの変更

  • contractualRules フィールドが NewsArticle オブジェクトに追加されました。 contractualRules フィールドには、従う必要があるルールのリストが含まれています (たとえば、記事の属性)。 provider を使用するのではなく、contractualRules に指定されている属性を適用する必要があります。 この記事には、Web Search API 応答に News の回答が含まれている場合にのみ contractualRulesが含まれます。

非破壊的変更

クエリ パラメーター

  • category クエリ パラメーターをに設定できる可能性のある値として Products が追加されました。 市場別のカテゴリに関するページを参照してください。

  • 最近の日付から並べられたトレンドのトピックを返す SortBy クエリ パラメーターが追加されました。

  • Since クエリ パラメーターが追加されました。指定した Unix エポック タイムスタンプ以降に Bing によって検出されたトレンドのトピックを返します。

オブジェクトの変更

  • mentions フィールドが NewsArticle オブジェクトに追加されました。 mentions フィールドには、記事で見つかったエンティティ (人物または場所) のリストが含まれています。

  • video フィールドが NewsArticle オブジェクトに追加されました。 video フィールドには、ニュース記事に関連する動画が含まれています。 動画は、埋め込むことができる <iframe> または動画のサムネイルのいずれかです。

  • sort フィールドが News オブジェクトに追加されました。 sort フィールドには、記事の並べ替え順序が表示されます。 たとえば、記事は関連性 (既定) または日付順で並べ替えられます。

  • 並べ替え順序を定義する SortValue オブジェクトが追加されました。 isSelected フィールドは、応答が並べ替え順序を使用したかどうかを示します。 true の場合、応答は並べ替え順序を使用しました。 isSelected が false の場合、url フィールドの URL を使用して、別の並べ替え順序を要求できます。