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

このアップグレード ガイドでは、Bing Video Search API のバージョン 5 とバージョン 7 の間の変更を識別します。This upgrade guide identifies the changes between version 5 and version 7 of the Bing Video 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/videos/search 」のように入力します。For example, https://api.cognitive.microsoft.com/bing/v7.0/videos/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 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

クエリ パラメーターQuery parameters

  • modulesRequested クエリ パラメーターの名前が modules に変更されました。Renamed the modulesRequested query parameter to modules.

オブジェクトの変更Object changes

  • VideosnextOffsetAddCount フィールドの名前が nextOffset に変更されました。Renamed the nextOffsetAddCount field of Videos to nextOffset. オフセットを使用する方法も変更されています。The way you use the offset has also changed. 以前は、オフセット クエリ パラメーターを値 nextOffset と、前のオフセット値と、結果のビデオの数に設定していました。Previously, you would set the offset query parameter to the nextOffset value plus the previous offset value plus the number of videos in the result. 現在は、offset クエリ パラメーターを値 nextOffset に設定するだけです。Now, you simply set the offset query parameter to the nextOffset value.

  • relatedVideos フィールドのデータ型を Video[] から VideosModule に変更しました (VideoDetails を参照)。Changed the data type of the relatedVideos field from Video[] to VideosModule (see VideoDetails).