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

このアップグレード ガイドでは、Bing News Search API のバージョン 5 とバージョン 7 の間の変更点を識別します。This upgrade guide identifies the changes between version 5 and version 7 of the Bing News 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

エラー応答オブジェクトとエラー コード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 includes 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 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

オブジェクトの変更Object changes

  • contractualRules フィールドが NewsArticle オブジェクトに追加されました。Added the contractualRules field to the NewsArticle object. contractualRules フィールドには、従う必要があるルールのリストが含まれています (たとえば、記事の属性)。The contractualRules field contains a list of rules that you must follow (for example, article attribution). provider を使用するのではなく、contractualRules に指定されている属性を適用する必要があります。You must apply the attribution provided in contractualRules instead of using provider. この記事には、Web Search API 応答に News の回答が含まれている場合にのみ contractualRulesが含まれます。The article includes contractualRules only when the Web Search API response contains a News answer.

非破壊的変更Non-breaking Changes

クエリ パラメーターQuery parameters

  • category クエリ パラメーターをに設定できる可能性のある値として Products が追加されました。Added Products as a possible value that you may set the category query parameter to. 市場別のカテゴリに関するページを参照してください。See Categories By Markets.

  • 最近の日付から並べられたトレンドのトピックを返す SortBy クエリ パラメーターが追加されました。Added the SortBy query parameter, which returns trending topics sorted by date with the most recent first.

  • Since クエリ パラメーターが追加されました。指定した Unix エポック タイムスタンプ以降に Bing によって検出されたトレンドのトピックを返します。Added the Since query parameter, which returns trending topics that were discovered by Bing on or after the specified Unix epoch timestamp.

オブジェクトの変更Object changes

  • mentions フィールドが NewsArticle オブジェクトに追加されました。Added the mentions field to the NewsArticle object. mentions フィールドには、記事で見つかったエンティティ (人物または場所) のリストが含まれています。The mentions field contains a list of entities (persons or places) that were found in the article.

  • video フィールドが NewsArticle オブジェクトに追加されました。Added the video field to the NewsArticle object. video フィールドには、ニュース記事に関連する動画が含まれています。The video field contains a video that's related to the news article. 動画は、埋め込むことができる <iframe> または動画のサムネイルのいずれかです。The video is either an <iframe> that you can embed or a motion thumbnail.

  • sort フィールドが News オブジェクトに追加されました。Added the sort field to the News object. sort フィールドには、記事の並べ替え順序が表示されます。The sort field shows the sort order of the articles. たとえば、記事は関連性 (既定) または日付順で並べ替えられます。For example, the articles are sorted by relevance (default) or date.

  • 並べ替え順序を定義する SortValue オブジェクトが追加されました。Added the SortValue object, which defines a sort order. isSelected フィールドは、応答が並べ替え順序を使用したかどうかを示します。The isSelected field indicates whether the response used the sort order. true の場合、応答は並べ替え順序を使用しました。If true, the response used the sort order. isSelectedfalse の場合、url フィールドの URL を使用して、別の並べ替え順序を要求できます。If isSelected is false, you can use the URL in the url field to request a different sort order.