カスタム Image Search API v7 リファレンスCustom Image Search API v7 reference

警告

Bing Search APIs は Cognitive Services から Bing Search サービスに移行しています。Bing Search APIs are moving from Cognitive Services to Bing Search Services. 2020 年10月 30 日以降、Bing Search の新しいインスタンスは、 ここに記載されている手順に従ってプロビジョニングする必要があります。Starting October 30, 2020 , any new instances of Bing Search need to be provisioned following the process documented here. Cognitive Services を使用してプロビジョニングされた Bing Search APIs は、次の3年間、またはマイクロソフトエンタープライズ契約の終わり (どちらか早い方) にサポートされます。Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. 移行手順については、「 Bing Search Services」を参照してください。For migration instructions, see Bing Search Services.

カスタム Image Search API を使用すると、Bing に検索クエリを送信し、カスタム検索インスタンスで定義されている Web のスライスから関連する画像の一覧を取得できます。The Custom Image Search API lets you send a search query to Bing and get back a list of relevant images from the slice of Web that your Custom Search instance defines. Custom Search インスタンスの構成については、「Configure your custom search experience」(カスタム検索エクスペリエンスの構成) をご覧ください。For information about configuring a Custom Search instance, see Configure your custom search experience.

要求に含めるヘッダーの詳細については、「 要求ヘッダー」を参照してください。For information about the headers that requests should include, see Request Headers.

要求に含める必要があるクエリパラメーターの詳細については、「 クエリパラメーター」を参照してください。For information about the query parameters that requests should include, see Query Parameters.

応答に含めることができる JSON 応答オブジェクトの詳細については、「 応答オブジェクト」を参照してください。For information about the JSON response objects that responses may include, see Response Objects.

結果の使用と表示の許可の詳細については、「 BING SEARCH API の使用と表示の要件」を参照してください。For information about permitted use and display of results, see Bing Search API Use and Display requirements.

注意

URL の書式とパラメーターは、予告なしで変更されることがあるため、すべての URL をそのまま使用してください。Because URL formats and parameters are subject to change without notice, use all URLs as-is. 明記されている場合を除いて、URL の書式またはパラメーターに依存しないでください。You should not take dependencies on the URL format or parameters except where noted.

エンドポイントEndpoints

Custom Search インスタンスからのイメージを要求するには、以下の URL に GET 要求を送信します。To request images from your Custom Search instance, send a GET request to the following URL:

https://api.cognitive.microsoft.com/bingcustomsearch/v7.0/images/search

要求では、HTTPS プロトコルを使う必要があります。The request must use the HTTPS protocol.

注意

URL の最大長は 2,048 文字です。The maximum URL length is 2,048 characters. URL の長さが上限を超えないよう、クエリ パラメーターの最大長は 1,500 文字未満にする必要があります。To ensure that your URL length does not exceed the limit, the maximum length of your query parameters should be less than 1,500 characters. URL が 2,048 文字を超えた場合、サーバーが 404 Not found を返します。If the URL exceeds 2,048 characters, the server returns 404 Not found.

ヘッダーHeaders

要求と応答に含まれる可能性があるヘッダーを次に示します。The following are the headers that a request and response may include.

ヘッダーHeader 説明Description
AcceptAccept 省略可能な要求ヘッダー。Optional request header.

既定のメディアの種類は application/json です。The default media type is application/json. 応答で JSON-LD が使用されるよう指定するには、Accept ヘッダーを application/ld+json に設定します。To specify that the response use JSON-LD, set the Accept header to application/ld+json.
Accept-LanguageAccept-Language 省略可能な要求ヘッダー。Optional request header.

ユーザー インターフェイス文字列に使用する言語のコンマ区切りリストです。A comma-delimited list of languages to use for user interface strings. リストでは優先度の高いものから順に指定します。The list is in decreasing order of preference. 有効な形式など、詳細については RFC2616 を参照してください。For more information, including expected format, see RFC2616.

このヘッダーと setLang クエリ パラメーターは相互に排他的なので、両方は指定しないでください。This header and the setLang query parameter are mutually exclusive—do not specify both.

このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。If you set this header, you must also specify the cc query parameter. 結果が返される市場を特定するために、Bing によってリストから検出された最初のサポート対象言語が使用され、それが cc パラメーター値と組み合わされます。To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. サポート対象言語がリストに含まれていない場合、要求がサポートされる最も近い言語と市場が Bing によって検出されるか、集計された市場または既定の市場が結果に使用されます。If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. Bing によって使用された市場を確認するには、BingAPIs-Market ヘッダーを調べます。To determine the market that Bing used, see the BingAPIs-Market header.

このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用します。Use this header and the cc query parameter only if you specify multiple languages. それ以外の場合は、mkt クエリ パラメーターおよび setLang クエリ パラメーターを使用します。Otherwise, use the mkt and setLang query parameters.

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。A user interface string is a string that's used as a label in a user interface. JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。There are few user interface strings in the JSON response objects. 応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。Any links to Bing.com properties in the response objects apply the specified language.
BingAPIs-MarketBingAPIs-Market 応答ヘッダー。Response header.

要求で使用された市場。The market used by the request. 形式は <languageCode>-<countryCode> です。The form is <languageCode>-<countryCode>. たとえば、en-US などです。For example, en-US.

市場コードに記載されていない市場を指定する場合、この値は、 mktクエリパラメーターで指定した市場とは異なる場合があります。If you specify a market that is not listed in Market Codes, this value may differ from the market you specified in the mkt query parameter. 照合できない cc および Accept 言語 の値を指定した場合も同様です。The same is true if you specify values for cc and Accept-Language that can't be reconciled.
BingAPIs-TraceIdBingAPIs-TraceId 応答ヘッダー。Response header.

要求の詳細が含まれたログ エントリの ID。The ID of the log entry that contains the details of the request. エラーが発生した場合、この ID をキャプチャします。When an error occurs, capture this ID. 問題を特定して解決できない場合は、その他の情報と共にこの ID をサポート チームに提供します。If you are not able to determine and resolve the issue, include this ID along with the other information that you provide the Support team.
Ocp-Apim-Subscription-KeyOcp-Apim-Subscription-Key 必須の要求ヘッダー。Required request header.

Cognitive Services でこのサービスにサインアップしたときに受け取ったサブスクリプション キーです。The subscription key that you received when you signed up for this service in Cognitive Services.
Retry-AfterRetry-After 応答ヘッダー。Response header.

応答には、1秒あたりに許可されるクエリの数 (QPS) または1か月 (QPM) を超える場合に、このヘッダーが含まれます。The response includes this header if you exceed the number of queries allowed per second (QPS) or per month (QPM). ヘッダーには、別の要求を送信する前に待機する必要がある秒数が含まれています。The header contains the number of seconds that you must wait before sending another request.
User-AgentUser-Agent 省略可能な要求ヘッダー。Optional request header.

要求送信元のユーザー エージェント。The user agent originating the request. Bing では、モバイル ユーザーに最適なエクスペリエンスを提供するためにユーザー エージェントが使用されます。Bing uses the user agent to provide mobile users with an optimized experience. 省略可能ですが、このヘッダーは常に指定することをお勧めします。Although optional, you are encouraged to always specify this header.

ユーザーエージェントは、よく使用されるブラウザーによって送信されるのと同じ文字列にする必要があります。The user-agent should be the same string that any commonly used browser sends. ユーザー エージェントについては、RFC 2616 を参照してください。For information about user agents, see RFC 2616.

ユーザーエージェント文字列の例を次に示します。The following are examples of user-agent strings.
  • Windows Phone — Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)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.1Android—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.20120423iPhone—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 GeckoPC—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.53iPad—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-ClientIDX-MSEdge-ClientID 省略可能な要求および応答ヘッダー。Optional request and response header.

このヘッダーは、Bing API の呼び出し間で一貫性のある動作をユーザーに提供するために Bing によって使用されます。Bing uses this header to provide users with consistent behavior across Bing API calls. Bing によって、新しい機能と改善点が頻繁にフライト化されます。そして、トラフィックを異なるフライトに割り当てるためのキーとして、クライアント ID が使用されます。Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. 複数の要求に対してユーザーの同じクライアント ID を使用しないと、ユーザーが複数の競合するフライトに割り当てられる可能性があります。If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスの一貫性がなくなる場合があります。Being assigned to multiple conflicting flights can lead to an inconsistent user experience. たとえば、2 番目の要求に 1 番目とは異なるフライトが割り当てられていると、エクスペリエンスが予期しないものになる可能性があります。For example, if the second request has a different flight assignment than the first, the experience may be unexpected. また、Bing はクライアント ID を使用して、クライアント ID の検索履歴に対して web の結果を調整することもできます。これにより、ユーザーのエクスペリエンスが向上します。Also, Bing can use the client ID to tailor web results to that client ID's search history, providing a richer experience for the user.

このヘッダーは、クライアント ID で生成されたアクティビティを分析して結果の順位付けを向上させるために Bing によって使用されることもあります。Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. 関連性の向上は、Bing API によって提供される結果の品質向上に役立ち、API コンシューマーのクリックスルー率の向上を実現します。The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer.

重要: このヘッダーは省略可能ですが、必須であると考える必要があります。IMPORTANT: Although optional, you should consider this header required. 同じエンド ユーザーとデバイスの組み合わせによる複数の要求に対してクライアント ID を保持することで、1) API コンシューマーが一貫性のあるユーザー エクスペリエンスを受け取ることができ、2) Bing API からの結果の品質向上を通じてクリックスルー率の向上が実現します。Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs.

このヘッダーに適用される基本的な使用規則を次に示します。The following are the basic usage rules that apply to this header.
  • デバイスでアプリケーションを使用する各ユーザーは、Bing によって生成された一意のクライアント ID を持っている必要があります。Each user that uses your application on the device must have a unique, Bing generated client ID.

    このヘッダーを要求に含めない場合、Bing によって ID が生成され、それが X-MSEdge-ClientID 応答ヘッダーで返されます。If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. このヘッダーを要求に含めるべきでない唯一の場合は、ユーザーがそのデバイスでアプリを初めて使用するときです。The only time that you should NOT include this header in a request is the first time the user uses your app on that device.

  • 注意: このクライアント ID は認証可能なユーザー アカウント情報にリンクできないようにする必要があります。ATTENTION: You must ensure that this Client ID is not linkable to any authenticatable user account information.

  • そのユーザーのためにアプリによってデバイスで実行される各 Bing API 要求で、クライアント ID を使用します。Use the client ID for each Bing API request that your app makes for this user on the device.

  • クライアント ID を保持します。Persist the client ID. ブラウザー アプリで ID を永続化するには、永続的な HTTP Cookie を使用して ID がすべてのセッションで確実に使用されるようにします。To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. セッション Cookie は使用しないようにしてください。Do not use a session cookie. モバイル アプリなど、他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。For other apps such as mobile apps, use the device's persistent storage to persist the ID.

    次にそのデバイスでユーザーがアプリを使用するときに、保持したクライアント ID を取得します。The next time the user uses your app on that device, get the client ID that you persisted.

注: Bing の応答には、このヘッダーが含まれる場合と含まれない場合があります。NOTE: Bing responses may or may not include this header. このヘッダーが応答に含まれる場合、クライアント ID をキャプチャして、ユーザーのためにそのデバイスで実行される後続のすべての Bing 要求でそれを使用します。If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device.

注: X-MSEdge-ClientID を含める場合、要求には Cookie を含めないようにしてください。NOTE: If you include the X-MSEdge-ClientID, you must not include cookies in the request.
X-MSEdge-ClientIPX-MSEdge-ClientIP 省略可能な要求ヘッダー。Optional request header.

クライアント デバイスの IPv4 アドレスまたは IPv6 アドレス。The IPv4 or IPv6 address of the client device. IP アドレスは、ユーザーの位置情報の検出に使用されます。The IP address is used to discover the user's location. 位置情報は、安全な検索動作を決定するために Bing によって使用されます。Bing uses the location information to determine safe search behavior.

注: 省略可能ですが、このヘッダーと X-Search-Location ヘッダーは常に指定することをお勧めします。NOTE: Although optional, you are encouraged to always specify this header and the X-Search-Location header.

(最後のオクテットを 0 に変更するなど) アドレスを難読化しないようにしてください。Do not obfuscate the address (for example, by changing the last octet to 0). アドレスを難読化すると、デバイスの実際の場所から離れた場所が検出され、Bing から誤った結果が提供される可能性があります。Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.
X-Search-LocationX-Search-Location 省略可能な要求ヘッダー。Optional request header.

クライアントの地理的な場所を示す、キーと値のペアのセミコロン区切りリストです。A semicolon-delimited list of key/value pairs that describe the client's geographical location. 位置情報は、安全な検索動作を決定して関連するローカル コンテンツを返すために、Bing によって使用されます。Bing uses the location information to determine safe search behavior and to return relevant local content. キーと値のペアは、<key>:<value> の形式で指定します。Specify the key/value pair as <key>:<value>. ユーザーの場所の指定に使用するキーは次のとおりです。The following are the keys that you use to specify the user's location.

  • lat — 必須。lat—Required. クライアントの場所の緯度です (度単位)。The latitude of the client's location, in degrees. 緯度は、-90.0 以上、+90.0 以下である必要があります。The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. 負の値は南半球の緯度を示し、正の値は北半球の緯度を示します。Negative values indicate southern latitudes and positive values indicate northern latitudes.

  • long — 必須。long—Required. クライアントの場所の経度です (度単位)。The longitude of the client's location, in degrees. 経度は、-180.0 以上、+180.0 以下である必要があります。The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. 負の値は西半球の経度を示し、正の値は東半球の経度を示します。Negative values indicate western longitudes and positive values indicate eastern longitudes.

  • re — 必須。re—Required. 座標の水平方向の精度を指定する半径 (m) です。The radius, in meters, which specifies the horizontal accuracy of the coordinates. デバイスの位置情報サービスによって返される値を渡します。Pass the value returned by the device's location service. 一般的な値は、GPS/Wi-Fi の 22 m、携帯電話基地局の三角測量の 380 m、IP 逆引き参照の 18,000 m などです。Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup.

  • ts — 省略可能。ts—Optional. クライアントがその場所にいたときの UTC UNIX タイムスタンプです。The UTC UNIX timestamp of when the client was at the location. (UNIX タイムスタンプは、1970 年 1 月 1 日からの経過秒数です)。(The UNIX timestamp is the number of seconds since January 1, 1970.)

  • head — 省略可能。head—Optional. クライアントの相対的な先頭方向または移動方向。The client's relative heading or direction of travel. 移動方向は、真北を基準として時計回りに 0 から 360 度で指定します。Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. このキーは、sp キーが 0 以外の場合にのみ指定します。Specify this key only if the sp key is nonzero.

  • sp — 省略可能。sp—Optional. クライアント デバイスが移動している水平方向の速度 (m/秒) です。The horizontal velocity (speed), in meters per second, that the client device is traveling.

  • alt — 省略可能。alt—Optional. クライアント デバイスの高度 (m) です。The altitude of the client device, in meters.

  • are — 省略可能。are—Optional. 座標の垂直方向の精度を指定する半径 (m)。The radius, in meters, that specifies the vertical accuracy of the coordinates. このキーは、alt キーを指定する場合にのみ指定します。Specify this key only if you specify the alt key.

  • 変位 — (省略可能)。disp—Optional. フォーム内のユーザーの地理的な場所 (変位: <City、州>)。The user's geographic location in the form, disp:<City, State>. たとえば、"変位: Seattle, ワシントン" のようになります。For example, disp:Seattle, Washington. これは、lat/長いキーを使用して指定したユーザーの場所の表示テキストバージョンです。This is the display text version of the user's location that you specified using the lat/long keys. この値が lat/long 座標と競合する場合、Bing では、ユーザーの場所として変位値が使用されます。If this value conflicts with the lat/long coordinates, Bing uses the disp value as the user's location.

注: Bing は、クエリに場所が含まれている場合、このヘッダーを無視します。NOTE: Bing ignores this header if the query includes a location. たとえば、このヘッダーにユーザーの場所がサンフランシスコとして反映されていて、クエリが レストラン seattle である場合、Bing はワシントン州シアトルにあるレストランを返します。For example, if this header reflects the user's location as San Francisco, but the query is restaurants seattle , Bing returns restaurants located in Seattle, Washington.

注: 多くのキーは省略可能ですが、提供する情報が多いほど、場所の結果の正確さが増します。NOTE: Although many of the keys are optional, the more information that you provide, the more accurate the location results are.

注: 省略可能ですが、ユーザーの地理的な場所は常に指定することをお勧めします。NOTE: Although optional, you are encouraged to always specify the user's geographical location. 位置情報を提供することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントによって VPN が使用されている場合) に特に重要です。Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). 最適な結果を得るには、このヘッダーと X-Search-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。For optimal results, you should include this header and the X-Search-ClientIP header, but at a minimum, you should include this header.

注意

利用規約ですべての該当法規 (これらのヘッダーの使用に関するものなど) への準拠が要求されていることに注意してください。Remember that the Terms of Use require compliance with all applicable laws, including regarding use of these headers. たとえば、ヨーロッパなどの特定の地域では、特定の追跡デバイスをユーザー デバイスに組み込む前に、ユーザーの同意を得る必要があります。For example, in certain jurisdictions, such as Europe, there are requirements to obtain user consent before placing certain tracking devices on user devices.

クエリ パラメーターQuery parameters

要求に含めることができるクエリパラメーターを次に示します。The following are the query parameters that a request may include. 必須のパラメーターについては、必須の列を参照してください。See the Required column for required parameters. クエリ パラメーターの値を URL エンコードする必要があります。You must URL encode the query parameter values. Bing が返す画像をフィルター処理するために使用するクエリパラメーターの詳細については、「 クエリパラメーターのフィルター選択」を参照してください。For information about query parameters that you use to filter the images that Bing returns, see Filter Query Parameters.

NameName Value Type 必須Required
cccc 結果の取得元となる国の2文字の国コード。A two-character country code of the country where the results come from. 使用可能な値の一覧については、「 マーケットコード」を参照してください。For a list of possible values, see Market Codes.

このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。If you set this parameter, you must also specify the Accept-Language header. Bing は、指定された言語で見つかった最初のサポートされている言語を使用し、国コードと組み合わせて、結果を返す市場を決定します。Bing uses the first supported language it finds in the specified languages and combines it with the country code to determine the market to return results for. 言語一覧にサポートされている言語が含まれない場合、Bing は要求をサポートする最も近い言語と市場を検索します。If the languages list does not include a supported language, Bing finds the closest language and market that supports the request. また、Bing は、結果に対して集計または既定の市場を使用する場合があります。Or, Bing may use an aggregated or default market for the results.

Accept-Language複数の言語を指定する場合にのみ、このクエリパラメーターとヘッダーを使用します。Use this query parameter and the Accept-Language header only if you specify multiple languages. それ以外の場合は、およびクエリパラメーターを使用する必要があり mkt setLang ます。Otherwise, you should use the mkt and setLang query parameters.

このパラメーターと mkt クエリ パラメーターは相互に排他的なので、両方指定することはできません。This parameter and the mkt query parameter are mutually exclusive—do not specify both.
StringString いいえNo
countcount 応答で返されるイメージの数。The number of images to return in the response. 配信される実際の数は、要求した数よりも少ない可能性があります。The actual number delivered may be less than requested. 既定値は 35 です。The default is 35. 最大値は150です。The maximum value is 150.

このパラメーターをパラメーターと共に使用して、 offset ページの結果を表示します。You use this parameter along with the offset parameter to page results. たとえば、ユーザーインターフェイスにページごとに20個のイメージが表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。For example, if your user interface displays 20 images per page, set count to 20 and offset to 0 to get the first page of results. それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。For each subsequent page, increment offset by 20 (for example, 0, 20, 40).
UnsignedShortUnsignedShort いいえNo
Customconfig.jsoncustomConfig カスタム検索インスタンスを識別する一意の識別子。Unique identifier that identifies your custom search instance.

StringString はいYes
mktmkt 結果の取得元の市場。The market where the results come from. 通常、 mkt は、ユーザーが要求を行っている国です。Typically, mkt is the country where the user is making the request from. ただし、Bing が結果を提供する国にユーザーがいない場合は、別の国である可能性があります。However, it could be a different country if the user is not located in a country where Bing delivers results. 市場は、という形式である必要があり <language code> - <country code> ます。The market must be in the form <language code>-<country code>. たとえば、en-US などです。For example, en-US. 文字列の大文字と小文字は区別されません。The string is case insensitive. 考えられる市場の値の一覧については、「 マーケットコード」を参照してください。For a list of possible market values, see Market Codes.

注: 既知の場合は、常に市場を指定することをお勧めします。NOTE: If known, you are encouraged to always specify the market. 市場を指定すると、Bing が要求をルーティングして最適な応答を返すのに役立ちます。Specifying the market helps Bing route the request and return an appropriate and optimal response. 市場コードに記載されていない市場を指定した場合、Bing は、変更される可能性のある内部マッピングに基づいて、最適な市場コードを使用します。If you specify a market that is not listed in Market Codes, Bing uses a best fit market code based on an internal mapping that is subject to change.

このパラメーターと cc クエリ パラメーターは相互に排他的なので、両方指定することはできません。This parameter and the cc query parameter are mutually exclusive—do not specify both.
StringString いいえNo
offsetoffset イメージを返す前にスキップするイメージの数を示す0から始まるオフセット。The zero-based offset that indicates the number of images to skip before returning images. 既定値は 0 です。The default is 0. オフセットは、(totalEstimatedMatches) よりも小さくする必要があり - count ます。The offset should be less than (totalEstimatedMatches - count).

結果をページに表示するには、パラメーターと共にこのパラメーターを使用し count ます。To page results, use this parameter along with the count parameter. たとえば、ユーザーインターフェイスにページごとに20個のイメージが表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。For example, if your user interface displays 20 images per page, set count to 20 and offset to 0 to get the first page of results. それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。For each subsequent page, increment offset by 20 (for example, 0, 20, 40).

複数のページに、結果に重複が含まれている可能性があります。It is possible for multiple pages to include some overlap in results. 重複を防ぐには、「 nextOffset」を参照してください。To prevent duplicates, see nextOffset.
Unsigned ShortUnsigned Short いいえNo
qq ユーザーの検索クエリ用語。The user's search query term. 用語を空にすることはできません。The term cannot be empty.

注: クエリ文字列に Bing Advanced Operatorsを含めることはできません。NOTE: The query string must not contain Bing Advanced Operators. これらを含めると、カスタム検索エクスペリエンスに悪影響を及ぼす可能性があります。Including them may adversely affect the custom search experience.
StringString はいYes
safeSearchsafeSearch アダルトコンテンツの画像をフィルター処理します。Filter images for adult content. 使用できるフィルター値は次のとおりです。The following are the possible filter values.
  • 無効 — にすると、成人向けコンテンツが返されます。Off—Return images with adult content.
  • 中程度 — の成人向けコンテンツを含む画像は含めないでください。Moderate—Don't include images with adult content.
  • 厳密 — には、アダルトコンテンツを含むイメージを含めないでください。Strict—Don't include images with adult content.

既定値は Moderate です。The default is Moderate.

注: safeSearch が Strict に設定されるよう Bing の成人向けコンテンツ ポリシーによって強制される市場が要求元の場合、Bing によって safeSearch の値が無視され、Strict が使用されます。NOTE: If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict.

注: site: クエリ演算子を使用している場合、safeSearch クエリ パラメーターの設定にかかわらず、成人向けのコンテンツが応答に含まれることがあります。NOTE: If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. site: は、そのサイト上のコンテンツがわかっていて、成人向けコンテンツが含まれていても問題のないシナリオの場合にのみ使用してください。Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.
StringString いいえNo
setLangsetLang ユーザー インターフェイス文字列に使用する言語。The language to use for user interface strings. 2文字または4文字のコードを使用して、言語を指定できます。You may specify the language using either a 2-letter or 4-letter code. 4文字のコードを使用することをお勧めします。Using 4-letter codes is preferred.

サポートされている言語コードの一覧については、「 Bing でサポートされる言語」を参照してください。For a list of supported language codes, see Bing supported languages.

setlangに有効な2文字のニュートラルカルチャコード ( fr ) または有効な4文字の特定のカルチャコード ( fr-fr ) が含まれている場合、Bing はローカライズされた文字列を読み込みます。Bing loads the localized strings if setlang contains a valid 2-letter neutral culture code ( fr ) or a valid 4-letter specific culture code ( fr-ca ). たとえば、 fr-fr の場合、Bing は、 fr-fr ニュートラルカルチャコード文字列を読み込みます。For example, for fr-ca , Bing loads the fr neutral culture code strings.

setlangが有効でない場合 (たとえば、 zh-tw ) や bing がこの言語をサポートしていない場合 (例: af , af-na )、bing の既定値は en (英語) です。If setlang is not valid (for example, zh ) or Bing doesn't support the language (for example, af , af-na ), Bing defaults to en (English).

2文字のコードを指定するには、このパラメーターを ISO 639-1 言語コードに設定します。To specify the 2-letter code, set this parameter to an ISO 639-1 language code.

4文字のコードを指定するに は、<国/地域> を使用します。ここで、 は iso 639-1 言語コード (ニュートラルカルチャ) で、<国/地域> は iso 3166 国/地域 (特定のカルチャ) コードです。To specify the 4-letter code, use the form -<country/region> where is an ISO 639-1 language code (neutral culture) and <country/region> is an ISO 3166 country/region (specific culture) code. たとえば、米国英語の場合は en-us を使用します。For example, use en-US for United States English.

省略可能ですが、常に言語を指定することをお勧めします。Although optional, you should always specify the language. ユーザー インターフェイス文字列が別の言語で表示されることをユーザーが望まない限り、通常、setLangmkt で指定されるのと同じ言語に設定します。Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language.

このパラメーターと Accept-Language ヘッダーは相互に排他的です。両方を指定することはできません。This parameter and the Accept-Language header are mutually exclusive—do not specify both.

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。A user interface string is a string that's used as a label in a user interface. JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。There are few user interface strings in the JSON response objects. また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。Also, any links to Bing.com properties in the response objects apply the specified language.
StringString いいえNo

クエリパラメーターのフィルター処理Filter query parameters

次に、Bing が返す画像をフィルター処理するために使用できるフィルタークエリパラメーター (省略可能) を示します。The following are the optional filter query parameters that you can use to filter the images that Bing returns. クエリ パラメーターは URL エンコードする必要があります。You must URL encode the query parameters.

名前Name Value Type
部分aspect 次の縦横比でイメージをフィルター処理します。Filter images by the following aspect ratios:
  • 正方形は — 標準の縦横比で画像を返しますSquare—Return images with standard aspect ratio
  • ワイド — 画面の縦横比を持つワイドリターン画像Wide—Return images with wide screen aspect ratio
  • —縦横比が高い高さの画像Tall—Return images with tall aspect ratio
  • すべて — の側面によるフィルター処理は行われません。All—Do not filter by aspect. この値の指定は、パラメーターを指定しない場合と同じです aspectSpecifying this value is the same as not specifying the aspect parameter.
StringString
color 次の色のオプションでイメージをフィルター処理します。Filter images by the following color options:
  • ColorOnly — 色の画像を返すColorOnly—Return color images
  • モノクロ — 画像を白黒で返すMonochrome—Return black and white images

次の主要な色のいずれかを使用してイメージを返します。Return images with one of the following dominant colors:
  • BlackBlack
  • Blue
  • BrownBrown
  • グレーGray
  • [緑]Green
  • オレンジOrange
  • ピンクPink
  • パープルPurple
  • [赤]Red
  • 青緑Teal
  • White
  • Yellow
StringString
上下height 指定された高さ (ピクセル単位) のイメージをフィルター処理します。Filter images that have the specified height, in pixels.

このフィルターをフィルターと共に使用して、 size 高さが150ピクセルの小さい画像を返すことができます。You may use this filter with the size filter to return small images that have a height of 150 pixels.
UnsignedShortUnsignedShort
imageContent 画像imageContent 次のコンテンツの種類でイメージをフィルター処理します。Filter images by the following content types:
  • —人物の顔のみを表示する顔の戻り画像Face—Return images that show only a person's face
  • —[縦] は、人の頭とショルダーのみを表示する画像を返しますPortrait—Return images that show only a person's head and shoulders
  • 縦向きでない場合は — 、ユーザーの頭とショルダーが表示されない画像を返します。NonPortrait—Return images that do not show a person's head and shoulders
StringString
imageTypeimageType 次のイメージの種類でイメージをフィルター処理:Filter images by the following image types:
  • AnimatedGif — アニメーション gif のみを返すAnimatedGif—Return only animated GIFs

  • —クリップアートのイメージのみを返すClipart—Return only clip art images

  • 行の改行 — のみの描画Line—Return only line drawings

  • 写真 — を返す (線の描画、アニメーション gif、クリップアートを除く)Photo—Return only photographs (excluding line drawings, animated Gifs, and clip art)

  • グラフィックス-グラフィックスイメージを返すGraphics—Return graphics images

  • ショッピングで — は、商品を販売しているマーチャントを Bing が認識しているアイテムを含む画像のみが返されます。Shopping—Return only images that contain items where Bing knows of a merchant that is selling the items. このオプションは、en-us 市場でのみ有効です。This option is valid in the en-US market only.

  • 透明 — 背景が透明な画像のみを返します。Transparent—Return only images with a transparent background.
StringString
使用license 次のライセンスの種類でイメージをフィルター処理:Filter images by the following license types:
  • 任意のライセンスの種類に該当 — するイメージを返します。Any—Return images that are under any license type. 応答には、ライセンスが指定されていないイメージや、ライセンスが不明なイメージは含まれません。The response doesn't include images that do not specify a license or the license is unknown.

  • 作成者が排他的な権利を放棄した公開イメージは、 — 法律によって認められた最大範囲になります。Public—Return images where the creator has waived their exclusive rights, to the fullest extent allowed by law.

  • —他のユーザーと共有される可能性のある返送画像を共有します。Share—Return images that may be shared with others. イメージを変更したり編集したりすることはできません。Changing or editing the image might not be allowed. また、商用目的でのイメージの変更、共有、および使用は許可されていない可能性があります。Also, modifying, sharing, and using the image for commercial purposes might not be allowed. 通常、このオプションは最も多くのイメージを返します。Typically, this option returns the most images.

  • —個人または商業目的で他のユーザーと共有されている可能性のある、商業用イメージを共有します。ShareCommercially—Return images that may be shared with others for personal or commercial purposes. イメージを変更したり編集したりすることはできません。Changing or editing the image might not be allowed.

  • —変更、共有、および使用される可能性がある復帰イメージを変更します。Modify—Return images that may be modified, shared, and used. イメージを変更したり編集したりすることはできません。Changing or editing the image might not be allowed. 商用目的でのイメージの変更、共有、および使用は許可されていない可能性があります。Modifying, sharing, and using the image for commercial purposes might not be allowed.

  • —個人または商業目的で変更、共有、使用する可能性のあるイメージを変更して返却します。ModifyCommercially—Return images that may be modified, shared, and used for personal or commercial purposes. 通常、このオプションは最も少ないイメージを返します。Typically, this option returns the fewest images.

  • すべて — のライセンスの種類でフィルター処理することはできません。All—Do not filter by license type. この値の指定は、パラメーターを指定しない場合と同じです licenseSpecifying this value is the same as not specifying the license parameter.

これらのライセンスの種類の詳細については、「 ライセンスの種類別にイメージをフィルター処理する」を参照してください。For more information about these license types, see Filter Images By License Type.
StringString
maxFileSizemaxFileSize 指定されたファイルサイズ以下のイメージをフィルター処理します。Filter images that are less than or equal to the specified file size.

指定できる最大ファイルサイズは520192バイトです。The maximum file size that you may specify is 520,192 bytes. より大きな値を指定すると、API は520192を使用します。If you specify a larger value, the API uses 520,192. 応答には、指定された最大値よりも少し大きい画像が含まれている可能性があります。It is possible that the response may include images that are slightly larger than the specified maximum.

このフィルターを指定したり、 minFileSize ファイルサイズの範囲内のイメージをフィルター処理したりすることができます。You may specify this filter and minFileSize to filter images within a range of file sizes.
IntegerInteger
maxHeightmaxHeight 高さが指定した高さ以下のイメージをフィルター処理します。Filter images that have a height that is less than or equal to the specified height. 高さをピクセル単位で指定します。Specify the height in pixels.

このフィルターを指定して、 minHeight 高さの範囲内のイメージをフィルター処理することができます。You may specify this filter and minHeight to filter images within a range of heights.

このフィルターと height フィルターは相互に排他的です。This filter and the height filter are mutually exclusive.
IntegerInteger
maxWidthmaxWidth 指定した幅以下の幅を持つイメージをフィルター処理します。Filter images that have a width that is less than or equal to the specified width. 幅をピクセル単位で指定します。Specify the width in pixels.

このフィルターを指定して、 maxWidth 幅の範囲内のイメージをフィルター処理することができます。You may specify this filter and maxWidth to filter images within a range of widths.

このフィルターと width フィルターは相互に排他的です。This filter and the width filter are mutually exclusive.
IntegerInteger
minFileSize サイズminFileSize 指定されたファイルサイズ以上のイメージをフィルター処理します。Filter images that are greater than or equal to the specified file size.

指定できる最大ファイルサイズは520192バイトです。The maximum file size that you may specify is 520,192 bytes. より大きな値を指定すると、API は520192を使用します。If you specify a larger value, the API uses 520,192. 応答には、指定した最小値より若干小さい画像が含まれている可能性があります。It is possible that the response may include images that are slightly smaller than the specified minimum.

このフィルターを指定したり、 maxFileSize ファイルサイズの範囲内のイメージをフィルター処理したりすることができます。You may specify this filter and maxFileSize to filter images within a range of file sizes.
IntegerInteger
minHeightminHeight 高さが指定した高さ以上のイメージをフィルター処理します。Filter images that have a height that is greater than or equal to the specified height. 高さをピクセル単位で指定します。Specify the height in pixels.

このフィルターを指定して、 maxHeight 高さの範囲内のイメージをフィルター処理することができます。You may specify this filter and maxHeight to filter images within a range of heights.

このフィルターと height フィルターは相互に排他的です。This filter and the height filter are mutually exclusive.
IntegerInteger
minWidthminWidth 指定された幅以上の幅を持つイメージをフィルター処理します。Filter images that have a width that is greater than or equal to the specified width. 幅をピクセル単位で指定します。Specify the width in pixels.

このフィルターを指定して、 maxWidth 幅の範囲内のイメージをフィルター処理することができます。You may specify this filter and maxWidth to filter images within a range of widths.

このフィルターと width フィルターは相互に排他的です。This filter and the width filter are mutually exclusive.
IntegerInteger
size 次のサイズでイメージをフィルター処理します。Filter images by the following sizes:
  • 200 — x 200 ピクセル未満の小さい返される画像Small—Return images that are less than 200x200 pixels

  • 200 — x 200 ピクセル以上で500x500 ピクセル未満のメディアを返します。Medium—Return images that are greater than or equal to 200x200 pixels but less than 500x500 pixels

  • —500x500 ピクセル以上の大きい戻り画像Large—Return images that are 500x500 pixels or larger

  • 壁紙は — 壁紙イメージを返します。Wallpaper—Return wallpaper images.

  • すべて — のサイズでフィルター処理されません。All—Do not filter by size. この値の指定は、パラメーターを指定しない場合と同じです sizeSpecifying this value is the same as not specifying the size parameter.

このパラメーター height は、パラメーターまたはパラメーターと共に使用でき width ます。You may use this parameter along with the height or width parameters. たとえば、とを使用して、 height size 高さ150ピクセルの小さい画像を要求することができます。For example, you may use height and size to request small images that are 150 pixels tall.
StringString
width 指定された幅を持つイメージをピクセル単位でフィルター処理します。Filter images that have the specified width, in pixels.

このフィルターをフィルターと共に使用すると、 size 幅が150ピクセルの小さい画像を返すことができます。You may use this filter with the size filter to return small images that have a width of 150 pixels.
UnsignedShortUnsignedShort

応答オブジェクトResponse objects

注意

フランスの新しい EU の著作権指令に準拠するには、Bing Web、News、Video、Image、およびすべてのカスタム検索 Api で、フランス語のユーザーの特定の EU ニュースソースからのコンテンツをすべて省略する必要があります。To comply with the new EU Copyright Directive in France, the Bing Web, News, Video, Image and all Custom Search APIs must omit some content from certain EU News sources for French users. 削除されたコンテンツには、サムネイル画像、ビデオ、ビデオプレビュー、およびこれらのソースからの検索結果に付随するスニペットが含まれる場合があります。The removed content may include thumbnail images and videos, video previews, and snippets which accompany search results from these sources. その結果、Bing Api は、サムネイル画像とビデオ、ビデオプレビュー、およびフランス語のユーザーへのスニペットを使用して、より多くの結果を提供することができます。As a consequence, the Bing APIs may serve fewer results with thumbnail images and videos, video previews, and snippets to French users.

応答に含めることができる JSON オブジェクトを次に示します。The following are the JSON objects that the response may include. 要求が成功すると、応答の最上位レベルのオブジェクトが Images オブジェクトになります。If the request succeeds, the top-level object in the response is the Images object. 要求が失敗した場合、最上位レベルのオブジェクトは ErrorResponse オブジェクトになります。If the request fails, the top-level object is the ErrorResponse object.

ObjectObject 説明Description
ErrorError 発生したエラーを定義します。Defines an error that occurred.
ErrorResponseErrorResponse 要求が失敗したときの応答に含まれている最上位レベルのオブジェクト。The top-level object that the response includes when the request fails.
ImageImage クエリに関連するイメージを定義します。Defines an image that is relevant to the query.
イメージImages イメージ要求が成功したときに応答に含まれるトップレベルのオブジェクト。The top-level object that the response includes when an image request succeeds.
MediaSizeMediaSize メディアコンテンツのサイズを定義します。Defines the size of the media content.
インストルメンテーションInstrumentation Bing インストルメンテーション Url を定義します。Defines the Bing instrumentation URLs.
ピボットPivot ピボットセグメントを定義します。Defines the pivot segment.
クエリQuery 検索クエリ文字列を定義します。Defines a search query string.
サムネイルThumbnail サムネイル画像を定義します。Defines a thumbnail image.

エラーError

発生したエラーを定義します。Defines the error that occurred.

要素Element 説明Description TypeType
codecode エラーのカテゴリを特定するエラー コード。The error code that identifies the category of error. 考えられるコードの一覧については、「エラー コード」を参照してください。For a list of possible codes, see Error Codes. StringString
messagemessage エラーの説明。A description of the error. StringString
moreDetailsmoreDetails エラーに関する追加情報を提供する説明。A description that provides additional information about the error. StringString
parameterparameter エラーを引き起こした要求内のクエリ パラメーター。The query parameter in the request that caused the error. StringString
subCodesubCode エラーを特定するエラー コード。The error code that identifies the error. たとえば、code が InvalidRequest の場合、subCode は ParameterInvalid か ParameterInvalidValue の場合があります。For example, if code is InvalidRequest, subCode may be ParameterInvalid or ParameterInvalidValue. StringString
valuevalue 有効でなかったクエリ パラメーター値。The query parameter's value that was not valid. StringString

ErrorResponseErrorResponse

要求が失敗したときの応答に含まれている最上位レベルのオブジェクト。The top-level object that the response includes when the request fails.

名前Name Value TypeType
_type_type 種類のヒント。Type hint. StringString
errorserrors 要求が失敗した理由を示すエラーの一覧。A list of errors that describe the reasons why the request failed. Error[]Error[]

ImageImage

クエリに関連するイメージを定義します。Defines an image that is relevant to the query.

注意

URL 形式とパラメーターは予告なしに変更される可能性があるため、すべての Url をそのまま使用します。Because the URL format and parameters are subject to change without notice, use all URLs as-is. URL 形式またはパラメーターに依存しないようにする必要があります。You should not take dependencies on the URL format or parameters. 例外は、 サムネイルイメージのサイズ変更とトリミングによって説明されているパラメーターと値です。The exception is those parameters and values discussed by Resize and crop thumbnail images.

NameName Value Type
アクセント色accentColor イメージを優先する色を表す3バイトの16進数。A three-byte hexadecimal number that represents the color that dominates the image. イメージが読み込まれるまで、クライアントの一時的な背景として色を使用します。Use the color as the temporary background in your client until the image is loaded. StringString
contentSizecontentSize イメージのファイルサイズ。The image's file size. 文字列の形式は {size} {units} です。The format of the string is {size} {units}. たとえば、12345 B は、イメージのサイズが12345バイトであることを示します。For example, 12345 B indicates that the size of the image is 12,345 bytes. StringString
contentUrlcontentUrl ソース web サイト上のイメージの URL。The URL to the image on the source website. StringString
datePublisheddatePublished Bing が画像を検出した日付と時刻 (UTC)。The date and time, in UTC, that Bing discovered the image. 日付は YYYY-MM-YYYY-MM-DDTHH: MM: SS という形式になっています。The date is in the format, YYYY-MM-DDTHH:MM:SS. StringString
encodingFormatencodingFormat イメージの mime の種類 (jpeg など)。The image's mime type (for example, jpeg). StringString
上下height ソースイメージの高さ (ピクセル単位)。The height of the source image, in pixels. Unsigned ShortUnsigned Short
hostPageDisplayUrlhostPageDisplayUrl 画像をホストする web ページの表示 URL。The display URL of the webpage that hosts the image.

ユーザーインターフェイスでこの URL を使用して、イメージを含むホスト web ページを識別します。Use this URL in your user interface to identify the host webpage that contains the image. URL は適切な形式ではないため、ホストの web ページにアクセスするためには使用しないでください。The URL is not a well-formed and should not be used to access the host webpage. ホストの web ページにアクセスするには、URL を使用し hostPageUrl ます。To access the host webpage, use the hostPageUrl URL.
StringString
hostPageUrlhostPageUrl 画像を含む web ページの URL。The URL of the webpage that includes the image.

この URL とは contentUrl 同じ url でもかまいません。This URL and contentUrl may be the same URL.
StringString
imageIdimageId このイメージを一意に識別する ID。An ID that uniquely identifies this image. イメージを応答の最初のイメージにする場合は、要求で id クエリパラメーターをこの ID に設定します。If you want the image to be the first image in the response, set the id query parameter to this ID in your request. StringString
namename 画像のタイトル。A title of the image. StringString
画像thumbnail サムネイルイメージの幅と高さ (「」を参照 thumbnailUrl )。The width and height of the thumbnail image (see thumbnailUrl). MediaSizeMediaSize
thumbnailUrlthumbnailUrl イメージのサムネイルの URL。The URL to a thumbnail of the image. 画像のサイズ変更の詳細については、「 サムネイル画像のサイズ変更とトリミング」を参照してください。For information about resizing the image, see Resize and crop thumbnail images. StringString
webSearchUrlwebSearchUrl このイメージの Bing 検索結果の URL。The URL to the Bing search results for this image. StringString
width ソースイメージの幅 (ピクセル単位)。The width of the source image, in pixels. Unsigned ShortUnsigned Short

イメージImages

イメージ要求が成功したときに応答に含まれるトップレベルのオブジェクト。The top-level object that the response includes when an image request succeeds.

NameName Value TypeType
_type_type Type ヒント。 Images に設定されています。A type hint, which is set to Images. StringString
nextOffsetnextOffset オフセットクエリパラメーターを設定するオフセット値。The offset value that you set the offset query parameter to.

offset最初の要求でを0に、を30に設定し、2番目の要求で30に設定した場合、 count offset 2 番目の応答の結果の一部が最初の応答と重複している可能性があります。If you set offset to 0 and count to 30 in your first request, and then set offset to 30 in your second request, some of the results in the second response may be duplicates of the first response.

重複を防ぐには、を offset の値に設定 nextOffset します。To prevent duplicates, set offset to the value of nextOffset.
IntegerInteger
pivotSuggestionspivotSuggestions 元のクエリ内のセグメントのリスト。A list of segments in the original query. たとえば、クエリが 赤の花 である場合、Bing はクエリを に分割することがあります。For example, if the query was Red Flowers , Bing might segment the query into Red and Flowers .

花 pivot には、赤の Peonies や Red などのクエリ候補が含まれる場合があります。また、Red pivot には、緑の花や黄色の花などのクエリ候補が含まれる場合があります。The Flowers pivot may contain query suggestions such as Red Peonies and Red Daisies, and the Red pivot may contain query suggestions such as Green Flowers and Yellow Flowers.
ピボットPivot
queryExpansionsqueryExpansions 元のクエリを絞り込む、展開されたクエリの一覧。A list of expanded queries that narrows the original query. たとえば「 Microsoft Surface 」というクエリは、Microsoft Surface Pro 3 、Microsoft Surface RT 、Microsoft Surface Phone 、Microsoft Surface Hub に展開される可能性があります。For example, if the query was Microsoft Surface , the expanded queries might be: Microsoft Surface Pro 3 , Microsoft Surface RT , Microsoft Surface Phone , and Microsoft Surface Hub . クエリQuery
similarTermssimilarTerms ユーザーのクエリ用語と意味が似た用語の一覧。A list of terms that are similar in meaning to the user's query term. クエリQuery
totalEstimatedMatchestotalEstimatedMatches クエリに関連するイメージの推定数。The estimated number of images that are relevant to the query. この数値を カウント および オフセット クエリパラメーターと共に使用して、結果をページします。Use this number along with the count and offset query parameters to page the results.

このフィールドは、Image Search API にのみ含まれます。Only the Image Search API includes this field.
LongLong
valuevalue クエリに関連するイメージの一覧。A list of images that are relevant to the query.

結果がない場合、配列は空になります。If there are no results, the array is empty.
イメージ[]Image[]
webSearchUrlwebSearchUrl 要求されたイメージの Bing 検索結果の URL。The URL to the Bing search results for the requested images. StringString

MediaSizeMediaSize

メディアコンテンツのサイズを定義します。Defines the size of the media content.

NameName Value Type
体高height メディアコンテンツの高さ (ピクセル単位)。The height of the media content, in pixels. IntegerInteger
widthwidth メディアコンテンツの幅 (ピクセル単位)。The width of the media content, in pixels. IntegerInteger

ピボットPivot

ピボットセグメントを定義します。Defines the pivot segment.

NameName Value Type
旋回pivot ピボットする元のクエリからのセグメント。The segment from the original query to pivot on. StringString
アドバイスsuggestions ピボットに関して推奨されるクエリの一覧。A list of suggested queries for the pivot. クエリQuery

クエリQuery

検索クエリ文字列を定義します。Defines a search query string.

NameName Value Type
displayTextdisplayText クエリ用語の表示バージョン。The display version of the query term.

展開されたクエリ (「 Queryexpansions」を参照) とピボット候補 (「 pivotsuggestions」を参照) では、このフィールドによって、元のクエリを展開した用語が識別されます。For expanded queries (see queryExpansions) and pivot suggestions (see pivotSuggestions), this field identifies the term that expanded the original query. たとえば、クエリが Microsoft surface で、拡張されたクエリが microsoft surface rt の場合、には displayText RT が含まれます。For example, if the query was Microsoft Surface and the expanded query is Microsoft Surface RT , displayText would contain RT .
StringString
searchLinksearchLink 関連検索の結果を取得するために使用する URL。The URL that you use to get the results of the related search. URL を使用する前に、必要に応じてクエリパラメーターを追加し、 Ocp ヘッダーを含める必要があります。Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.

独自のユーザーインターフェイスに結果を表示している場合は、この URL を使用します。Use this URL if you're displaying the results in your own user interface. それ以外の場合は、URL を使用し webSearchUrl ます。Otherwise, use the webSearchUrl URL.
StringString
texttext クエリ用語。The query term. StringString
thumbnailthumbnail 関連するイメージのサムネイルの URL。The URL to a thumbnail of a related image.

オブジェクトには、ピボット候補および関連する検索に対してのみこのフィールドが含まれます。The object includes this field only for pivot suggestions and related searches.
サムネイルThumbnail
webSearchUrlwebSearchUrl ユーザーがクエリの Bing の検索結果ページに移動する URL。The URL that takes the user to the Bing search results page for the query.

ユーザーインターフェイスに結果が表示されない場合は、この URL を使用します。Use this URL if you're not displaying the results in your own user interface. それ以外の場合は、URL を使用し searchUrl ます。Otherwise, use the searchUrl URL.

関連する検索にのみ含まれます。Included only for related searches.
StringString

サムネイルThumbnail

画像のサムネイルを定義します。Defines a thumbnail of an image.

要素Element 説明Description TypeType
urlurl イメージのサムネイルの URL。The URL to a thumbnail of an image. StringString

エラー コードError codes

要求によって返される可能性のある HTTP 状態コードを次に示します。The following are the possible HTTP status codes that a request returns.

状態コードStatus Code 説明Description
200200 正常終了しました。Success.
400400 クエリ パラメーターの 1 つが欠落しているか無効です。One of the query parameters is missing or not valid.
401401 サブスクリプション キーが見つからないか、無効です。The subscription key is missing or is not valid.
403403 (たとえば、有効なサブスクリプション キーを使用して) ユーザーは認証されたものの、要求されたリソースへのアクセス許可がありません。The user is authenticated (for example, they used a valid subscription key) but they don’t have permission to the requested resource.

また、呼び出し元が 1 か月あたりのクエリ数のクォータを超えた場合にも、Bing はこの状態を返します。Bing may also return this status if the caller exceeded their queries per month quota.
410410 HTTPS プロトコルではなく HTTP プロトコルが使用された要求。The request used HTTP instead of the HTTPS protocol. サポートされるプロトコルは HTTPS のみです。HTTPS is the only supported protocol.
429429 呼び出し元が 1 秒あたりのクエリ数のクォータを超えました。The caller exceeded their queries per second quota.
500500 予期しないサーバー エラー。Unexpected server error.

要求が失敗すると、応答に ErrorResponse オブジェクトが含まれます。このオブジェクトには、エラーの原因を示す Error オブジェクトの一覧が含まれています。If the request fails, the response contains an ErrorResponse object, which contains a list of Error objects that describe what caused of error. エラーがパラメーターに関連している場合、parameter フィールドで、問題であるパラメーターが特定されます。If the error is related to a parameter, the parameter field identifies the parameter that is the issue. エラーがパラメーター値に関連している場合、value フィールドで、無効な値が特定されます。And if the error is related to a parameter value, the value field identifies the value that is not valid.

{
  "_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."
    }
  ]
}

考えられるエラー コードとサブエラー コードの値を次に示します。The following are the possible error code and sub-error code values.

コードCode サブコードSubCode 説明Description
ServerErrorServerError UnexpectedErrorUnexpectedError
ResourceErrorResourceError
NotImplementedNotImplemented
HTTP 状態コードは 500 です。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.

HTTPS プロトコルではなく HTTP プロトコルを使用すると、Bing は HttpNotAllowed を返し、HTTP 状態コードは 410 になります。If you use the HTTP protocol instead of HTTPS, Bing returns HttpNotAllowed, and the HTTP status code is 410.
RateLimitExceededRateLimitExceeded No sub-codesNo sub-codes 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 を超えた場合、Bing は 403 を返します。If you exceed QPS, Bing returns HTTP status code 429, and if you exceed QPM, Bing returns 403.
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.

市場コードMarket codes

次の表に、クエリパラメーターの指定に使用できる市場コードの値を示し mkt ます。The following table lists the market code values that you may use to specify the mkt query parameter. Bing はこれらの市場に対してのみコンテンツを返します。Bing returns content for only these markets. 一覧は変更されることがあります。The list is subject to change.

クエリパラメーターで指定できる国コードの一覧につい cc ては、「 国コード」を参照してください。For a list of country codes that you may specify in the cc query parameter, see Country codes.

国/地域Country/Region LanguageLanguage 市場コードMarket code
アルゼンチンArgentina スペイン語Spanish es-ARes-AR
オーストラリアAustralia 英語English en-AUen-AU
オーストリアAustria ドイツ語German de-ATde-AT
ベルギーBelgium オランダ語Dutch nl-BEnl-BE
ベルギーBelgium フランス語French fr-BEfr-BE
ブラジルBrazil PortuguesePortuguese pt-BRpt-BR
CanadaCanada 英語English en-CAen-CA
CanadaCanada フランス語French fr-CAfr-CA
チリChile スペイン語Spanish es-CLes-CL
デンマークDenmark デンマーク語Danish da-DKda-DK
フィンランドFinland フィンランド語Finnish fi-FIfi-FI
フランスFrance フランス語French fr-FRfr-FR
ドイツGermany ドイツ語German de-DEde-DE
香港特別行政区Hong Kong SAR Traditional ChineseTraditional Chinese zh-HKzh-HK
インドIndia 英語English en-INen-IN
インドネシアIndonesia 英語English en-IDen-ID
イタリアItaly イタリア語Italian it-ITit-IT
日本Japan 日本語Japanese ja-JPja-JP
韓国Korea 韓国語Korean ko-KRko-KR
マレーシアMalaysia 英語English en-MYen-MY
メキシコMexico スペイン語Spanish es-MXes-MX
オランダNetherlands オランダ語Dutch nl-NLnl-NL
ニュージーランドNew Zealand 英語English en-NZen-NZ
中華人民共和国People's republic of China ChineseChinese zh-CNzh-CN
ポーランドPoland ポーランド語Polish pl-PLpl-PL
ポルトガルPortugal PortuguesePortuguese pt-PTpt-PT
フィリピン共和国Republic of the Philippines 英語English en-PHen-PH
ロシアRussia ロシア語Russian ru-RUru-RU
サウジアラビアSaudi Arabia アラビア語Arabic ar-SAar-SA
南アフリカSouth Africa 英語English en-ZAen-ZA
スペインSpain スペイン語Spanish es-ESes-ES
スウェーデンSweden スウェーデン語Swedish sv-SEsv-SE
スイスSwitzerland フランス語French fr-CHfr-CH
スイスSwitzerland ドイツ語German de-CHde-CH
台湾Taiwan Traditional ChineseTraditional Chinese zh-TWzh-TW
トルコTurkey トルコ語Turkish tr-TRtr-TR
イギリスUnited Kingdom 英語English en-GBen-GB
United StatesUnited States 英語English ja-JPen-US
United StatesUnited States スペイン語Spanish es-USes-US

国コードCountry codes

cc クエリ パラメーターで指定できる国番号を次に示します。The following are the country codes that you may specify in the cc query parameter. 一覧は変更されることがあります。The list is subject to change.

国/地域Country/Region 国番号Country code
アルゼンチンArgentina ARAR
オーストラリアAustralia AUAU
オーストリアAustria ATAT
ベルギーBelgium BEBE
ブラジルBrazil BRBR
CanadaCanada CACA
チリChile CLCL
デンマークDenmark DKDK
フィンランドFinland FIFI
フランスFrance FRFR
ドイツGermany DEDE
香港特別行政区Hong Kong SAR HKHK
インドIndia ININ
インドネシアIndonesia idID
イタリアItaly ITIT
日本Japan JPJP
韓国Korea KRKR
マレーシアMalaysia MYMY
メキシコMexico MXMX
オランダNetherlands NLNL
ニュージーランドNew Zealand NZNZ
ノルウェーNorway NONO
中華人民共和国People's Republic of China CNCN
ポーランドPoland PLPL
ポルトガルPortugal PTPT
フィリピン共和国Republic of the Philippines PHPH
ロシアRussia RURU
サウジアラビアSaudi Arabia SASA
南アフリカSouth Africa ZAZA
スペインSpain ESES
スウェーデンSweden SESE
スイスSwitzerland CHCH
台湾Taiwan TWTW
トルコTurkey TRTR
イギリスUnited Kingdom GBGB
United StatesUnited States USUS

Bing でサポートされる言語Bing supported languages

クエリ パラメーターで指定できるBingサポートされる言語を次にsetLang示します。The following are the Bing supported languages that you may specify in the setLang query parameter. 一覧は変更されることがあります。The list is subject to change.

サポートされている言語Supported Languages 言語コードLanguage Code
アラビア語Arabic arar
バスク語Basque eueu
ベンガル語Bengali bnbn
BulgarianBulgarian bgbg
カタロニア語Catalan caca
簡体中国語Chinese (Simplified) zh-hanszh-hans
繁体中国語Chinese (Traditional) zh-hantzh-hant
CroatianCroatian hrhr
CzechCzech cscs
DanishDanish dada
DutchDutch nlnl
EnglishEnglish enen
イギリス-イギリスEnglish-United Kingdom en-gben-gb
EstonianEstonian etet
FinnishFinnish fifi
FrenchFrench frfr
ガリシア語Galician glgl
GermanGerman dede
グジャラート語Gujarati gugu
ヘブライ語Hebrew hehe
ヒンディー語Hindi hihi
HungarianHungarian huhu
アイスランド語Icelandic isis
ItalianItalian itit
JapaneseJapanese Jpjp
カンナダ語Kannada knkn
KoreanKorean koko
LatvianLatvian lvlv
LithuanianLithuanian ltlt
マレー語Malay msms
マラヤーラム語Malayalam  mlml
マラーティー語Marathi mrmr
ノルウェー語 (ブークモール)Norwegian (Bokmål) nbnb
PolishPolish plpl
ポルトガル語 (ブラジル)Portuguese (Brazil) pt-brpt-br
ポルトガル語 (ポルトガル)Portuguese (Portugal) pt-ptpt-pt
パンジャーブ語Punjabi papa
RomanianRomanian roro
RussianRussian ruru
セルビア語 (キリリック)Serbian (Cyrylic) srsr
SlovakSlovak sksk
SlovenianSlovenian slsl
SpanishSpanish eses
SwedishSwedish svsv
タミル語Tamil tata
テルグ語Telugu tete
ThaiThai thth
TurkishTurkish trtr
ウクライナ語Ukrainian ukuk
ベトナム語Vietnamese vivi