Image Search API v7 リファレンス

  • [アーティクル]

警告

Bing Search API は、Cognitive Services から Bing Search Services に移行されます。 2020 年 10 月 30 日以降、Bing Search の新しいインスタンスは、こちらに記載されているプロセスに従ってプロビジョニングする必要があります。 Cognitive Services を使用してプロビジョニングされた Bing Search API は、次の 3 年間、または Enterprise Agreement の終わり (どちらか先に発生した方) までサポートされます。 移行手順については、Bing Search Services に関する記事を参照してください。

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

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

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

応答に含まれる可能性がある JSON 応答オブジェクトの詳細については、「 応答オブジェクト」を参照してください。

許可された結果の使用と表示については、「検索 API の使用と表示の要件Bing参照してください。

Note

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

エンドポイント

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

エンドポイント 説明
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-Language にリコンサイルできない値を指定する場合も同様です。
BingAPIs-TraceId 応答ヘッダー。

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

モジュールのクエリ パラメーターを RecognizedEntities に設定した場合は、POST 要求の本文でイメージのバイナリを指定できます。 POST 要求の本文でイメージを指定する場合は、このヘッダーを指定し、その値を multipart/form-data に設定する必要があります。

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

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

既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。 キャッシュされたコンテンツを防ぐには、Pragma ヘッダーを 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 によって使用されます。 キーと値のペアは、<キー>:<値> の形式で指定します。 ユーザーの場所の指定に使用するキーは次のとおりです。

  • 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 キーを指定する場合にのみ指定します。

  • disp - 省略可能。 ユーザーの地理的な場所 (disp:<City、State>)。 たとえば、disp:Seattle、Washington などです。 これは、lat/long キーを使用して指定したユーザーの場所の表示テキスト バージョンです。 この値が緯度/経度座標と競合する場合、Bingはユーザーの位置として disp 値を使用します。

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

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

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

注意

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

クエリ パラメーター

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

名前 値 Type 必須
タクシー トリミングする領域の下部座標。

座標は元の画像の高さの小数部の値であり、画像の左上隅から測定されます。 座標を 0.0 ~ 1.0 の値として指定します。

このパラメーターは、インサイト API でのみ使用してください。 Images、Trending Images、または Web Search API を呼び出すときは、このパラメーターを指定しないでください。		 Float No
Cal トリミングする領域の左座標。

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

このパラメーターは、インサイト API でのみ使用してください。 Images、Trending Images、または Web Search API を呼び出すときは、このパラメーターを指定しないでください。		 Float No
car トリミングする領域の右座標。

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

このパラメーターは、インサイト API でのみ使用してください。 Images、Trending Images、または Web Search API を呼び出すときは、このパラメーターを指定しないでください。		 Float No
cat トリミングする領域の上座標。

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

このパラメーターは、インサイト API でのみ使用してください。 Images、Trending Images、または Web Search API を呼び出すときは、このパラメーターを指定しないでください。		 Float No
Ct 、、およびcabパラメーターでcarcalcat指定された座標に基づいてイメージをトリミングするときに使用するトリミングの種類。

使用可能な値を次に示します。
  • 0 - 四角形 (既定値)

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

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

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

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

このパラメーターは、結果を offset ページングするパラメーターと共に使用します。 たとえば、ユーザー インターフェイスに 1 ページあたり 20 個の画像が表示される場合は、20 と offset 0 に設定countして結果の最初のページを取得します。 後続のページごとに、20 ずつインクリメント offset します (例: 0、20、40)。

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

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

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

このパラメーターは、インサイト API でのみ使用してください。 Images、Trending Images、または Web Search API を呼び出すときは、このパラメーターを指定しないでください。		 String いいえ
mkt 結果の取得元の市場。 通常、 mkt ユーザーが要求を行っている国です。 ただし、ユーザーが結果を配信する国にユーザーがいない場合は、別の国Bing可能性があります。 市場は、言語コード国コード><>の形式<である必要があります。 たとえば、en-US などです。 文字列では大文字と小文字が区別されません。 可能な市場価値の一覧については、「 市場コード」を参照してください。

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

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

  • BRQ - 最適な代表的なクエリ。 イメージを最もよく説明するクエリ用語。

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

  • コレクション - 関連するイメージの一覧。

  • レシピ - 画像に示されている食品を調理するためのレシピの一覧。
  • PagesIncluding - 画像を含む Web ページの一覧。

  • RecognizedEntities - 画像で認識されたエンティティ (ユーザー) の一覧。

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

  • RelatedSearches - 他のユーザーによって行われた関連検索の一覧。

  • ShoppingSources - 関連するオファリングを購入できるマーチャントの一覧。

  • SimilarImages - 元のイメージと視覚的に似たイメージの一覧。

  • SimilarProducts - 元のイメージで見つかった製品に似た製品を含むイメージの一覧。

  • タグ - 画像内で見つかったコンテンツの種類の特性を提供します。 たとえば、画像が人物の場合、タグは、着用している人の性別と服の種類を示している可能性があります。

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

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

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

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

結果をページングするには、このパラメーターと共にパラメーターを count 使用します。 たとえば、ユーザー インターフェイスに 1 ページあたり 20 個の画像が表示される場合は、20 と offset 0 に設定countして結果の最初のページを取得します。 後続のページごとに、20 ずつインクリメントします offset (たとえば、0、20、40)。

複数のページで結果に重複を含めることができます。 重複を防ぐには、 nextOffset を参照してください。

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

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

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

このパラメーターは、Image Search API でのみ使用してください。 Trending Images API を呼び出すときは、このパラメーターを指定しないでください。		 String はい
safeSearch 成人向けコンテンツの画像をフィルター処理します。 可能なフィルター値を次に示します。
  • オフ - 成人のコンテンツを含む画像を返す場合があります。 要求が Image Search API を使用している場合、応答には明確なサムネイル画像 (あいまいではない) が含まれます。 ただし、要求が Web Search API を使用している場合、応答にはピクセル化 (あいまい) されたサムネイル 画像が含まれます。

  • [モデレート] - 要求が Image Search API を使用している場合、応答には成人コンテンツを含む画像は含まれません。 要求が Web Search API を使用している場合、応答には成人コンテンツを含む画像が含まれる場合があります (サムネイル画像はピクセル化 (あいまい) されます)。

  • Strict - 成人用コンテンツを含む画像を返さないでください。

既定値は Moderate です。

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

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

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

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

無効な場合 (たとえば、zh) またはBingが言語 (af、af-na など) をサポートしていない場合setlang、Bing既定値は en (英語) です。

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

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

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

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

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

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

返されるイメージをフィルター処理するために使用できるオプションのフィルター クエリ パラメーター Bing次に示します。 クエリ パラメーターは URL エンコードする必要があります。

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

名前 値 Type
側面 次の縦横比で画像をフィルター処理します。
  • 正方形 - 標準縦横比の画像を返します
  • ワイド - ワイド画面の縦横比を持つ画像を返します
  • 高さ - 縦横比が高い画像を返します
  • [すべて] - アスペクトでフィルター処理しないでください。 この値を指定することは、パラメーターを指定しない場合と 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
ライセンス 次のライセンスの種類でイメージをフィルター処理します。
  • [任意] - 任意のライセンスの種類の下にあるイメージを返します。 応答には、ライセンスを指定しない画像やライセンスが不明な画像は含まれません。

  • パブリック - 作成者が排他的権利を放棄した画像を、法律で許可されている最大限の範囲で返します。

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

  • ShareCommercially - 個人または商用目的で他のユーザーと共有される可能性のある画像を返します。 イメージの変更または編集が許可されない場合があります。

  • [変更] - 変更、共有、使用できるイメージを返します。 イメージの変更または編集が許可されない場合があります。 商用目的でイメージの変更、共有、使用が許可されない場合があります。

  • ModifyCommercially - 個人または商用目的で変更、共有、使用される可能性のある画像を返します。 通常、このオプションは最も少ない画像を返します。

  • [すべて] - ライセンスの種類でフィルター処理しないでください。 この値の指定は、パラメーターを指定しない場合と license 同じです。

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

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

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

このフィルターを指定したり、 minHeight 高さの範囲内の画像をフィルター処理したりできます。

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

このフィルターを指定したり、 maxWidth 幅の範囲内の画像をフィルター処理したりできます。

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

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

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

このフィルターを指定したり、 maxHeight 高さの範囲内の画像をフィルター処理したりできます。

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

このフィルターを指定したり、 maxWidth 幅の範囲内の画像をフィルター処理したりできます。

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

  • 中 - 200 x 200 ピクセル以上 500 x 500 ピクセル未満の画像を返します。

  • 大 - 500 x 500 ピクセル以上の画像を返します

  • 壁紙 - 壁紙画像を返します。

  • [すべて] - サイズでフィルター処理しないでください。 この値を指定することは、パラメーターを指定しない場合と size 同じです。

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

このフィルターをフィルターと共に size 使用して、幅が 150 ピクセルの小さな画像を返す場合があります。		 UnsignedShort

応答オブジェクト

注意

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

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

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

AggregateOffer

イメージに関連するマーチャントからのオファーの一覧を定義します。

要素 説明 Type
offers 画像に関連するオファリングを持つマーチャントからのオファーの一覧。 オファー[]

AggregateRating

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

名前 値 Type
bestRating 最も評価の高いレビュー。 指定できる値は 1.0 から 5.0 です。 float
ratingValue 平均 (平均) 評価。 指定できる値は 1.0 から 5.0 です。 float
reviewCount レシピが評価またはレビューされた回数。 符号なし整数
テキスト 平均 (平均) の評価 (文字列形式)。 String

カテゴリ

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

要素 説明 Type
タイル カテゴリでトレンドになっている画像の一覧。 各タイルには、画像と、件名のより多くの画像を返す URL が含まれています。 たとえば、カテゴリが人気のあるユーザー検索の場合、画像は人気のあるユーザーのものであり、URL はそのユーザーのより多くの画像を返します。 Tile[]
タイトル イメージ カテゴリの名前。 たとえば、人気のあるユーザー検索などです。 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 の形式またはパラメーターに依存しないようにしてください。 ただし、 サイズ変更とトリミングのサムネイル 画像で説明されているパラメーターと値は例外です。

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

イメージを含むホスト Web ページを識別するには、ユーザー インターフェイスでこの URL を使用します。 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 Pie の場合、このオブジェクトには、Apple Pie を購入できる Web サイトの数が含まれます。 UX 内のオファーの数を示すには、カウントを含むショッピング カート アイコンなどの不良を含めます。 ユーザーがアイコンをクリックすると、Web サイトの一覧を取得するために使用 imageInisghtsToken します。		 InsightsMetadata
name 画像のタイトル。 String
サムネイル サムネイル画像の幅と高さ (参照 thumbnailUrl)。 MediaSize
thumbnailUrl 画像のサムネイルへの URL。 画像のサイズ変更の詳細については、「サムネイル 画像の サイズ変更とトリミング」を参照してください。 String
webSearchUrl この画像のBing検索結果への URL。 String
幅 ソース イメージの幅 (ピクセル単位)。 Unsigned Short

ImageCaption

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

名前 値 Type
キャプション 画像に関するキャプション。 String
dataSourceUrl キャプションが見つかった Web サイトの URL。 キャプションをソースに属性付けする必要があります。 たとえば、キャプションの横にある URL からドメイン名を表示し、URL を使用してソース Web サイトにリンクします。 String
relatedSearches キャプションで見つかったエンティティの一覧。 オブジェクトの内容を Query 使用して、キャプション内のエンティティを検索し、リンクを作成します。 このリンクは、ユーザーをエンティティのイメージに移動します。 クエリ

ImageGallery

関連するイメージのコレクションを含む Web ページへのリンクを定義します。

名前 値 Type
作成者 コレクションを所有するユーザー。 コレクションを作成者に属性付けする必要があります。 Person
説明 コレクションの説明。 説明は空の場合があります。 String
followersCount 作成者に従うソーシャル ネットワーク上のユーザーの数。 符号なし整数
imagesCount コレクション内で見つかった関連するイメージの数。 符号なし整数
name ギャラリーの名前。 String
ソース 画像が見つかった発行元またはソーシャル ネットワーク。 コレクションが見つかったソースとしてパブリッシャーを属性化する必要があります。 String
thumbnailUrl コレクション内で見つかった画像のサムネイルへの URL。 String
Url 関連するイメージのコレクションを含む Web ページの URL。 String

ImageInsights

image insights 要求が成功したときに応答に含まれる最上位のオブジェクト。

画像分析情報の要求の詳細については、 insightsToken クエリ パラメーターを参照してください。

モジュール クエリ パラメーターは、応答に含まれるBingフィールドに影響します。 Caption のみに設定 modules した場合、このオブジェクトにはフィールドのみが imageCaption 含まれます。

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

このトークンは、 Image オブジェクト内のトークンと同じ使用法を持ちます。		 String
imageTags 画像内で見つかったコンテンツの特性の一覧。 たとえば、画像が人物の場合、タグは、その人の性別と着ている服の種類を示している可能性があります。 ImageTagsModule
pagesIncluding 画像を含む Web ページの一覧。 Web ページにアクセスするには、画像 hostPageUrl のフィールドの URL を使用します。 ImagesModule
recipes 画像に関連するレシピの一覧。 たとえば、画像がアップルパイの場合、リストにはアップルパイを作成するためのレシピが含まれています。 RecipesModule
recognizedEntityGroups 指定したイメージ内のエンティティと一致するエンティティの画像を含むグループの一覧。 たとえば、エンティティがそのグループで認識された場合、応答には一般的な著名人グループの画像が含まれる場合があります。 RecognizedEntitiesModule
relatedCollections 関連する画像を含む Web ページへのリンクの一覧。 RelatedCollectionsModule
relatedSearches 他のユーザーによって行われた関連するクエリの一覧。 RelatedSearchesModule
shoppingSources 画像に関連するアイテムを提供するマーチャントの一覧。 たとえば、画像がアップルパイの場合、リストにはアップルパイを販売しているマーチャントが含まれます。 AggregateOffer
visuallySimilarImages 元の画像と視覚的に似た画像の一覧。 たとえば、指定した画像が水の本体に沈む夕日の場合、同様の画像の一覧は、水の本体に対する夕日の一覧です。

指定された画像が人物の場合、類似の画像が同じ人物であるか、類似の服を着た人物または同様の設定の人物である可能性があります。

類似性の基準は進化し続けています。		 ImagesModule
visuallySimilarProducts 元の画像で見つかった製品と視覚的に似た製品を含む画像の一覧。 たとえば、指定した画像にドレスが含まれている場合、類似する画像の一覧にはドレスが含まれます。

この画像は、製品のオンラインで見つかったオファー Bing関する概要情報を提供します。		 ImagesModule

画像

イメージ要求が成功したときに応答に含まれる最上位のオブジェクト。

名前 値 Type
_type 型ヒント。Images に設定されます。 String
id 画像の回答を一意に識別する ID。

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

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

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

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

重複を防ぐには、次の値nextOffsetに設定offsetします。		 Integer
pivotSuggestions 元のクエリのセグメントの一覧。 たとえば、クエリが Red Flowers であった場合、Bingはクエリを赤と花にセグメント化できます。

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

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

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

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

ImagesModule

イメージの一覧を定義します。

要素 説明 Type
value 画像の一覧。 Image[]

ImageTagsModule

イメージ内のコンテンツの特性を定義します。

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

InsightsMetadata

画像に関連する他のアクションを購入または実行できる Web サイトの数を定義します。

要素 説明 Type
aggregateOffer 画像で見つかった製品のオンライン オファーの概要。 たとえば、画像がドレスの場合、オファーは最低価格と見つかったオファーの数を識別する可能性があります。

このフィールドには、視覚的に類似した製品の分析情報のみが含まれます。

オファーには、次のフィールドが含まれています。 NameAggregateRatingOfferCountLowPrice		 プラン
recipeSourcesCount 画像に表示される食品のレシピを提供する Web サイトの数。 符号なし整数
shoppingSourcesCount 画像に表示される製品の商品を提供する Web サイトの数。 符号なし整数

MediaSize

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

名前 値 Type
height メディア コンテンツの高さ (ピクセル単位)。 Integer
width メディア コンテンツの幅 (ピクセル単位)。 Integer

NormalizedRectangle

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

名前 値 Type
下 下の座標。 Float
left 左座標。 Float
right 右座標 Float
top 上の座標 Float

プラン

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

ShoppingSources 分析情報と SimilarProducts 分析情報の両方で、このオブジェクトが使用されます。 フィールドが適用される分析情報を確認するには、フィールドの説明を参照してください。

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

SimilarProducts で使用されます。		 AggregateRating
availability アイテムの可用性。 使用可能な値を次に示します。
  • 生産中止
  • InStock
  • InStoreOnly
  • LimitedAvailability
  • OnlineOnly
  • OutOfStock
  • プレオーダー
  • SoldOut

ShoppingSources で使用されます。		 String
description アイテムの説明。 String
lastUpdated オファーが更新された最後の日付。 日付は YYYY-MM-DD 形式です。 スティング
lowPrice オンラインで見つかったアイテムの最低価格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

ユーザーを定義します。

名前 値 Type
_type 種類のヒント。 String
description 人物の簡単な説明。 String
image 人物の画像。 Image
jobTitle ユーザーの役職。 String
name ユーザーの名前。 String
twitterProfile ユーザーの Twitter プロファイルの URL。 String
url 該当する場合は、そのユーザーのソーシャル ネットワーク のホーム ページへの URL。 String
webSearchUrl このユーザーに関する情報を含むBing検索結果ページの URL。 String

ピボット

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

名前 値 Type
ピボット ピボットする元のクエリのセグメント。 String
提案 ピボットに対して推奨されるクエリの一覧。 クエリ

クエリ

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

名前 値 Type
displayText クエリ用語の表示バージョン。

展開されたクエリ ( queryExpansions を参照) とピボット候補 ( pivotSuggestions を参照) の場合、このフィールドは元のクエリを展開した用語を識別します。 たとえば、クエリが Microsoft Surface で、展開されたクエリが Microsoft Surface RT の場合、 displayTextRT が含まれます。		 String
searchLink 関連する検索の結果を取得するために使用する URL。 URL を使用する前に、必要に応じてクエリ パラメーターを追加し、 Ocp-Apim-Subscription-Key ヘッダーを含める必要があります。

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

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

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

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

レシピ

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

要素 説明 Type
aggregateRating レシピが他のユーザーによってどの程度評価されているかを示す集計された評価。 AggregateRating
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 認識されたエンティティの一覧。 RecognizedEnityGroup[]

RecognizedEntity

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

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

考えられるエンティティ オブジェクトを次に示します。
 Object
matchConfidence イメージ内のエンティティがこのエンティティと一致Bing信頼度。 信頼度は 0.0 から 1.0 の範囲で、1.0 は非常に信頼できます。 Float

RecognizedEntityGroup

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

要素 説明 Type
name エンティティのイメージも見つかったグループの名前。

可能なグループを次に示します。
  • CelebRecognitionAnnotations - CelebrityAnnotations に似ていますが、正確な一致の確率が高くなります。

  • CelebrityAnnotations - 俳優、政治家、アスリート、歴史的人物などの有名人が含まれています。
 String
recognizedEntityRegions エンティティを含むイメージの領域。 RecognizedEntityRegion[]

RecognizedEntityRegion

エンティティが見つかったイメージの領域と、それに一致する可能性があるエンティティの一覧を定義します。

要素 説明 Type
matchingEntities リージョンで見つかったエンティティBing一致すると思われるエンティティの一覧。 エンティティは信頼度の降順です (RecognizedEntity のフィールドを matchConfidence 参照)。 RecognizedEntity[]
region エンティティを含むイメージの領域。

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

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

Left = 0.033333333333333333333333333333

Top = 0.1

Right = 0.96666666666667

下 = 0.75

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

RelatedCollectionsModule

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

要素 説明 Type
value 関連する画像を含む Web ページの一覧。 ImageGallery[]

RelatedSearchesModule

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

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

タグ

イメージ内のコンテンツの特性を定義します。

要素 説明 Type
name 特性の名前。 たとえば、猫、キティ、カリコ猫などです。 String

サムネイル

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

要素 説明 Type
url 画像のサムネイルへの URL。 String

並べて表示

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

要素 説明 Type
image 画像のサムネイルへの URL。 Image
query 件名の画像が多いBing検索結果ページを返すクエリ。 たとえば、カテゴリが [人気のあるユーザーの検索] の場合、サムネイルは人気のあるユーザーの場合です。 クエリは、そのユーザーの画像が多いBing検索結果ページを返します。 クエリ

TrendingImages

トレンド イメージ要求が成功したときに応答に含まれる最上位のオブジェクト。

要素 説明 Type
categories 画像のカテゴリを識別するリストと、そのカテゴリの傾向のある画像の一覧。 Category[]

エラー コード

要求によって返される可能性のある 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 英語 en-US
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
ブルガリア語 bg
カタロニア語 ca
簡体中国語 zh-hans
繁体中国語 zh-hant
クロアチア語 hr
チェコ語 cs
デンマーク語 da
オランダ語 nl
英語 en
English-United王国 en-gb
エストニア語 et
フィンランド語 fi
フランス語 fr
ガリシア語 gl
ドイツ語 de
グジャラート語 gu
ヘブライ語 he
ヒンディー語 hi
ハンガリー語 hu
アイスランド語 :
イタリア語 it
日本語 Jp
カンナダ語 kn
韓国語 ko
ラトビア語 lv
リトアニア語 lt
マレー語 ms
マラヤーラム語 ml
マラーティー語 mr
ノルウェー語 - ブークモール nb
ポーランド語 pl
ポルトガル語 (ブラジル) pt-br
ポルトガル語 (ポルトガル) pt-pt
パンジャブ語 pa
ルーマニア語 ro
ロシア語 ru
セルビア語 (Cyrylic) sr
スロバキア語 sk
スロベニア語 sl
スペイン語 es
スウェーデン語 sv
タミル語 ta
テルグ語 te
タイ語 th
トルコ語 tr
ウクライナ語 uk
ベトナム語 vi