Bing Web Search API v5 から v7 へのアップグレードUpgrade from Bing Web Search API v5 to v7

このアップグレード ガイドでは、Bing Web Search API のバージョン 5 とバージョン 7 の間の変更点を識別します。This upgrade guide identifies the changes between version 5 and version 7 of the Bing Web Search API. このガイドは、バージョン 7 を使用するために更新する必要のあるアプリケーションの部分を識別するのに役立ちます。Use this guide to help you identify the parts of your application that you need to update to use version 7.

重大な変更Breaking changes

エンドポイントEndpoints

  • エンドポイントのバージョン番号は、v5 から v7 に変更されました。The endpoint's version number changed from v5 to v7. 例: https://api.cognitive.microsoft.com/bing/v7.0/search。For example, https://api.cognitive.microsoft.com/bing/v7.0/search.

エラー応答オブジェクトとエラー コードError response objects and error codes

  • すべての失敗した要求には、応答本文内に ErrorResponse オブジェクトが含まれるようになりました。All failed requests should now include an ErrorResponse object in the response body.

  • Error オブジェクトに次のフィールドが追加されました。Added the following fields to the Error object.

    • subCode—エラー コードを別個のバケットに分割します (可能な場合)subCode—Partitions the error code into discrete buckets, if possible
    • moreDetailsmessage フィールドで説明されているエラーに関する追加情報moreDetails—Additional information about the error described in the message field
  • v5 エラー コードを次の可能な code および subCode 値に置き換えました。Replaced the v5 error codes with the following possible code and subCode values.

コードCode サブコードSubCode 説明Description
ServerErrorServerError UnexpectedErrorUnexpectedError
ResourceErrorResourceError
NotImplementedNotImplemented
サブコード条件のいずれかが発生するたびに、Bing は ServerError を返します。Bing returns ServerError whenever any of the sub-code conditions occur. HTTP 状態コードが 500 の場合、応答にはこれらのエラーが含まれます。The response will include these errors if the HTTP status code is 500.
InvalidRequestInvalidRequest ParameterMissingParameterMissing
ParameterInvalidValueParameterInvalidValue
HttpNotAllowedHttpNotAllowed
BlockedBlocked
要求の一部が有効でない場合に Bing は InvalidRequest を返します。Bing returns InvalidRequest whenever any part of the request is not valid. たとえば、必要なパラメーターが不足している場合や、パラメーター値が無効な場合です。For example, a required parameter is missing or a parameter value is not valid.

エラーが ParameterMissing または ParameterInvalidValue の場合、HTTP 状態コードは 400 です。If the error is ParameterMissing or ParameterInvalidValue, the HTTP status code is 400.

エラーが HttpNotAllowed の場合、HTTP 状態コードは 410 です。If the error is HttpNotAllowed, the HTTP status code 410.
RateLimitExceededRateLimitExceeded 1 秒あたりのクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) のクォータを超えると、Bing は RateLimitExceeded を返します。Bing returns RateLimitExceeded whenever you exceed your queries per second (QPS) or queries per month (QPM) quota.

QPS を超えた場合、Bing は HTTP 状態コード 429 を返し、QPM を超過した場合に 403 を返します。Bing returns HTTP status code 429 if you exceeded QPS and 403 if you exceeded QPM.
InvalidAuthorizationInvalidAuthorization AuthorizationMissingAuthorizationMissing
AuthorizationRedundancyAuthorizationRedundancy
Bing は、呼び出し元を認証できない場合に InvalidAuthorization を返します。Bing returns InvalidAuthorization when Bing cannot authenticate the caller. たとえば、Ocp-Apim-Subscription-Key ヘッダーがない場合や、サブスクリプション キーが無効な場合です。For example, the Ocp-Apim-Subscription-Key header is missing or the subscription key is not valid.

冗長性は、複数の認証方法を指定した場合に発生します。Redundancy occurs if you specify more than one authentication method.

エラーが InvalidAuthorization の場合、HTTP 状態コードは 401 です。If the error is InvalidAuthorization, the HTTP status code is 401.
InsufficientAuthorizationInsufficientAuthorization AuthorizationDisabledAuthorizationDisabled
AuthorizationExpiredAuthorizationExpired
呼び出し元がリソースに対するアクセス許可を備えていない場合、Bing は InsufficientAuthorization を返します。Bing returns InsufficientAuthorization when the caller does not have permissions to access the resource. このエラーは、サブスクリプション キーが無効になっているか、期限が切れている場合に発生することがあります。This error can occur if the subscription key has been disabled or has expired.

エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。If the error is InsufficientAuthorization, the HTTP status code is 403.
  • 以前のエラー コードと新しいコードのマッピングを次に示します。The following maps the previous error codes to the new codes. v5 エラー コードに依存していた場合は、コードを適宜更新してください。If you've taken a dependency on v5 error codes, update your code accordingly.
バージョン 5 コードVersion 5 code バージョン 7 コード.サブコードVersion 7 code.subCode
RequestParameterMissingRequestParameterMissing InvalidRequest.ParameterMissingInvalidRequest.ParameterMissing
RequestParameterInvalidValueRequestParameterInvalidValue InvalidRequest.ParameterInvalidValueInvalidRequest.ParameterInvalidValue
ResourceAccessDeniedResourceAccessDenied InsufficientAuthorizationInsufficientAuthorization
ExceededVolumeExceededVolume RateLimitExceededRateLimitExceeded
ExceededQpsLimitExceededQpsLimit RateLimitExceededRateLimitExceeded
DisabledDisabled InsufficientAuthorization.AuthorizationDisabledInsufficientAuthorization.AuthorizationDisabled
UnexpectedErrorUnexpectedError ServerError.UnexpectedErrorServerError.UnexpectedError
DataSourceErrorsDataSourceErrors ServerError.ResourceErrorServerError.ResourceError
AuthorizationMissingAuthorizationMissing InvalidAuthorization.AuthorizationMissingInvalidAuthorization.AuthorizationMissing
HttpNotAllowedHttpNotAllowed InvalidRequest.HttpNotAllowedInvalidRequest.HttpNotAllowed
UserAgentMissingUserAgentMissing InvalidRequest.ParameterMissingInvalidRequest.ParameterMissing
NotImplementedNotImplemented ServerError.NotImplementedServerError.NotImplemented
InvalidAuthorizationInvalidAuthorization InvalidAuthorizationInvalidAuthorization
InvalidAuthorizationMethodInvalidAuthorizationMethod InvalidAuthorizationInvalidAuthorization
MultipleAuthorizationMethodMultipleAuthorizationMethod InvalidAuthorization.AuthorizationRedundancyInvalidAuthorization.AuthorizationRedundancy
ExpiredAuthorizationTokenExpiredAuthorizationToken InsufficientAuthorization.AuthorizationExpiredInsufficientAuthorization.AuthorizationExpired
InsufficientScopeInsufficientScope InsufficientAuthorizationInsufficientAuthorization
BlockedBlocked InvalidRequest.BlockedInvalidRequest.Blocked

非破壊的変更Non-breaking changes

headersHeaders

  • オプションの Pragma 要求ヘッダーが追加されました。Added the optional Pragma request header. 既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。By default, Bing returns cached content, if available. キャッシュされたコンテンツを Bing が返さないようにするには、Pragma ヘッダーを no-cache に設定します (例: Pragma: no-cache)。To prevent Bing from returning cached content, set the Pragma header to no-cache (for example, Pragma: no-cache).

クエリ パラメーターQuery parameters

  • answerCount クエリ パラメーターが追加されました。Added the answerCount query parameter. 応答に含める回答の数を指定するには、このパラメーターを使用します。Use this parameter to specify the number of answers that you want the response to include. 回答は、ランキングに基づいて選択されます。The answers are chosen based on ranking. たとえば、このパラメーターを 3 に設定すると、上位の 3 つの回答が応答に含まれます。For example, if you set this parameter to three (3), the response includes the top three ranked answers.

  • promote クエリ パラメーターが追加されました。Added the promote query parameter. ランキングに関係なく 1 つ以上の回答タイプを明示的に含めるには、このパラメーターを answerCount と共に使用します。Use this parameter along with answerCount to explicitly include one or more answer types, regardless of their ranking. たとえば、ビデオと画像を応答に昇格させるには、promote を videos,images に設定します。For example, to promote videos and images into the response, you’d set promote to videos,images. 昇格させる回答の一覧は、answerCount の制限にはカウントされません。The list of answers that you want to promote does not count against the answerCount limit. たとえば、answerCount が 2、promotevideos,images に設定されている場合、応答には Web ページ、ニュース、ビデオ、および画像が含まれます。For example, if answerCount is 2 and promote is set to videos,images, the response might include webpages, news, videos, and images.

オブジェクトの変更Object changes

  • someResultsRemoved フィールドが WebAnswer オブジェクトに追加されました。Added the someResultsRemoved field to the WebAnswer object. このフィールドには、応答において Web 回答のいくつかの結果が除外されているかどうかを示すブール値が含まれています。The field contains a Boolean value that indicates whether the response excluded some results from the web answer.