Image Search API v5 リファレンス

警告

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 の使用と表示の要件」を参照してください。

エンドポイント

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

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

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

要求では、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 をサポート チームに提供します。
Ocp-Apim-Subscription-Key 必須の要求ヘッダー。

Cognitive Services でこのサービスにサインアップしたときに受け取ったサブスクリプション キーです。
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 応答ヘッダーで返されます。 このヘッダーを要求に含めるべきでない唯一の場合は、ユーザーがそのデバイスでアプリを初めて使用するときです。

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

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

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

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

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

メモ MSEdge-ClientID を含める場合は、要求に cookie を含めないでください。
X-検索-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 キーを指定する場合にのみ指定します。

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

注: 省略可能ですが、ユーザーの地理的な場所は常に指定することをお勧めします。 位置情報を提供することは、クライアントの 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 Cal、cat、car、および 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 offset 結果の最初のページを取得するには、を20に設定し、を0に設定します。 それ以降の各ページでは、 offset 20 でインクリメントします (たとえば、0、20、40)。

このパラメーターは、Image Search API でのみサポートされています。Insights、トレンド画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
UnsignedShort いいえ
id イメージを一意に識別する ID。 このパラメーターを使用すると、指定したイメージがイメージリストの最初のイメージであることを確認できます。 イメージオブジェクトのフィールドには imageId 、このパラメーターを設定する ID が含まれています。 String いいえ
imgUrl 洞察を取得するイメージの URL。 このパラメーターは、パラメーターを使用してイメージを指定する代わりに使用し insightsToken ます。

イメージを指定するには、このパラメーターを使用するか、POST 要求の本体にイメージのバイナリを配置することができます (Content-type ヘッダーを参照してください)。

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

このパラメーターは、Insights API でのみサポートされています。画像、トレンドの画像、Web Search Api を呼び出すときは、このパラメーターを指定しないでください。
String いいえ
insightsToken 以前の Image Search API 呼び出しのトークン ( imageInsightsTokenを参照)。 キャプションやショッピングソースなどのイメージに関する追加情報を取得するには、このパラメーターを指定します。 取得できる追加情報の一覧については、「モジュールで 要求さ れるクエリパラメーター」を参照してください。

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

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

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

  • 注釈 — は、イメージ内で見つかったコンテンツの種類の特性を提供します。 たとえば、画像が人物の場合、注釈は、ユーザーの性別と、ユーザーが所有している衣類の種類を示している可能性があります。

  • イメージに — ついて説明している BRQ の最適なクエリ。

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

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

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

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

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

  • —関係者が、他のユーザーによって作成された関連検索の一覧を検索します。

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

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

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

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

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

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

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

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

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

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

クエリ文字列には、 Bing Advanced Operatorsを含めることができます。 たとえば、イメージを特定のドメインに制限するには、 site: 演算子を使用します。

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

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

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

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

指定しない場合、既定値は [中] です。

注: Bing の成人ポリシーを厳格に設定する必要がある市場から要求を受け取った場合 safeSearch 、bing は値を無視 safeSearch し、strict を使用します。

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

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

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

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

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

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

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

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

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

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

  • AnimatedGif — アニメーション gif のみを返す

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

  • 行の改行 — のみの描画

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

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

  • 透明 — 背景が透明な画像のみを返します。
String
使用 関連付けられているライセンスの種類によって結果をフィルター処理します。 使用できるフィルター値は次のとおりです。
  • 任意のライセンスの種類に該当 — するイメージを返します。 応答には、ライセンスを明示的に指定する画像のみが含まれます。

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

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

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

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

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

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

注: Bing では、特定のライセンスがイメージに関連付けられていることを確認したり、そのライセンスの下にあるイメージを使用したりすることはできません。 これらのライセンスの種類の詳細については、「 ライセンスの種類別にイメージをフィルター処理する」を参照してください。
String
サイズでイメージをフィルター処理します。 使用できるフィルター値は次のとおりです。
  • 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 オブジェクト、要求が image insights の場合は ImageInsightsResponse 、エンドポイントが/Images/trending. の場合は TrendingImages になります。 要求が失敗した場合、最上位レベルのオブジェクトは ErrorResponse オブジェクトになります。

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

AggregateOffer

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

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

集積

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

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

カテゴリ (TrendingImages)

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

TrendingImages 名前空間は、このオブジェクトを定義します。

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

カテゴリ (ImageInsights)

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

ImageInsights 名前空間は、このオブジェクトを定義します。

要素 説明 Type
confidence Bing がカテゴリを正しく識別したという自信を持っています。 有効な値は 0.0 ~ 1.0 です。1.0 は、Bing がカテゴリが正しいことを100% 確信していることを示します。 Float
name カテゴリの名前を指定します。 String

CategoryClassification

イメージ内で見つかった特性のカテゴリを定義します。

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

エラー

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

要素 説明 Type
code エラーを特定するエラー コード。 考えられるコードの一覧については、「エラー コード」を参照してください。 String
message エラーの説明。 String
parameter エラーを引き起こした要求内のクエリ パラメーター。 String
value 有効でなかったクエリ パラメーター値。 String

ErrorResponse

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

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

Image

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

注意

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

Name
アクセント色 イメージを優先する色を表す3バイトの16進数。 クライアントは、イメージが読み込まれるまで、一時的な背景として色を使用できます。 String
contentSize イメージのファイルサイズ。 文字列の形式は {size} {units} です。ここで、{units} はバイトの場合は B、KB の場合は KB に設定されます。たとえば、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 ページへのアクセスには使用しないでください。 URL にプロトコル (HTTP など) が含まれておらず、強調表示されている文字が含まれている場合があります。 ホストの web ページにアクセスするには、URL を使用し hostPageUrl ます。
String
hostPageUrl 画像を含む web ページの URL。

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

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

たとえば、画像が apple の円グラフの場合、このオブジェクトには、apple の円を購入できる web サイトの数が含まれます。 その後、バッジを含めることができます (たとえば、ショッピングカートのアイコン)。数はオファーの数を示します。 ユーザーがアイコンをクリックすると、を使用して imageInisghtsToken web サイトの一覧を取得できます。

バッジを表示するタイミングの関連情報については、「displayRecipeSourcesBadges and displayShoppingSourcesBadges」を参照してください。
InsightsSourcesSummary
指定 画像のタイトル。 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
thumbnailUrl コレクション内で見つかったいずれかのイメージのサムネイルの URL。 String
関連する画像のコレクションが含まれている web ページへの URL。 String

ImageInsightsResponse

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

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

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

Name Type
_type 種類のヒント。 String
bestRepresentativeQuery 画像を最もよく表すクエリ文字列。 オブジェクト内のリンクをクリックすると Query 、ユーザーは画像の画像が多くなる web ページに移動します。 クエリ
categoryClassification 画像内で見つかったコンテンツの特性を識別するカテゴリの一覧。 たとえば、画像が人物の場合、注釈は、ユーザーの性別と、ユーザーが所有している衣類の種類を示している可能性があります。 CategoryClassification
imagecap 画像に使用するキャプション。 Imagecap
imageInsightsToken イメージに関する追加情報を取得するために、Image Search API への後続の呼び出しで使用するトークン。 このトークンの使用方法の詳細については、 insightsToken クエリパラメーターを参照してください。

このトークンには、 イメージ オブジェクトに含まれているトークンと同じ使用法があります。 通常、このトークンは、 imgUrl クエリパラメーターを使用して Bing のイメージを送信するエンティティの認識シナリオで使用し、 モジュールの要求さ れたパラメーターを認識されたエンティティに設定します。 応答には、認識されたエンティティと、イメージに関する追加の洞察を得るために使用できる洞察トークンが含まれています。

"要求されたモジュール" を All に設定すると、認識されたエンティティに加えて利用可能なすべての洞察が得られます (以降の呼び出しでは、insights トークンを使用する必要はありません)。
String
以下を含むもの 画像が含まれている web ページの一覧。 Web ページにアクセスするには、画像のフィールドの URL を使用し hostPageUrl ます。 イメージ[]
レシピ イメージに関連するレシピの一覧。 たとえば、画像が apple の円の場合、一覧には、apple の円を作成するためのレシピが含まれます。 レシピ[]
認識 Izedentitygroups 指定されたイメージで見つかったエンティティに一致するエンティティのイメージを含むグループの一覧。 たとえば、エンティティがそのグループで認識された場合、応答には general 著名人グループの画像が含まれることがあります。 認識Izedentitygroup[]
関連性のあるコレクション 関連する画像が含まれている web ページへのリンクの一覧です。 Imagegallery[]
関連性のある検索 他のユーザーによって行われた関連クエリの一覧。 クエリ[]
shoppingSources イメージに関連する項目を提供している商人の一覧。 たとえば、画像が apple の円の場合、リストには、apple パイを販売している加盟店が含まれます。 AggregateOffer[]
visuallySimilarImages 元の画像のように視覚的に似た画像の一覧。 たとえば、指定された画像が水の本体を越えている場合は、水の本体に対する他の sunsets の類似画像の一覧です。

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

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

イメージ

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

Name Type
_type 種類のヒント。 String
displayRecipeSourcesBadges 使用可能なレシピがあることを示すためにバッジ取得含める必要があるかどうかを決定するブール値。 Bing はこのフラグを true に設定し、ユーザーの意図がレシピを検索することであると判断します。 Bing がユーザーの意図がレシピを見つけることであると信じられない場合、このフラグは false に設定されます。

displayRecipeSourcesBadges false recipeSourcesCount InsightsSourcesSummaryのフィールドの値が0より大きい場合でも、を false にすることができます。

このフラグは、単にユーザーの意図を示しています。 通常、イメージの recipeSourcesCount が0より大きく、 displayRecipeSourcesBadgestrue の場合、レシピバッジと count が画像に表示されます。 それ以外の場合、 displayRecipeSourcesBadgesfalse の場合、そうではありません。 アプリケーションでは、これらのフィールドを使用してバッジを表示するかどうかを決定する必要があります。
Boolean
displayShoppingSourcesBadges 利用可能なショッピングソースがあることを示すために、バッジを含めるかどうかを指定するブール値です (たとえば、ショッピングカートのアイコン)。 Bing は、ユーザーの意図がショッピングであると認識した場合に、このフラグを true に設定します。 Bing がユーザーの意図を購入すると信じられない場合、このフラグは false に設定されます。

displayShoppingSourcesBadges false shoppingSourcesCount InsightsSourcesSummaryのフィールドの値が0より大きい場合でも、を false にすることができます。

このフラグは、単にユーザーの意図を示しています。 通常、イメージの shoppingSourcesCount が0より大きく、が true の場合は、 displayShoppingSourcesBadges ショッピングバッジとカウントが画像に表示されます。 true それ以外の場合、 displayShoppingSourcesBadgesfalse の場合、そうではありません。 アプリケーションでは、これらのフィールドを使用してバッジを表示するかどうかを決定する必要があります。
Boolean
id 画像の解答を一意に識別する ID。

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

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

注: このフィールドは Web Search API 応答にのみ含まれ、Image Search API 応答には含まれません。
Boolean
nextOffsetAddCount ページングの結果が重複しないようにするために、 オフセット クエリパラメーターに追加する数値。

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

重複を防ぐには、の値を nextOffsetAddCount との合計に追加し count offset ます。 たとえば、との現在の値 offset count が30で、の値が9の場合、を nextOffsetAddCount offset 69 (Count + Offset + nextOffsetAddCount) に設定します。
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 ヘッダーを含める必要があります。

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

オブジェクトには、Image Search API を呼び出すときにのみ、このフィールドが含まれます。 Web Search API を呼び出す場合、オブジェクトにはこのフィールドは含まれません。
Long
value クエリに関連するイメージの一覧。

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

InsightsSourcesSummary

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

要素 説明 Type
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
低料金 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
url ユーザーのソーシャルネットワークのホームページの URL (該当する場合)。 String
webSearchUrl ユーザーがこのユーザー名を含むクエリの Bing 検索結果ページに移動する URL。 String

ピボット

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

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

Productの概要画像

製品のイメージを定義し、その製品に対して Bing がオンラインで見つけたオファーに関する概要情報を提供します。

注意

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

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

ユーザーインターフェイスでこの URL を使用して、イメージを含むホスト web ページを識別することができます。 この URL は適切な形式ではないため、ホスト web ページへのアクセスには使用しないでください。 URL にプロトコル (HTTP など) が含まれておらず、強調表示文字が含まれている可能性があります。 ホスト web ページにアクセスするには、プロパティで見つかった URL を使用し hostPageUrl ます。
String
hostPageUrl 画像を含む web ページの URL。

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

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

たとえば、画像が apple の円グラフの場合、このオブジェクトには、apple の円を購入できる web サイトの数が含まれます。 その後、バッジを含めることができます (たとえば、ショッピングカートのアイコン)。数はオファーの数を示します。 ユーザーがアイコンをクリックすると、を使用して imageInisghtsToken web サイトの一覧を取得できます。

バッジを表示するタイミングの関連情報については、「displayRecipeSourcesBadges and displayShoppingSourcesBadges」を参照してください。
InsightsSourcesSummary
name 画像のタイトル。 String
thumbnail サムネイルイメージの幅と高さ (「」を参照 thumbnailUrl )。 MediaSize
thumbnailUrl イメージのサムネイルの URL。 画像のサイズ変更の詳細については、「 サムネイル画像のサイズ変更とトリミング」を参照してください。 String
webSearchUrl このイメージの Bing 検索結果の URL。 String
width ソースイメージの幅 (ピクセル単位)。 Unsigned Short

クエリ

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

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 のようになります。 時刻形式の詳細については、「Wikipedia.com on の 期間 」を参照してください。 String
ファ レシピの作成者。 Person
name レシピの名前。 String
prepTime 成分を準備するために必要な時間。 たとえば、PT15M のようになります。 時刻形式の詳細については、「Wikipedia.com on の 期間 」を参照してください。 String
thumbnailUrl 準備された食べ物のサムネイル画像の URL。 String
totalTime レシピの準備とクックにかかる時間の合計。 たとえば、PT45M のようになります。 時刻形式の詳細については、「Wikipedia.com on の 期間 」を参照してください。 String
url レシピを含む web ページにユーザーを移動する URL。 String

認識 Izedentity

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

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

使用可能なエンティティオブジェクトを次に示します。
Object
matchConfidence Bing では、イメージ内のエンティティがこのエンティティと一致するという自信を持っています。 信頼度は、0.0 から1.0、0.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

サムネイル

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

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

タイル

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

要素 説明 Type
image イメージのサムネイルの URL。 Image
query 対象の画像が多い Bing の検索結果ページを返すクエリ。 たとえば、カテゴリが人気のある人の検索である場合、フィールドのサムネイルは image 人気のあるユーザーになります。 人の他のイメージを取得するには、オブジェクト内のリンクを使用し Query ます。 クエリ

TrendingImages

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

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

エラー コード

要求が返す可能性のある HTTP 状態コードを次に示します。

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

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

要求が失敗した場合、応答の本文にはErrorResponseオブジェクトが含まれます。 応答オブジェクトには、エラー コードとエラーの説明が含まれます。 エラーがパラメータに関連している場合、parameterフィールドは問題となっているパラメータを識別します。 エラーがパラメータ値に関連している場合、valueフィールドは無効な値を識別します。

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "RequestParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}


{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "AuthorizationMissing", 
      "message": "Authorization is required.", 
    }
  ]
}

考えられるエラー コードは次のとおりです。

エラー コード 説明
RequestParameterMissing 要求に必要なパラメーターがありません。 このparameterフィールドは、欠落しているパラメーターを識別します。
RequestParameterInvalidValue パラメーター値が無効です。 このparameterフィールドは無効な値を含むパラメーターを識別し、valueそのフィールドに無効な値が含まれています。
ResourceAccessDenied 呼び出し元にリソースへのアクセス許可がありません。 このエラーは、サブスクリプション キーが無効になっているか、期限が切れている場合に発生することがあります。
ExceededVolume 呼び出し元は、1 か月あたりのクエリ (QPM) クォータを超えました。
ExceededQpsLimit 呼び出し元は 1 秒あたりのクエリ数 (QPS) を超えました。
無効 呼び出し元にリソースへのアクセス許可がありません。
UnexpectedError サーバーで予期しないエラーが発生しました。 後で再試行してください。
DataSourceErrors リソースへのアクセスエラーが発生しました。
AuthorizationMissing Bingは呼び出し元を認証できません。 このエラーは、ヘッダーがOcp-Apim-Subscription-Key見つからない場合に発生することがあります。
HttpNotAllowed 要求では、HTTPS プロトコルの代わりに HTTP プロトコルが使用されました。Bingは HTTPS のみをサポートします。
InvalidAuthorization Bingは呼び出し元を認証できません。 これは、サブスクリプション キーが無効な場合に発生することがあります。
InsufficientScope 呼び出し元にリソースへのアクセス許可がありません。 このエラーは、サブスクリプション キーの有効期限が切れている場合に発生する可能性があります。

市場コード

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

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

国/リージョン 言語 市場コード
アルゼンチン Spanish es-AR
オーストラリア English en-AU
オーストリア German de-AT
ベルギー Dutch nl-BE
ベルギー French fr-BE
ブラジル Portuguese pt-BR
Canada English en-CA
Canada French fr-CA
チリ Spanish es-CL
デンマーク Danish da-DK
フィンランド Finnish fi-FI
フランス French fr-FR
ドイツ German de-DE
香港特別行政区 Traditional Chinese zh-HK
インド English en-IN
インドネシア English en-ID
イタリア Italian it-IT
日本 Japanese ja-JP
韓国 Korean ko-KR
マレーシア English en-MY
メキシコ Spanish es-MX
オランダ Dutch nl-NL
ニュージーランド English en-NZ
ノルウェー ノルウェー語 no-NO
中華人民共和国 Chinese zh-CN
ポーランド Polish pl-PL
フィリピン共和国 English en-PH
ロシア Russian ru-RU
南アフリカ English en-ZA
スペイン Spanish es-ES
スウェーデン Swedish sv-SE
スイス French fr-CH
スイス German de-CH
台湾 Traditional Chinese zh-TW
トルコ Turkish tr-TR
イギリス English en-GB
United States English ja-JP
United States Spanish 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