Image Search API v7 リファレンス

警告

Bing Search APIs は Cognitive Services から Bing Search サービスに移行しています。 2020 年10月 30 日以降、Bing Search の新しいインスタンスは、 ここに記載されている手順に従ってプロビジョニングする必要があります。 Cognitive Services を使用してプロビジョニングされた Bing Search APIs は、次の3年間、またはマイクロソフトエンタープライズ契約の終わり (どちらか早い方) にサポートされます。 移行手順については、「 Bing Search Services」を参照してください。

Image Search API を使用すると、Bing に検索クエリを送信し、関連する画像の一覧を取得できます。 ここでは、イメージを要求するために使用するクエリパラメーターとヘッダー、およびそれらを含む JSON 応答オブジェクトに関する技術的な詳細について説明します。 要求の作成方法を示す例については、「 Web でイメージを検索する」を参照してください。

要求に含めるヘッダーの詳細については、「 要求ヘッダー」を参照してください。

要求に含める必要があるクエリパラメーターの詳細については、「 クエリパラメーター」を参照してください。

応答に含めることができる JSON 応答オブジェクトの詳細については、「 応答オブジェクト」を参照してください。

結果の使用と表示の許可の詳細については、「 BING SEARCH API の使用と表示の要件」を参照してください。

注意

URL の書式とパラメーターは、予告なしで変更されることがあるため、すべての URL をそのまま使用してください。 明記されている場合を除いて、URL の書式またはパラメーターに依存しないでください。

エンドポイント

イメージを要求するには、GET 要求を次の Url のいずれかに送信します。

エンドポイント 説明
https://api.cognitive.microsoft.com/bing/v7.0/images/search ユーザー検索クエリに関連する画像を返します。
https://api.cognitive.microsoft.com/bing/v7.0/images/details 画像を含む Web ページなど、画像に関する分析情報を返します。
https://api.cognitive.microsoft.com/bing/v7.0/images/trending 他のユーザーが行った検索要求に基づく注目の画像を返します。 画像は、さまざまなカテゴリに分類されます。 たとえば、人気のある方が検索します。

注目の画像をサポートする市場の一覧については、注目の画像に関する記事をご覧ください。

マルチサービスサブスクリプションの場合は、URL にリージョンを含める必要があります。 例: westus.api.cognitive.microsoft.com。 サポートされているリージョンを参照してください。

要求では、HTTPS プロトコルを使う必要があります。

注意

URL の最大長は 2,048 文字です。 URL の長さが上限を超えないよう、クエリ パラメーターの最大長は 1,500 文字未満にする必要があります。 URL が 2,048 文字を超えた場合、サーバーが 404 Not found を返します。

ヘッダー

要求と応答に含まれる可能性があるヘッダーを次に示します。

ヘッダー 説明
Accept 省略可能な要求ヘッダー。

既定のメディアの種類は application/json です。 応答で JSON-LD が使用されるよう指定するには、Accept ヘッダーを application/ld+json に設定します。
Accept-Language 省略可能な要求ヘッダー。

ユーザー インターフェイス文字列に使用する言語のコンマ区切りリストです。 リストでは優先度の高いものから順に指定します。 有効な形式など、詳細については RFC2616 を参照してください。

このヘッダーと setLang クエリ パラメーターは相互に排他的なので、両方は指定しないでください。

このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。 結果が返される市場を特定するために、Bing によってリストから検出された最初のサポート対象言語が使用され、それが cc パラメーター値と組み合わされます。 サポート対象言語がリストに含まれていない場合、要求がサポートされる最も近い言語と市場が Bing によって検出されるか、集計された市場または既定の市場が結果に使用されます。 Bing によって使用された市場を確認するには、BingAPIs-Market ヘッダーを調べます。

このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用します。 それ以外の場合は、mkt クエリ パラメーターおよび setLang クエリ パラメーターを使用します。

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。 応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。
BingAPIs-Market 応答ヘッダー。

要求で使用された市場。 形式は <languageCode>-<countryCode> です。 たとえば、en-US などです。

市場コードに記載されていない市場を指定する場合、この値は、 mktクエリパラメーターで指定した市場とは異なる場合があります。 照合できない cc および Accept 言語 の値を指定した場合も同様です。
BingAPIs-TraceId 応答ヘッダー。

要求の詳細が含まれたログ エントリの ID。 エラーが発生した場合、この ID をキャプチャします。 問題を特定して解決できない場合は、その他の情報と共にこの ID をサポート チームに提供します。
Content-Type 省略可能な要求ヘッダー。

Modulesクエリパラメーターを認識されたエンティティに設定した場合は、POST 要求の本体でイメージのバイナリを指定することができます。 POST 要求の本文でイメージを指定する場合は、このヘッダーを指定し、その値をマルチパート/フォームデータに設定する必要があります。

イメージの最大サイズは 1 MB です。
Ocp-Apim-Subscription-Key 必須の要求ヘッダー。

Cognitive Services でこのサービスにサインアップしたときに受け取ったサブスクリプション キーです。
Pragma 省略可能な要求ヘッダー

既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。 キャッシュされたコンテンツを防止するには、プラグマヘッダーを no cache (たとえば、Pragma: no cache) に設定します。
Retry-After 応答ヘッダー。

応答には、1秒あたりに許可されるクエリの数 (QPS) または1か月 (QPM) を超える場合に、このヘッダーが含まれます。 ヘッダーには、別の要求を送信する前に待機する必要がある秒数が含まれています。
User-Agent 省略可能な要求ヘッダー。

要求送信元のユーザー エージェント。 Bing では、モバイル ユーザーに最適なエクスペリエンスを提供するためにユーザー エージェントが使用されます。 省略可能ですが、このヘッダーは常に指定することをお勧めします。

ユーザーエージェントは、よく使用されるブラウザーによって送信されるのと同じ文字列にする必要があります。 ユーザー エージェントについては、RFC 2616 を参照してください。

ユーザーエージェント文字列の例を次に示します。
  • 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.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.20120423

  • PC — 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.53
X-MSEdge-ClientID 省略可能な要求および応答ヘッダー。

このヘッダーは、Bing API の呼び出し間で一貫性のある動作をユーザーに提供するために Bing によって使用されます。 Bing によって、新しい機能と改善点が頻繁にフライト化されます。そして、トラフィックを異なるフライトに割り当てるためのキーとして、クライアント ID が使用されます。 複数の要求に対してユーザーの同じクライアント ID を使用しないと、ユーザーが複数の競合するフライトに割り当てられる可能性があります。 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスの一貫性がなくなる場合があります。 たとえば、2 番目の要求に 1 番目とは異なるフライトが割り当てられていると、エクスペリエンスが予期しないものになる可能性があります。 また、Bing はクライアント ID を使用して、クライアント ID の検索履歴に対して web の結果を調整することもできます。これにより、ユーザーのエクスペリエンスが向上します。

このヘッダーは、クライアント ID で生成されたアクティビティを分析して結果の順位付けを向上させるために Bing によって使用されることもあります。 関連性の向上は、Bing API によって提供される結果の品質向上に役立ち、API コンシューマーのクリックスルー率の向上を実現します。

重要: このヘッダーは省略可能ですが、必須であると考える必要があります。 同じエンド ユーザーとデバイスの組み合わせによる複数の要求に対してクライアント ID を保持することで、1) API コンシューマーが一貫性のあるユーザー エクスペリエンスを受け取ることができ、2) Bing API からの結果の品質向上を通じてクリックスルー率の向上が実現します。

このヘッダーに適用される基本的な使用規則を次に示します。
  • デバイスでアプリケーションを使用する各ユーザーは、Bing によって生成された一意のクライアント ID を持っている必要があります。

    このヘッダーを要求に含めない場合、Bing によって ID が生成され、それが X-MSEdge-ClientID 応答ヘッダーで返されます。 このヘッダーを要求に含めるべきでない唯一の場合は、ユーザーがそのデバイスでアプリを初めて使用するときです。

  • 注意: このクライアント ID は認証可能なユーザー アカウント情報にリンクできないようにする必要があります。

  • そのユーザーのためにアプリによってデバイスで実行される各 Bing API 要求で、クライアント ID を使用します。

  • クライアント ID を保持します。 ブラウザー アプリで ID を永続化するには、永続的な HTTP Cookie を使用して ID がすべてのセッションで確実に使用されるようにします。 セッション Cookie は使用しないようにしてください。 モバイル アプリなど、他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。

    次にそのデバイスでユーザーがアプリを使用するときに、保持したクライアント ID を取得します。

注: Bing の応答には、このヘッダーが含まれる場合と含まれない場合があります。 このヘッダーが応答に含まれる場合、クライアント ID をキャプチャして、ユーザーのためにそのデバイスで実行される後続のすべての Bing 要求でそれを使用します。

注: X-MSEdge-ClientID を含める場合、要求には Cookie を含めないようにしてください。
X-MSEdge-ClientIP 省略可能な要求ヘッダー。

クライアント デバイスの IPv4 アドレスまたは IPv6 アドレス。 IP アドレスは、ユーザーの位置情報の検出に使用されます。 位置情報は、安全な検索動作を決定するために Bing によって使用されます。

注: 省略可能ですが、このヘッダーと X-Search-Location ヘッダーは常に指定することをお勧めします。

(最後のオクテットを 0 に変更するなど) アドレスを難読化しないようにしてください。 アドレスを難読化すると、デバイスの実際の場所から離れた場所が検出され、Bing から誤った結果が提供される可能性があります。
X-Search-Location 省略可能な要求ヘッダー。

クライアントの地理的な場所を示す、キーと値のペアのセミコロン区切りリストです。 位置情報は、安全な検索動作を決定して関連するローカル コンテンツを返すために、Bing によって使用されます。 キーと値のペアは、<key>:<value> の形式で指定します。 ユーザーの場所の指定に使用するキーは次のとおりです。

  • lat — 必須。 クライアントの場所の緯度です (度単位)。 緯度は、-90.0 以上、+90.0 以下である必要があります。 負の値は南半球の緯度を示し、正の値は北半球の緯度を示します。

  • long — 必須。 クライアントの場所の経度です (度単位)。 経度は、-180.0 以上、+180.0 以下である必要があります。 負の値は西半球の経度を示し、正の値は東半球の経度を示します。

  • re — 必須。 座標の水平方向の精度を指定する半径 (m) です。 デバイスの位置情報サービスによって返される値を渡します。 一般的な値は、GPS/Wi-Fi の 22 m、携帯電話基地局の三角測量の 380 m、IP 逆引き参照の 18,000 m などです。

  • ts — 省略可能。 クライアントがその場所にいたときの UTC UNIX タイムスタンプです。 (UNIX タイムスタンプは、1970 年 1 月 1 日からの経過秒数です)。

  • head — 省略可能。 クライアントの相対的な先頭方向または移動方向。 移動方向は、真北を基準として時計回りに 0 から 360 度で指定します。 このキーは、sp キーが 0 以外の場合にのみ指定します。

  • sp — 省略可能。 クライアント デバイスが移動している水平方向の速度 (m/秒) です。

  • alt — 省略可能。 クライアント デバイスの高度 (m) です。

  • are — 省略可能。 座標の垂直方向の精度を指定する半径 (m)。 このキーは、alt キーを指定する場合にのみ指定します。

  • 変位 — (省略可能)。 フォーム内のユーザーの地理的な場所 (変位: <City、州>)。 たとえば、"変位: Seattle, ワシントン" のようになります。 これは、lat/長いキーを使用して指定したユーザーの場所の表示テキストバージョンです。 この値が lat/long 座標と競合する場合、Bing では、ユーザーの場所として変位値が使用されます。

注: Bing は、クエリに場所が含まれている場合、このヘッダーを無視します。 たとえば、このヘッダーにユーザーの場所がサンフランシスコとして反映されていて、クエリが レストラン seattle である場合、Bing はワシントン州シアトルにあるレストランを返します。

注: 多くのキーは省略可能ですが、提供する情報が多いほど、場所の結果の正確さが増します。

注: 省略可能ですが、ユーザーの地理的な場所は常に指定することをお勧めします。 位置情報を提供することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントによって VPN が使用されている場合) に特に重要です。 最適な結果を得るには、このヘッダーと X-Search-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。

注意

利用規約ですべての該当法規 (これらのヘッダーの使用に関するものなど) への準拠が要求されていることに注意してください。 たとえば、ヨーロッパなどの特定の地域では、特定の追跡デバイスをユーザー デバイスに組み込む前に、ユーザーの同意を得る必要があります。

クエリ パラメーター

要求に含めることができるクエリパラメーターを次に示します。 必須のパラメーターについては、必須の列を参照してください。 クエリ パラメーターの値を URL エンコードする必要があります。 Bing が返す画像をフィルター処理するために使用するクエリパラメーターの詳細については、「 クエリパラメーターのフィルター選択」を参照してください。

Name 必須
.cab トリミングする領域の下端の座標。

座標は元のイメージの高さの小数点以下の値で、イメージの左上隅から測定されます。 0.0 ~ 1.0 の値として座標を指定します。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
Float いいえ
カレンダー トリミングする領域の左座標。

座標は元のイメージの幅の割合であり、イメージの左上隅から測定されます。 0.0 ~ 1.0 の値として座標を指定します。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
Float いいえ
社用 トリミングする領域の右座標。

座標は元のイメージの幅の割合であり、イメージの左上隅から測定されます。 0.0 ~ 1.0 の値として座標を指定します。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
Float いいえ
cat トリミングする領域の上端の座標。

座標は元のイメージの高さの割合であり、イメージの左上隅から測定されます。 0.0 ~ 1.0 の値として座標を指定します。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
Float いいえ
ct calcatcar 、およびの各パラメーターで指定された座標に基づいてイメージをトリミングするときに使用するトリミングの種類 cab

有効な値を次に示します。
  • 0 — 四角形 (既定値)

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
符号なし整数 いいえ
cc 結果を取得する国の 2 文字の国番号です。 使用可能な値の一覧については、「 マーケットコード」を参照してください。

このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bing は、指定された言語で見つかった最初のサポートされている言語を使用し、国コードと組み合わせて、結果を返す市場を決定します。 言語一覧にサポートされている言語が含まれない場合、Bing は要求をサポートする最も近い言語と市場を検索します。 また、Bing は、結果に対して集計または既定の市場を使用する場合があります。

Accept-Language複数の言語を指定する場合にのみ、このクエリパラメーターとヘッダーを使用します。 それ以外の場合は、およびクエリパラメーターを使用する必要があり mkt setLang ます。

このパラメーターと mkt クエリ パラメーターは相互に排他的なので、両方指定することはできません。
String いいえ
count 応答で返されるイメージの数。 配信される実際の数は、要求した数よりも少ない可能性があります。 既定値は 35 です。 最大値は150です。

このパラメーターをパラメーターと共に使用して、 offset ページの結果を表示します。 たとえば、ユーザーインターフェイスにページごとに20個のイメージが表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。 それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。

このパラメーターは、Image Search API でのみ使用してください。 Insights、トレンド画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
UnsignedShort いいえ
id イメージを一意に識別する ID。 このパラメーターを使用して、指定されたイメージが Bing が返すイメージの一覧の最初のイメージであることを確認します。 イメージオブジェクトのフィールドには imageId 、このパラメーターを設定した ID が含まれています。 String いいえ
imgUrl 洞察を取得するイメージの URL。 パラメーターを使用してイメージを指定する代わりに、このパラメーターを使用し insightsToken ます。 また、イメージのバイナリを POST 要求の本体に配置することによって、イメージを指定することもできます。 バイナリオプションを使用する場合は、 content-type ヘッダーを参照してください。

サポートされる画像の最大サイズは 1 MB です。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
String いいえ
insightsToken イメージトークン。 イメージオブジェクトのimageInsightsTokenには、トークンが含まれています。 キャプションやショッピングソースなどのイメージに関する追加情報を取得するには、このパラメーターを指定します。 取得できるイメージに関する追加情報の一覧については、「 modules query parameter」を参照してください。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
String いいえ
mkt 結果の取得元の市場。 通常、 mkt は、ユーザーが要求を行っている国です。 ただし、Bing が結果を提供する国にユーザーがいない場合は、別の国である可能性があります。 市場は、という形式である必要があり <language code> - <country code> ます。 たとえば、en-US などです。 文字列の大文字と小文字は区別されません。 考えられる市場の値の一覧については、「 マーケットコード」を参照してください。

注: 既知の場合は、常に市場を指定することをお勧めします。 市場を指定すると、Bing が要求をルーティングして最適な応答を返すのに役立ちます。 市場コードに記載されていない市場を指定した場合、Bing は、変更される可能性のある内部マッピングに基づいて、最適な市場コードを使用します。

このパラメーターと cc クエリ パラメーターは相互に排他的なので、両方指定することはできません。
String いいえ
モジュール 要求する洞察のコンマ区切りの一覧。 次の値を指定できます。大文字と小文字は区別されません。
  • すべて — の洞察が返されます (使用可能な場合)。ただし、認識しているエンティティは除きます。

  • BRQ — 最適なクエリ。 画像を最もよく説明するクエリ用語。

  • キャプション — 画像に関する情報を提供するキャプション。 キャプションにエンティティが含まれている場合、応答にはそれらのエンティティのイメージへのリンクが含まれる場合があります。

  • コレクション — に関連する画像の一覧を表示します。

  • レシピ — 画像に表示されている料理のレシピの一覧です。
  • イメージを含む — web ページのリストを含むページ。

  • 認識されたエンティティ — は、イメージで認識されたエンティティ (people) の一覧です。

    注: このモジュールを他のモジュールで指定することはできません。 他のモジュールと共に指定した場合、応答には認識されたエンティティが含まれません。

  • —関係者は、他のユーザーによって行われた関連検索の一覧を検索します。

  • —関連するオファリングを購入できる商人の一覧を ShoppingSources します。

  • SimilarImages は、 — 元の画像に似た画像の一覧を表示します。

  • SimilarProducts は、 — 元のイメージで見つかった製品に似た製品を含むイメージの一覧を示します。

  • タグは、 — イメージ内で見つかったコンテンツの種類の特性を提供します。 たとえば、画像が人物の場合、タグには、ユーザーの性別と種類が表示されることがあります。

モジュールを指定し、モジュールのデータがない場合、応答オブジェクトには関連フィールドは含まれません。 たとえば、キャプションを指定し、それが存在しない場合、応答にはフィールドは含まれません imageCaption

関連する検索を含めるには、要求に元のクエリ文字列を含める必要があります。

類似したイメージや製品では元のクエリ文字列は必要ありませんが、関連性と結果の向上に役立つため、常に含める必要があります。

このパラメーターは、Insights API でのみ使用してください。 画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
String いいえ
offset イメージを返す前にスキップするイメージの数を示す0から始まるオフセット。 既定値は 0 です。 オフセットは、(totalEstimatedMatches) よりも小さくする必要があり - count ます。

結果をページに表示するには、パラメーターと共にこのパラメーターを使用し count ます。 たとえば、ユーザーインターフェイスにページごとに20個のイメージが表示されている場合、 count 結果の最初のページを取得するには、を20に、を offset 0 に設定します。 それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。

複数のページに、結果に重複が含まれている可能性があります。 重複を防ぐには、「 nextOffset」を参照してください。

このパラメーターは、Image API でのみ使用してください。 トレンド画像 API または Web Search API を呼び出すときは、このパラメーターを指定しないでください。
Unsigned Short いいえ
q ユーザーの検索クエリ用語。 用語を空にすることはできません。

用語には、 Bing 高度なオペレーターが含まれている場合があります。 たとえば、イメージを特定のドメインに制限するには、 site: 演算子を使用します。

Insights クエリの関連性を向上させるために (「 insightsToken」を参照)、ユーザーのクエリ用語を常に含める必要があります。

このパラメーターは、Image Search API でのみ使用してください。 トレンド画像 API を呼び出すときは、このパラメーターを指定しないでください。
String はい
safeSearch アダルトコンテンツの画像をフィルター処理します。 使用できるフィルター値は次のとおりです。
  • オフ — にすると、アダルトコンテンツを含む画像が返される場合があります。 要求が Image Search API を介して行われる場合、応答には明確なサムネイル画像 (非あいまい) が含まれます。 ただし、要求が Web Search API を介して行われる場合、応答には、ピクセル化 (ファジー) であるサムネイルイメージが含まれます。

  • —[モデレート] 要求が IMAGE SEARCH API を介している場合、その応答にはアダルトコンテンツを含む画像は含まれません。 要求が Web Search API を介して行われる場合、応答にはアダルトコンテンツを含む画像が含まれる可能性があります (サムネイル画像はピクセル化 (あいまい))。

  • 厳密 — には、アダルトコンテンツを含む画像を返しません。

既定値は Moderate です。

注: safeSearch が Strict に設定されるよう Bing の成人向けコンテンツ ポリシーによって強制される市場が要求元の場合、Bing によって safeSearch の値が無視され、Strict が使用されます。

注: site: クエリ演算子を使用している場合、safeSearch クエリ パラメーターの設定にかかわらず、成人向けのコンテンツが応答に含まれることがあります。 site: は、そのサイト上のコンテンツがわかっていて、成人向けコンテンツが含まれていても問題のないシナリオの場合にのみ使用してください。
String いいえ
setLang ユーザー インターフェイス文字列に使用する言語。 2文字または4文字のコードを使用して、言語を指定できます。 4文字のコードを使用することをお勧めします。

サポートされている言語コードの一覧については、「 Bing でサポートされる言語」を参照してください。

setlangに有効な2文字のニュートラルカルチャコード ( fr ) または有効な4文字の特定のカルチャコード ( fr-fr ) が含まれている場合、Bing はローカライズされた文字列を読み込みます。 たとえば、 fr-fr の場合、Bing は、 fr-fr ニュートラルカルチャコード文字列を読み込みます。

setlangが有効でない場合 (たとえば、 zh-tw ) や bing がこの言語をサポートしていない場合 (例: af , af-na )、bing の既定値は en (英語) です。

2文字のコードを指定するには、このパラメーターを ISO 639-1 言語コードに設定します。

4文字のコードを指定するに は、<国/地域> を使用します。ここで、 は iso 639-1 言語コード (ニュートラルカルチャ) で、<国/地域> は iso 3166 国/地域 (特定のカルチャ) コードです。 たとえば、米国英語の場合は en-us を使用します。

省略可能ですが、常に言語を指定することをお勧めします。 ユーザー インターフェイス文字列が別の言語で表示されることをユーザーが望まない限り、通常、setLangmkt で指定されるのと同じ言語に設定します。

このパラメーターと Accept-Language ヘッダーは相互に排他的です。両方を指定することはできません。

ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。 また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。
String いいえ

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

次に、Bing が返す画像をフィルター処理するために使用できるフィルタークエリパラメーター (省略可能) を示します。 クエリ パラメーターは URL エンコードする必要があります。

これらのパラメーターは Image Search API でのみ使用してください。 トレンド画像 API または Web Search API を呼び出すときは、これらのパラメーターを指定しないでください。

Name
部分 次の縦横比でイメージをフィルター処理します。
  • 正方形は — 標準の縦横比で画像を返します
  • ワイド — 画面の縦横比を持つワイドリターン画像
  • —縦横比が高い高さの画像
  • すべて — の側面によるフィルター処理は行われません。 この値の指定は、パラメーターを指定しない場合と同じです aspect
String
次の色のオプションでイメージをフィルター処理します。
  • ColorOnly — 色の画像を返す
  • モノクロ — 画像を白黒で返す

次の主要な色のいずれかを使用してイメージを返します。
  • Black
  • Brown
  • グレー
  • [緑]
  • オレンジ
  • ピンク
  • パープル
  • [赤]
  • 青緑
String
鮮度 次の検出オプションでイメージをフィルター処理します。
  • —過去24時間以内に Bing によって検出された日付を返します
  • —過去7日以内に Bing によって検出された画像を返す週
  • —過去30日以内に Bing によって検出された画像を返す月
String
上下 指定された高さ (ピクセル単位) のイメージをフィルター処理します。

このフィルターをフィルターと共に使用して、 size 高さが150ピクセルの小さい画像を返すことができます。
UnsignedShort
imageContent 画像 次のコンテンツの種類でイメージをフィルター処理します。
  • —人物の顔のみを表示する顔の戻り画像
  • —[縦] は、人の頭とショルダーのみを表示する画像を返します
String
imageType 次のイメージの種類でイメージをフィルター処理:
  • AnimatedGif — アニメーション gif イメージを返す

  • AnimatedGifHttps — https アドレスからのアニメーション gif イメージを返す

  • —クリップアートのイメージのみを返す

  • 行の改行 — のみの描画

  • 写真 — を返す (線の描画、アニメーション gif、クリップアートを除く)

  • ショッピングで — は、商品を販売しているマーチャントを Bing が認識しているアイテムを含む画像のみが返されます。 このオプションは、en-us 市場でのみ有効です。

  • 透明 — 背景が透明な画像のみを返します。
String
使用 次のライセンスの種類でイメージをフィルター処理:
  • 任意のライセンスの種類に該当 — するイメージを返します。 応答には、ライセンスが指定されていないイメージや、ライセンスが不明なイメージは含まれません。

  • 作成者が排他的な権利を放棄した公開イメージは、 — 法律によって認められた最大範囲になります。

  • —他のユーザーと共有される可能性のある返送画像を共有します。 イメージを変更したり編集したりすることはできません。 また、商用目的でのイメージの変更、共有、および使用は許可されていない可能性があります。 通常、このオプションは最も多くのイメージを返します。

  • —個人または商業目的で他のユーザーと共有されている可能性のある、商業用イメージを共有します。 イメージを変更したり編集したりすることはできません。

  • —変更、共有、および使用される可能性がある復帰イメージを変更します。 イメージを変更したり編集したりすることはできません。 商用目的でのイメージの変更、共有、および使用は許可されていない可能性があります。

  • —個人または商業目的で変更、共有、使用する可能性のあるイメージを変更して返却します。 通常、このオプションは最も少ないイメージを返します。

  • すべて — のライセンスの種類でフィルター処理することはできません。 この値の指定は、パラメーターを指定しない場合と同じです license

これらのライセンスの種類の詳細については、「 ライセンスの種類別にイメージをフィルター処理する」を参照してください。
String
maxFileSize 指定されたファイルサイズ以下のイメージをフィルター処理します。

指定できる最大ファイルサイズは520192バイトです。 より大きな値を指定すると、API は520192を使用します。 応答には、指定された最大値よりも少し大きい画像が含まれている可能性があります。

このフィルターを指定したり、 minFileSize ファイルサイズの範囲内のイメージをフィルター処理したりすることができます。
Integer
maxHeight 高さが指定した高さ以下のイメージをフィルター処理します。 高さをピクセル単位で指定します。

このフィルターを指定して、 minHeight 高さの範囲内のイメージをフィルター処理することができます。

このフィルターと height フィルターは相互に排他的です。
Integer
maxWidth 指定した幅以下の幅を持つイメージをフィルター処理します。 幅をピクセル単位で指定します。

このフィルターを指定して、 maxWidth 幅の範囲内のイメージをフィルター処理することができます。

このフィルターと width フィルターは相互に排他的です。
Integer
minFileSize サイズ 指定されたファイルサイズ以上のイメージをフィルター処理します。

指定できる最大ファイルサイズは520192バイトです。 より大きな値を指定すると、API は520192を使用します。 応答には、指定した最小値より若干小さい画像が含まれている可能性があります。

このフィルターを指定したり、 maxFileSize ファイルサイズの範囲内のイメージをフィルター処理したりすることができます。
Integer
minHeight 高さが指定した高さ以上のイメージをフィルター処理します。 高さをピクセル単位で指定します。

このフィルターを指定して、 maxHeight 高さの範囲内のイメージをフィルター処理することができます。

このフィルターと height フィルターは相互に排他的です。
Integer
minWidth 指定された幅以上の幅を持つイメージをフィルター処理します。 幅をピクセル単位で指定します。

このフィルターを指定して、 maxWidth 幅の範囲内のイメージをフィルター処理することができます。

このフィルターと width フィルターは相互に排他的です。
Integer
次のサイズでイメージをフィルター処理します。
  • 200 — x 200 ピクセル未満の小さい返される画像

  • 200 — x 200 ピクセル以上で500x500 ピクセル未満のメディアを返します。

  • —500x500 ピクセル以上の大きい戻り画像

  • 壁紙は — 壁紙イメージを返します。

  • すべて — のサイズでフィルター処理されません。 この値の指定は、パラメーターを指定しない場合と同じです size

このパラメーター height は、パラメーターまたはパラメーターと共に使用でき width ます。 たとえば、とを使用して、 height size 高さ150ピクセルの小さい画像を要求することができます。
String
指定された幅を持つイメージをピクセル単位でフィルター処理します。

このフィルターをフィルターと共に使用すると、 size 幅が150ピクセルの小さい画像を返すことができます。
UnsignedShort

応答オブジェクト

注意

フランスの新しい EU の著作権指令に準拠するには、Bing Web、News、Video、Image、およびすべてのカスタム検索 Api で、フランス語のユーザーの特定の EU ニュースソースからのコンテンツをすべて省略する必要があります。 削除されたコンテンツには、サムネイル画像、ビデオ、ビデオプレビュー、およびこれらのソースからの検索結果に付随するスニペットが含まれる場合があります。 その結果、Bing Api は、サムネイル画像とビデオ、ビデオプレビュー、およびフランス語のユーザーへのスニペットを使用して、より多くの結果を提供することができます。

応答に含めることができる JSON オブジェクトを次に示します。 要求が成功した場合、応答の最上位レベルのオブジェクトは、エンドポイントが/images/search の場合は Images オブジェクト、エンドポイントが/images/details の場合は ImageInsightsResponse 、エンドポイントが/Images/trending. の場合は TrendingImages になります。 要求が失敗した場合、最上位レベルのオブジェクトは ErrorResponse オブジェクトになります。

Object 説明
AggregateOffer 画像に関連する商人からのオファーの一覧を定義します。
集積 項目が他のユーザーによってどの程度評価されたかを示すメトリックを定義します。
カテゴリ トレンド画像のカテゴリを定義します。
Error 発生したエラーを定義します。
ErrorResponse 要求が失敗したときの応答に含まれている最上位レベルのオブジェクト。
Image クエリに関連するイメージを定義します。
Imagecap イメージのキャプションを定義します。
ImageGallery 関連する画像のコレクションが含まれている web ページへのリンクを定義します。
ImageInsights Image insights 要求が成功したときに応答に含まれるトップレベルのオブジェクト。
イメージ イメージ要求が成功したときに応答に含まれるトップレベルのオブジェクト。
ImagesModule 画像の一覧を定義します。
ImageTagsModule イメージ内で見つかったコンテンツの特性を定義します。
InsightsMetadata 画像に関連するその他の操作を実行できる web サイトの数を定義します。
MediaSize メディアコンテンツのサイズを定義します。
NormalizedRectangle イメージの領域を定義します。
インストルメンテーション Bing インストルメンテーション Url を定義します。
プラン マーチャントのオファーを定義します。
組織 マーチャントに関する情報を定義します。
Person 人物を定義します。
ピボット ピボットセグメントを定義します。
クエリ 検索クエリ文字列を定義します。
レシピ 料理レシピを定義します。
RecipesModule 料理レシピのリストを定義します。
認識 Izedentity 認識されたエンティティを定義します。
認識 Izedentitygroup 以前に認識されたエンティティのグループを定義します。
RecognizedEntitiesModule 以前に認識されたエンティティの一覧を定義します。
認識 Izedentityregion エンティティが検出された領域と、エンティティが一致する可能性のあるエンティティのリストを定義します。
"関連性のあるコレクション" モジュール 関連する画像が含まれている web ページへのリンクの一覧を定義します。
関連性検索モジュール 他のユーザーによって行われた関連検索の一覧を定義します。
Tag イメージ内で見つかった特性を定義します。
サムネイル サムネイル画像を定義します。
タイル イメージタイルを定義します。
TrendingImages トレンド画像要求が成功したときに応答に含まれるトップレベルのオブジェクト。

AggregateOffer

画像に関連する商人からのオファーの一覧を定義します。

要素 説明 Type
offers イメージに関連するオファリングのオファーの一覧。 プラン[]

集積

項目が他のユーザーによってどの程度評価されたかを示すメトリックを定義します。

Name
bestRating 評価が最も高いレビュー。 有効な値は、1.0 ~ 5.0 です。 float
ratingValue 平均 (平均) 評価。 有効な値は、1.0 ~ 5.0 です。 float
reviewCount レシピが評価またはレビューされた回数。 符号なし整数
テキスト 平均 (平均) 評価 (文字列形式)。 String

カテゴリ

トレンド画像のカテゴリを定義します。

要素 説明 Type
カテゴリのトレンドであるイメージの一覧。 各タイルには、画像と、件名のより多くの画像を返す URL が含まれています。 たとえば、カテゴリが人気のある人の検索である場合、その画像は人気のあるユーザーであり、URL はその人物のより多くの画像を返します。 タイル[]
イメージカテゴリの名前。 たとえば、人気のある方が検索します。 String

エラー

発生したエラーを定義します。

要素 説明 Type
code エラーのカテゴリを特定するエラー コード。 考えられるコードの一覧については、「エラー コード」を参照してください。 String
message エラーの説明。 String
moreDetails エラーに関する追加情報を提供する説明。 String
parameter エラーを引き起こした要求内のクエリ パラメーター。 String
subCode エラーを特定するエラー コード。 たとえば、code が InvalidRequest の場合、subCode は ParameterInvalid か ParameterInvalidValue の場合があります。 String
value 有効でなかったクエリ パラメーター値。 String

ErrorResponse

要求が失敗したときの応答に含まれている最上位レベルのオブジェクト。

名前 Type
_type 種類のヒント。 String
errors 要求が失敗した理由を示すエラーの一覧。 Error[]

Image

クエリに関連するイメージを定義します。

注意

URL 形式とパラメーターは予告なしに変更される可能性があるため、すべての Url をそのまま使用します。 URL 形式またはパラメーターに依存しないようにする必要があります。 例外は、 サムネイルイメージのサイズ変更とトリミングによって説明されているパラメーターと値です。

Name
アクセント色 イメージを優先する色を表す3バイトの16進数。 イメージが読み込まれるまで、クライアントの一時的な背景として色を使用します。 String
contentSize イメージのファイルサイズ。 文字列の形式は {size} {units} です。 たとえば、12345 B は、イメージのサイズが12345バイトであることを示します。 String
contentUrl ソース web サイト上のイメージの URL。 String
datePublished Bing が画像を検出した日付と時刻 (UTC)。 日付は YYYY-MM-YYYY-MM-DDTHH: MM: SS という形式になっています。 String
encodingFormat イメージの mime の種類 (jpeg など)。 String
上下 ソースイメージの高さ (ピクセル単位)。 Unsigned Short
hostPageDisplayUrl 画像をホストする web ページの表示 URL。

ユーザーインターフェイスでこの URL を使用して、イメージを含むホスト web ページを識別します。 URL は適切な形式ではないため、ホストの web ページにアクセスするためには使用しないでください。 ホストの web ページにアクセスするには、URL を使用し hostPageUrl ます。
String
hostPageUrl 画像を含む web ページの URL。

この URL とは contentUrl 同じ url でもかまいません。
String
id イメージの一覧でこのイメージを一意に識別する ID。

このフィールドは、Web Search API 応答にのみ含まれます。 このフィールドの使用方法の詳細については、「Web Search API ガイド」の「 順位付けを使用した結果の表示 」を参照してください。
String
imageId このイメージを一意に識別する ID。 イメージを応答の最初のイメージにする場合は、要求で id クエリパラメーターをこの id に設定します。 String
imageInsightsToken イメージに関する追加情報を取得するために、Image Search API への後続の呼び出しで使用するトークン。 このトークンの使用方法の詳細については、 insightsToken クエリパラメーターを参照してください。 String
insightsMetadata 画像に関連する他のアクションを実行できる web サイトの数。

たとえば、画像が apple の円グラフの場合、このオブジェクトには、apple の円を購入できる web サイトの数が含まれます。 UX 内のプランの数を示すには、カウントを含むショッピングカートアイコンなどのバッジを追加します。 ユーザーがアイコンをクリックしたときに、を使用して imageInisghtsToken web サイトの一覧を取得します。
InsightsMetadata
指定 画像のタイトル。 String
画像 サムネイルイメージの幅と高さ (「」を参照 thumbnailUrl )。 MediaSize
thumbnailUrl イメージのサムネイルの URL。 画像のサイズ変更の詳細については、「 サムネイル画像のサイズ変更とトリミング」を参照してください。 String
webSearchUrl このイメージの Bing 検索結果の URL。 String
ソースイメージの幅 (ピクセル単位)。 Unsigned Short

Imagecap

イメージのキャプションを定義します。

Name
キャプション イメージに関するキャプション。 String
dataSourceUrl キャプションが見つかった web サイトの URL。 キャプションは、ソースに属性を指定する必要があります。 たとえば、キャプションの横にある URL のドメイン名を表示し、URL を使用してソース web サイトにリンクします。 String
関連性のある検索 キャプションに見つかったエンティティの一覧。 オブジェクトのコンテンツを使用して Query キャプション内のエンティティを検索し、リンクを作成します。 このリンクによって、ユーザーはエンティティのイメージに移動します。 クエリ

ImageGallery

関連する画像のコレクションが含まれている web ページへのリンクを定義します。

Name
ファ コレクションを所有しているユーザー。 コレクションを作成者に属性を指定する必要があります。 Person
記述 コレクションの説明。 説明は空にすることができます。 String
このカウント 作成者に続くソーシャルネットワーク上のユーザーの数。 符号なし整数
imagesCount コレクション内で見つかった関連するイメージの数。 符号なし整数
指定 ギャラリーの名前。 String
電源 イメージが検出された発行元またはソーシャルネットワーク。 発行元をコレクションが見つかったソースとして属性を指定する必要があります。 String
thumbnailUrl コレクション内で見つかったいずれかのイメージのサムネイルの URL。 String
関連する画像のコレクションが含まれている web ページへの URL。 String

ImageInsights

Image insights 要求が成功したときに応答に含まれるトップレベルのオブジェクト。

Image insights の要求の詳細については、 insightsToken クエリパラメーターを参照してください。

Modulesクエリパラメーターは、Bing によって応答に含まれるフィールドに影響します。 modulesを [キャプションのみ] に設定すると、このオブジェクトにはフィールドだけが含まれ imageCaption ます。

Name Type
_type ImageInsights に設定されている型ヒント。 String
bestRepresentativeQuery 画像を最もよく表すクエリ用語。 オブジェクト内のリンクをクリックすると Query 、ユーザーは画像の画像が多くなる web ページに移動します。 クエリ
imagecap 画像に使用するキャプション。 Imagecap
imageInsightsToken イメージに関する詳細情報を取得するために、Image Search API への後続の呼び出しで使用するトークン。 このトークンの使用方法の詳細については、 insightsToken クエリパラメーターを参照してください。

このトークンには、 Image オブジェクト内のトークンと同じ使用法があります。
String
imageTags イメージ内で見つかったコンテンツの特性の一覧。 たとえば、画像が人物の場合、タグによって、ユーザーの性別や、所有している衣類の種類が示されることがあります。 ImageTagsModule
以下を含むもの 画像が含まれている web ページの一覧。 Web ページにアクセスするには、画像のフィールドの URL を使用し hostPageUrl ます。 ImagesModule
レシピ イメージに関連するレシピの一覧。 たとえば、画像が apple の円の場合、一覧には、apple の円を作成するためのレシピが含まれています。 RecipesModule
認識 Izedentitygroups 指定されたイメージで見つかったエンティティに一致するエンティティのイメージを含むグループの一覧。 たとえば、エンティティがそのグループで認識された場合、応答には general 著名人グループの画像が含まれることがあります。 RecognizedEntitiesModule
関連性のあるコレクション 関連する画像が含まれている web ページへのリンクの一覧です。 "関連性のあるコレクション" モジュール
関連性のある検索 他のユーザーによって行われた関連クエリの一覧。 関連性検索モジュール
shoppingSources イメージに関連する項目を提供する商人の一覧。 たとえば、画像が apple の円の場合、リストには、apple の扇形を販売している加盟店が含まれています。 AggregateOffer
visuallySimilarImages 元の画像のように視覚的に似た画像の一覧。 たとえば、指定された画像が水の本体を越えている場合、類似した画像の一覧は水の中にあります。

指定された画像が個人のものである場合、類似する画像は同じ人物であるか、または類似した設定で中している可能性があります。

類似性の条件は引き続き進化します。
ImagesModule
visuallySimilarProducts 元のイメージに含まれている製品と視覚的に似ている製品を含むイメージの一覧。 たとえば、指定した画像にドレスが含まれている場合、類似する画像の一覧にはドレスが含まれます。

この画像には、Bing がオンラインで見つかった製品のオファーに関する概要情報が記載されています。
ImagesModule

イメージ

イメージ要求が成功したときに応答に含まれるトップレベルのオブジェクト。

Name Type
_type Type ヒント。 Images に設定されています。 String
id 画像の解答を一意に識別する ID。

オブジェクトは、このフィールドを Web Search API 応答にのみ含めます。 このフィールドの使用方法の詳細については、「Web Search API ガイド」の「 順位付けを使用した結果の表示 」を参照してください。
String
isFamilyFriendly 1つ以上のイメージにアダルトコンテンツが含まれているかどうかを示すブール値。 画像にアダルトコンテンツが含まれていない場合、 isFamilyFriendlytrue に設定されます。 それ以外の場合、1つまたは複数のイメージにアダルトコンテンツが含まれていると、 isFamilyFriendlyfalse に設定されます。

False の場合、サムネイル画像はピクセル化 (あいまい) です。

注: このフィールドは Web Search API 応答にのみ含まれ、Image Search API 応答には含まれません。
Boolean
nextOffset オフセットクエリパラメーターを設定するオフセット値。

offset最初の要求でを0に、を30に設定し、2番目の要求で30に設定した場合、 count offset 2 番目の応答の結果の一部が最初の応答と重複している可能性があります。

重複を防ぐには、を offset の値に設定 nextOffset します。
Integer
pivotSuggestions 元のクエリ内のセグメントのリスト。 たとえば、クエリが 赤の花 である場合、Bing はクエリを に分割することがあります。

花 pivot には、赤の Peonies や Red などのクエリ候補が含まれる場合があります。また、Red pivot には、緑の花や黄色の花などのクエリ候補が含まれる場合があります。
ピボット
queryExpansions 元のクエリを絞り込む、展開されたクエリの一覧。 たとえば「 Microsoft Surface 」というクエリは、Microsoft Surface Pro 3 、Microsoft Surface RT 、Microsoft Surface Phone 、Microsoft Surface Hub に展開される可能性があります。 クエリ
readLink この回答を返す URL。 URL を使用するには、必要に応じてクエリパラメーターを追加し、 Ocp ヘッダーを含めます。

Web Search API の応答には、このフィールドが含まれます。 通常、Image Search API を直接照会する場合は、URL を使用します。
String
similarTerms ユーザーのクエリ用語と意味が似た用語の一覧。 クエリ
totalEstimatedMatches クエリに関連するイメージの推定数。 この数値を カウント および オフセット クエリパラメーターと共に使用して、結果をページします。

このフィールドは、Image Search API にのみ含まれます。
Long
value クエリに関連するイメージの一覧。

結果がない場合、配列は空になります。
イメージ[]
webSearchUrl 要求されたイメージの Bing 検索結果の URL。 String

ImagesModule

画像の一覧を定義します。

要素 説明 Type
value イメージの一覧。 イメージ[]

ImageTagsModule

イメージ内で見つかったコンテンツの特性を定義します。

要素 説明 Type
value イメージ内で見つかったコンテンツの特性を記述するタグの一覧。 たとえば、画像が音楽アーティストの場合、リストには女性、ドレス、および音楽が含まれていることを示します。これは、人物が女性の音楽アーティストであることを示します。 タグ[]

InsightsMetadata

画像に関連するその他の操作を実行できる web サイトの数を定義します。

要素 説明 Type
aggregateOffer イメージで見つかった製品のオンラインプランの概要。 たとえば、画像が "ドレス" の場合、このプランでは最低価格と、検出されたプランの数が特定されます。

このフィールドは、視覚的に類似した製品の洞察にのみ含まれます。

このプランには、、、 Name AggregateRating OfferCount 、およびの各フィールドが含まれています LowPrice
プラン
recipeSourcesCount 画像に表示されている食べ物のレシピを提供する web サイトの数。 符号なし整数
shoppingSourcesCount 画像に表示されている製品の商品を提供する web サイトの数。 符号なし整数

MediaSize

メディアコンテンツのサイズを定義します。

Name
体高 メディアコンテンツの高さ (ピクセル単位)。 Integer
width メディアコンテンツの幅 (ピクセル単位)。 Integer

NormalizedRectangle

イメージの領域を定義します。 領域は、領域の上、左隅、および下、右上隅の座標によって定義されます。 座標は、0.0 ~ 1.0 の範囲の元のイメージの幅と高さの小数部の値です。

Name
下端の座標。 Float
left 左の座標。 Float
right 右の座標 Float
top 上の座標 Float

プラン

マーチャントのオファーを定義します。

ShoppingSources insights と SimilarProducts insights はどちらもこのオブジェクトを使用します。 フィールドが適用される洞察を確認するには、フィールドの説明を参照してください。

要素 説明 Type
集積 製品が他のユーザーによってどの程度評価されたかを示す集計評価。

SimilarProducts によって使用されます。
集積
availability 項目の可用性。 有効な値を次に示します。
  • 生産中止
  • InStock
  • InStoreOnly
  • LimitedAvailability
  • オンラインのみ
  • OutOfStock
  • 事前順序
  • このような

ShoppingSources によって使用されます。
String
description 項目の説明。 String
lastUpdated プランが最後に更新された日付。 日付は YYYY-MM-DD という形式になっています。 Failfast
低料金 Bing がオンラインで検出した項目の最低価格。

SimilarProducts によって使用されます。
Float
name 製品の名前です。 String
offerCount Bing がオンラインで検出したオファーの数。

SimilarProducts によって使用されます。
符号なし整数
price 項目の価格。

ShoppingSources によって使用されます。
Float
priceCurrency 通貨通貨。 たとえば、「USD」とします。 String
書店 マーチャントの名前。

ShoppingSources によって使用されます。
組織
url マーチャントの web サイトにあるオファーの URL。

ShoppingSources によって使用されます。
String

Organization

マーチャントに関する情報を定義します。

要素 説明 Type
image マーチャントのロゴ。 オブジェクトには Image 、フィールドのみが含まれ url ます。 Image
name マーチャントの名前。 String

Person

人物を定義します。

Name Type
_type 種類のヒント。 String
description 個人の簡単な説明。 String
image 人物の画像。 Image
jobTitle ユーザーの役職。 String
name ユーザーの名前。 String
twitterProfile 人の twitter プロファイルの URL。 String
url ユーザーのソーシャルネットワークのホームページの URL (該当する場合)。 String
webSearchUrl このユーザーに関する情報が含まれている Bing の検索結果ページの URL。 String

ピボット

ピボットセグメントを定義します。

Name
旋回 ピボットする元のクエリからのセグメント。 String
アドバイス ピボットに関して推奨されるクエリの一覧。 クエリ

クエリ

検索クエリ文字列を定義します。

Name
displayText クエリ用語の表示バージョン。

展開されたクエリ (「 Queryexpansions」を参照) とピボット候補 (「 pivotsuggestions」を参照) では、このフィールドによって、元のクエリを展開した用語が識別されます。 たとえば、クエリが Microsoft surface で、拡張されたクエリが microsoft surface rt の場合、には displayText RT が含まれます。
String
searchLink 関連検索の結果を取得するために使用する URL。 URL を使用する前に、必要に応じてクエリパラメーターを追加し、 Ocp ヘッダーを含める必要があります。

独自のユーザーインターフェイスに結果を表示している場合は、この URL を使用します。 それ以外の場合は、URL を使用し webSearchUrl ます。
String
text クエリ用語。 String
thumbnail 関連するイメージのサムネイルの URL。

オブジェクトには、ピボット候補および関連する検索に対してのみこのフィールドが含まれます。
サムネイル
webSearchUrl ユーザーがクエリの Bing の検索結果ページに移動する URL。

ユーザーインターフェイスに結果が表示されない場合は、この URL を使用します。 それ以外の場合は、URL を使用し searchUrl ます。

関連する検索にのみ含まれます。
String

レシピ

料理レシピを定義します。

要素 説明 Type
集積 他のユーザーによってどのようにレシピが評価されたかを示す集計評価。 集積
cookTime 食品がクックするまでにかかる時間。 たとえば、PT25M のようになります。 時刻形式の詳細については、「」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Durations String
ファ レシピの作成者。 Person
name レシピの名前。 String
prepTime 成分を準備するために必要な時間。 たとえば、PT15M のようになります。 時刻形式の詳細については、「」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Durations String
thumbnailUrl 準備された食べ物のサムネイル画像の URL。 String
totalTime レシピの準備とクックにかかる時間の合計。 たとえば、PT45M のようになります。 時刻形式の詳細については、「」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Durations String
url レシピを含む web ページにユーザーを移動する URL。 String

RecipesModule

レシピのリストを定義します。

要素 説明 Type
value レシピの一覧。 レシピ[]

RecognizedEntitiesModule

以前に認識されたエンティティの一覧を定義します。

要素 説明 Type
value 認識されたエンティティの一覧。 認識Izedenitygroup[]

認識 Izedentity

認識されたエンティティを定義します。

要素 説明 Type
エンティティ 認識されたエンティティ。

使用可能なエンティティオブジェクトを次に示します。
Object
matchConfidence Bing では、イメージ内のエンティティがこのエンティティと一致するという自信を持っています。 信頼度は、0.0 から1.0 までの範囲で、1.0 が非常に安全であることを保証します。 Float

認識 Izedentitygroup

以前に認識されたエンティティのグループを定義します。

要素 説明 Type
name エンティティのイメージも検出されたグループの名前。

次のグループを使用できます。
  • —CelebrityAnnotations に類似した Celeb注釈を使用しますが、正確に一致する確率が高くなります。

  • CelebrityAnnotations には、 — アクター、politicians、選手、履歴などの有名人が含まれています。
String
認識 Izedentityregion エンティティを格納しているイメージの領域。 認識Izedentityregion[]

認識 Izedentityregion

エンティティが検出されたイメージの領域と、エンティティが一致する可能性のあるエンティティのリストを定義します。

要素 説明 Type
matchingEntities Bing が地域で見つかったエンティティと一致するエンティティの一覧。 エンティティは信頼度の高いものになります (認識されたエンティティのフィールドを参照してください matchConfidence )。 認識Izedentity[]
region エンティティを格納しているイメージの領域。

四角形の値は、元のイメージの幅と高さに対して相対的であり、0.0 から 1.0 の範囲内にあります。

たとえば、画像が300x200 で、領域の左上がポイント (10, 20) にあり、右下隅がポイント (290, 150) の場合、正規化された四角形は次のようになります。

Left = 0.0333333333333333

上位 = 0.1

Right = 0.9666666666666667

下 = 0.75

人物の場合、領域はその人物の顔を表します。
NormalizedRectangle

"関連性のあるコレクション" モジュール

関連する画像を含む web ページの一覧を定義します。

要素 説明 Type
value 関連する画像が含まれている web ページの一覧。 Imagegallery[]

関連性検索モジュール

他のユーザーによって行われた関連検索の一覧を定義します。

要素 説明 Type
value 他のユーザーによって行われた関連検索の一覧。 クエリ[]

タグ

イメージ内で見つかったコンテンツの特性を定義します。

要素 説明 Type
name 特性の名前。 たとえば、cat、キティー、calico cat などです。 String

サムネイル

画像のサムネイルを定義します。

要素 説明 Type
url イメージのサムネイルの URL。 String

タイル

イメージタイルを定義します。

要素 説明 Type
image イメージのサムネイルの URL。 Image
query 対象の画像が多い Bing の検索結果ページを返すクエリ。 たとえば、カテゴリが人気のある人の検索である場合、サムネイルは人気のあるユーザーになります。 クエリから Bing の検索結果ページが返され、その人のイメージが増えます。 クエリ

TrendingImages

トレンド画像要求が成功したときに応答に含まれるトップレベルのオブジェクト。

要素 説明 Type
categories 画像のカテゴリとそのカテゴリ内のトレンド画像の一覧を識別するリスト。 カテゴリ[]

エラー コード

要求によって返される可能性のある HTTP 状態コードを次に示します。

状態コード 説明
200 正常終了しました。
400 クエリ パラメーターの 1 つが欠落しているか無効です。
401 サブスクリプション キーが見つからないか、無効です。
403 (たとえば、有効なサブスクリプション キーを使用して) ユーザーは認証されたものの、要求されたリソースへのアクセス許可がありません。

また、呼び出し元が 1 か月あたりのクエリ数のクォータを超えた場合にも、Bing はこの状態を返します。
410 HTTPS プロトコルではなく HTTP プロトコルが使用された要求。 サポートされるプロトコルは HTTPS のみです。
429 呼び出し元が 1 秒あたりのクエリ数のクォータを超えました。
500 予期しないサーバー エラー。

要求が失敗すると、応答に ErrorResponse オブジェクトが含まれます。このオブジェクトには、エラーの原因を示す Error オブジェクトの一覧が含まれています。 エラーがパラメーターに関連している場合、parameter フィールドで、問題であるパラメーターが特定されます。 エラーがパラメーター値に関連している場合、value フィールドで、無効な値が特定されます。

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

考えられるエラー コードとサブエラー コードの値を次に示します。

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

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

HTTPS プロトコルではなく HTTP プロトコルを使用すると、Bing は HttpNotAllowed を返し、HTTP 状態コードは 410 になります。
RateLimitExceeded No sub-codes 1 秒あたりのクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) のクォータを超えると、Bing は RateLimitExceeded を返します。

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

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

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

エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。

市場コード

次の表に、クエリパラメーターの指定に使用できる市場コードの値を示し mkt ます。 Bing はこれらの市場に対してのみコンテンツを返します。 一覧は変更されることがあります。

クエリパラメーターで指定できる国コードの一覧につい cc ては、「 国コード」を参照してください。

国/地域 Language 市場コード
アルゼンチン スペイン語 es-AR
オーストラリア 英語 en-AU
オーストリア ドイツ語 de-AT
ベルギー オランダ語 nl-BE
ベルギー フランス語 fr-BE
ブラジル Portuguese pt-BR
Canada 英語 en-CA
Canada フランス語 fr-CA
チリ スペイン語 es-CL
デンマーク デンマーク語 da-DK
フィンランド フィンランド語 fi-FI
フランス フランス語 fr-FR
ドイツ ドイツ語 de-DE
香港特別行政区 Traditional Chinese zh-HK
インド 英語 en-IN
インドネシア 英語 en-ID
イタリア イタリア語 it-IT
日本 日本語 ja-JP
韓国 韓国語 ko-KR
マレーシア 英語 en-MY
メキシコ スペイン語 es-MX
オランダ オランダ語 nl-NL
ニュージーランド 英語 en-NZ
中華人民共和国 Chinese zh-CN
ポーランド ポーランド語 pl-PL
ポルトガル Portuguese pt-PT
フィリピン共和国 英語 en-PH
ロシア ロシア語 ru-RU
サウジアラビア アラビア語 ar-SA
南アフリカ 英語 en-ZA
スペイン スペイン語 es-ES
スウェーデン スウェーデン語 sv-SE
スイス フランス語 fr-CH
スイス ドイツ語 de-CH
台湾 Traditional Chinese zh-TW
トルコ トルコ語 tr-TR
イギリス 英語 en-GB
United States 英語 ja-JP
United States スペイン語 es-US

国コード

cc クエリ パラメーターで指定できる国番号を次に示します。 一覧は変更されることがあります。

国/地域 国番号
アルゼンチン AR
オーストラリア AU
オーストリア AT
ベルギー BE
ブラジル BR
Canada CA
チリ CL
デンマーク DK
フィンランド FI
フランス FR
ドイツ DE
香港特別行政区 HK
インド IN
インドネシア id
イタリア IT
日本 JP
韓国 KR
マレーシア MY
メキシコ MX
オランダ NL
ニュージーランド NZ
ノルウェー NO
中華人民共和国 CN
ポーランド PL
ポルトガル PT
フィリピン共和国 PH
ロシア RU
サウジアラビア SA
南アフリカ ZA
スペイン ES
スウェーデン SE
スイス CH
台湾 TW
トルコ TR
イギリス GB
United States US

Bing でサポートされる言語

クエリ パラメーターで指定できるBingサポートされる言語を次にsetLang示します。 一覧は変更されることがあります。

サポートされている言語 言語コード
アラビア語 ar
バスク語 eu
ベンガル語 bn
Bulgarian bg
カタロニア語 ca
簡体中国語 zh-hans
繁体中国語 zh-hant
Croatian hr
Czech cs
Danish da
Dutch nl
English en
イギリス-イギリス en-gb
Estonian et
Finnish fi
French fr
ガリシア語 gl
German de
グジャラート語 gu
ヘブライ語 he
ヒンディー語 hi
Hungarian hu
アイスランド語 is
Italian it
Japanese Jp
カンナダ語 kn
Korean ko
Latvian lv
Lithuanian lt
マレー語 ms
マラヤーラム語  ml
マラーティー語 mr
ノルウェー語 (ブークモール) nb
Polish pl
ポルトガル語 (ブラジル) pt-br
ポルトガル語 (ポルトガル) pt-pt
パンジャーブ語 pa
Romanian ro
Russian ru
セルビア語 (キリリック) sr
Slovak sk
Slovenian sl
Spanish es
Swedish sv
タミル語 ta
テルグ語 te
Thai th
Turkish tr
ウクライナ語 uk
ベトナム語 vi