WebSearchOptionalParams interface

パッケージ:

@azure/cognitiveservices-websearch

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

acceptLanguage	ユーザー インターフェイス文字列に使用する 1 つ以上の言語のコンマ区切りのリスト。 リストは優先順位が下がって表示されます。 必要な形式を含む追加情報については、RFC2616を参照してください。 このヘッダーと setLang クエリ パラメーターは相互に排他的です。両方を指定しないでください。 このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。 Bingは、リストから検索した最初のサポートされている言語を使用し、その言語と cc パラメーター値を組み合わせて、結果を返す市場を決定します。 リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索し、指定された言語ではなく集計または既定の市場を結果に使用できます。 このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用してください。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 ユーザー インターフェイス文字列は、ユーザー インターフェイスのラベルとして使用される文字列です。 JSON 応答オブジェクトには、ユーザー インターフェイス文字列はほとんどありません。 応答オブジェクト内の Bing.com プロパティへのリンクは、指定された言語を適用します。
answerCount	応答に含める回答の数。 Bing返される回答は、ランキングに基づいています。 たとえば、Bingが要求の Web ページ、画像、ビデオ、および relatedSearches を返し、このパラメーターを 2 に設定した場合、応答には Web ページと画像が含まれます。同じ要求に responseFilter クエリ パラメーターを含めて Web ページとニュースに設定した場合、応答には Web ページのみが含まれます。
clientId	Bingでは、このヘッダーを使用して、Bing API 呼び出し間で一貫した動作をユーザーに提供します。 Bing多くの場合、フライトの新機能や機能強化が行われ、さまざまなフライトでトラフィックを割り当てるためのキーとしてクライアント ID が使用されます。 複数の要求にわたってユーザーに同じクライアント ID を使用しない場合、Bingは、競合する複数のフライトにユーザーを割り当てることができます。 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスが一貫性を失う可能性があります。 たとえば、2 番目の要求に最初の要求とは異なるフライト割り当てがある場合、予期しないエクスペリエンスになる可能性があります。 また、Bingはクライアント ID を使用して、そのクライアント ID の検索履歴に合わせて Web 結果を調整し、ユーザーに豊富なエクスペリエンスを提供できます。 Bingは、このヘッダーを使用して、クライアント ID によって生成されたアクティビティを分析することで、結果のランク付けを改善するのにも役立ちます。 関連性の向上は、Bing API によって提供される結果の品質の向上に役立ち、API コンシューマーのクリックスルー率が高くなります。 重要: 省略可能ですが、このヘッダーは必須と考える必要があります。 同じエンド ユーザーとデバイスの組み合わせに対して複数の要求にわたってクライアント ID を保持すると、1) API コンシューマーは一貫したユーザー エクスペリエンスを受け取り、2) Bing API からの結果の品質を向上させ、クリックスルー率を高くすることができます。 デバイスでアプリケーションを使用する各ユーザーには、一意のBing生成されたクライアント ID が必要です。 このヘッダーを要求に含めなかった場合、Bingは ID を生成し、X-MSEdge-ClientID 応答ヘッダーに返します。 このヘッダーを要求に含めてはいけないのは、ユーザーがそのデバイスでアプリを初めて使用する場合だけです。 アプリがデバイス上のこのユーザーに対して行うBing API 要求ごとにクライアント ID を使用します。 クライアント ID を保持します。 ブラウザー アプリで ID を保持するには、永続的な HTTP Cookie を使用して、すべてのセッションで ID が使用されるようにします。 セッション Cookie を使用しないでください。 モバイル アプリなどの他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。 次回、ユーザーがそのデバイスでアプリを使用するときに、永続化したクライアント ID を取得します。 Bing応答には、このヘッダーが含まれている場合と含まれていない場合があります。 応答にこのヘッダーが含まれている場合は、クライアント ID をキャプチャし、そのデバイス上のユーザーに対する後続のすべてのBing要求に使用します。 X-MSEdge-ClientID を含める場合は、要求に Cookie を含めてはなりません。
clientIp	クライアント デバイスの IPv4 または IPv6 アドレス。 IP アドレスは、ユーザーの場所を検出するために使用されます。 Bingは、場所情報を使用して安全な検索動作を決定します。 省略可能ですが、常にこのヘッダーと X-Search-Location ヘッダーを指定することをお勧めします。 アドレスを難読化しないでください (たとえば、最後のオクテットを 0 に変更するなど)。 アドレスを難読化すると、デバイスの実際の場所の近くに場所が表示されず、誤った結果を提供Bing可能性があります。
count	応答で返される検索結果の数。 既定値は 10 で、最大値は 50 です。 実際に配信される数は、要求された数より少ない場合があります。このパラメーターをオフセット パラメーターと共に使用して、結果をページングします。たとえば、ユーザー インターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に設定し、オフセットを 0 に設定して結果の最初のページを取得します。 後続のページごとに、オフセットを 10 ずつインクリメントします (例: 0、10、20)。 結果に複数のページが重複している可能性があります。
countryCode	結果の取得国の 2 文字の国コード。 この API は、米国市場のみをサポートしています。 このクエリ パラメーターを指定する場合は、このパラメーターを Us に設定する必要があります。 このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bingでは、言語リストから検索した最初のサポートされている言語を使用し、その言語を指定した国コードと組み合わせて、結果を返す市場を決定します。 言語リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索するか、指定された言語ではなく集計または既定の市場を結果に使用できます。 このクエリ パラメーターと Accept-Language クエリ パラメーターは、複数の言語を指定する場合にのみ使用する必要があります。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 このパラメーターと mkt クエリ パラメーターは相互に排他的であり、両方を指定しないでください。
freshness	[日] - 過去 24 時間以内に検出Bing Web ページを返します。 週 - 過去 7 日以内に検出Bing Web ページを返します。 月 - 過去 30 日以内に検出された Web ページを返します。 このフィルターは、Web ページの結果にのみ適用され、ニュースや画像などの他の結果には適用されません。 指定できる値は、'Day'、'Week'、'Month' です。
location	クライアントの地理的位置を記述するキーと値のペアのセミコロン区切りのリスト。 Bingは、場所情報を使用して安全な検索動作を決定し、関連するローカル コンテンツを返します。 <のキー/値のペアを指定し、キー>: 値<>とします。 ユーザーの場所を指定するために使用するキーを次に示します。 lat (必須): クライアントの場所の緯度 (度単位)。 緯度は -90.0 以上で、+90.0 以下である必要があります。 負の値は南の緯度を示し、正の値は北の緯度を示します。 long (必須): クライアントの場所の経度 (度単位)。 経度は -180.0 以上で、+180.0 以下である必要があります。 負の値は西の経度を示し、正の値は東部経度を示します。 re (必須): 座標の水平方向の精度を指定する半径 (メートル単位)。 デバイスの位置情報サービスによって返される値を渡します。 一般的な値は、GPS/Wi-Fi の場合は 22m、セル タワーの三角形分割では 380m、逆 IP 参照では 18,000m です。 ts (省略可能): クライアントが場所にいた時刻の UTC UNIX タイムスタンプ。 (UNIX タイムスタンプは、1970 年 1 月 1 日以降の秒数です。head (省略可能): クライアントの相対見出しまたは移動方向。 移動方向を 0 ~ 360 の角度として指定し、真北を基準に時計回りにカウントします。 sp キーが 0 以外の場合にのみ、このキーを指定します。 sp (省略可能): クライアント デバイスが移動している水平速度 (速度) (メートル/秒)。 alt (省略可能): クライアント デバイスの高度 (メートル単位)。 は (省略可能): 座標の垂直方向の精度を指定する半径 (メートル単位)。 このキーは、alt キーを指定した場合にのみ指定します。 キーの多くは省略可能ですが、提供する情報が多いほど、場所の結果は正確になります。 省略可能ですが、ユーザーの地理的な場所を常に指定することをお勧めします。 場所を指定することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントが VPN を使用している場合) に特に重要です。 最適な結果を得るには、このヘッダーと X-MSEdge-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。
market	結果の出所となる市場。 通常、mkt はユーザーが要求を行っている国です。 ただし、Bingが結果を提供する国にユーザーがいない場合は、別の国になる可能性があります。 市場は <言語コード>-<国コード>の形式である必要があります。 たとえば、en-USします。 文字列では大文字と小文字が区別されません。 既知の場合は、常に市場を指定することをお勧めします。 市場を指定すると、Bing要求をルーティングし、適切で最適な応答を返すのに役立ちます。 市場コードに記載されていない市場を指定した場合、Bingは変更される可能性のある内部マッピングに基づいて最適な市場コードを使用します。 このパラメーターと cc クエリ パラメーターは相互に排他的であり、両方を指定しないでください。 既定値: 'en-us'。
offset	結果を返す前にスキップする検索結果の数を示す 0 から始まるオフセット。 既定値は 0 です。 オフセットは (totalEstimatedMatches - count) 未満にする必要があります。 このパラメーターを count パラメーターと共に使用して、結果をページングします。 たとえば、ユーザー インターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に設定し、オフセットを 0 に設定して結果の最初のページを取得します。 後続のページごとに、オフセットを 10 ずつインクリメントします (例: 0、10、20)。 結果に複数のページが重複している可能性があります。
pragma	既定では、Bingはキャッシュされたコンテンツ (使用可能な場合) を返します。 Bingがキャッシュされたコンテンツを返さないようにするには、Pragma ヘッダーを no-cache (Pragma: no-cache など) に設定します。
promote	ランク付けに関係なく、応答に含める回答のコンマ区切りの一覧。 たとえば、answerCount) を 2 (2) に設定し、上位 2 つのランク付けされた回答を返Bing、応答にニュースを含める場合は、昇格をニュースに設定します。 上位の回答が Web ページ、画像、ビデオ、および関連検索である場合、ニュースはランク付けされた回答ではないため、応答には Web ページと画像が含まれます。 ただし、昇格をビデオに設定すると、Bingはビデオの回答を応答に昇格させ、Web ページ、画像、ビデオを返します。 昇格する回答は、answerCount の制限に対してカウントされません。 たとえば、ランク付けされた回答がニュース、画像、ビデオで、answerCount を 1 に設定してニュースに昇格した場合、応答にはニュースと画像が含まれます。 または、ランク付けされた回答がビデオ、画像、ニュースである場合、応答にはビデオとニュースが含まれます。 指定できる値は、コンピュテーション、画像、ニュース、RelatedSearches、SpellSuggestions、TimeZone、Videos、Web ページです。 answerCount を指定する場合にのみ使用します。
responseFilter	応答に含める回答のコンマ区切りの一覧。 このパラメーターを指定しない場合、応答には関連するデータがあるすべての検索回答が含まれます。 使用可能なフィルター値は、コンピュテーション、画像、ニュース、RelatedSearches、SpellSuggestions、TimeZone、Videos、Web ページです。 このフィルターを使用して 1 つの回答を取得することもできますが、より豊富な結果を得るには、代わりに回答固有のエンドポイントを使用する必要があります。 たとえば、イメージのみを受信するには、Image Search API エンドポイントのいずれかに要求を送信します。 RelatedSearches と SpellSuggestions の回答は、Image Search API のように個別のエンドポイントをサポートしていません (Web Search API のみが返します)。 順位付けのために除外される回答を含めるには、昇格クエリ パラメーターを参照してください。
safeSearch	成人向けコンテンツをフィルター処理するために使用されるフィルター。 オフ: 成人用のテキスト、画像、またはビデオを含む Web ページを返します。 中: 成人用のテキストを含む Web ページを返しますが、成人用の画像やビデオは返しません。 厳密: 成人用のテキスト、画像、またはビデオを含む Web ページを返さないでください。 既定値は Moderate です。 Bingの成人向けポリシーで safeSearch が Strict に設定されている必要がある市場からの要求の場合、Bingは safeSearch 値を無視し、Strict を使用します。 site: クエリ演算子を使用する場合、safeSearch クエリ パラメーターの設定に関係なく、応答に成人向けコンテンツが含まれる可能性があります。 サイトを使用する: サイト上のコンテンツを認識していて、シナリオが成人用コンテンツの可能性をサポートしている場合にのみ使用します。 指定できる値は、'Off'、'Moderate'、'Strict' です。
setLang	ユーザー インターフェイス文字列に使用する言語。 ISO 639-1 2 文字の言語コードを使用して言語を指定します。 たとえば、英語の言語コードは EN です。 既定値は EN (英語) です。 省略可能ですが、常に言語を指定する必要があります。 通常、ユーザーが別の言語でユーザー インターフェイス文字列を表示する必要がない限り、setLang を mkt で指定された同じ言語に設定します。 このパラメーターと Accept-Language ヘッダーは相互に排他的です。両方を指定しないでください。 ユーザー インターフェイス文字列は、ユーザー インターフェイスのラベルとして使用される文字列です。 JSON 応答オブジェクトには、ユーザー インターフェイス文字列はほとんどありません。 また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定した言語が適用されます。
textDecorations	表示文字列に、ヒット強調表示文字などの装飾マーカーを含めるかどうかを決定するブール値。 true の場合、文字列にマーカーを含めることができます。 既定値は false です。 マーカーとして Unicode 文字または HTML タグのどちらを使用するかを指定するには、textFormat クエリ パラメーターを参照してください。
textFormat	テキスト装飾に使用するマーカーの種類 (textDecorations クエリ パラメーターを参照)。 指定できる値は Raw です。Unicode 文字を使用して、特別な書式設定が必要なコンテンツをマークします。 Unicode 文字の範囲は E000 から E019 です。 たとえば、Bingでは、E000 と E001 を使用して、クエリ用語の先頭と末尾にヒット強調表示のマークを付けます。 HTML - HTML タグを使用して、特別な書式設定が必要なコンテンツをマークします。 たとえば、 タグを使用して、表示文字列内のクエリ用語を強調表示します。 既定値は Raw です。 <、>、&などのエスケープ可能な HTML 文字を含む表示文字列の場合、textFormat が HTML に設定されている場合、Bingは必要に応じて文字をエスケープします (たとえば、< は <にエスケープされます)。 使用可能な値は、'Raw'、'Html' です。
userAgent	要求を開始したユーザー エージェント。 Bingでは、ユーザー エージェントを使用して、モバイル ユーザーに最適化されたエクスペリエンスを提供します。 省略可能ですが、常にこのヘッダーを指定することを強くお勧めします。 ユーザー エージェントは、一般的に使用されるブラウザーが送信する文字列と同じである必要があります。 ユーザー エージェントの詳細については、RFC 2616 参照してください。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

acceptLanguage

ユーザー インターフェイス文字列に使用する 1 つ以上の言語のコンマ区切りのリスト。 リストは優先順位が下がって表示されます。 必要な形式を含む追加情報については、RFC2616を参照してください。 このヘッダーと setLang クエリ パラメーターは相互に排他的です。両方を指定しないでください。 このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。 Bingは、リストから検索した最初のサポートされている言語を使用し、その言語と cc パラメーター値を組み合わせて、結果を返す市場を決定します。 リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索し、指定された言語ではなく集計または既定の市場を結果に使用できます。 このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用してください。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 ユーザー インターフェイス文字列は、ユーザー インターフェイスのラベルとして使用される文字列です。 JSON 応答オブジェクトには、ユーザー インターフェイス文字列はほとんどありません。 応答オブジェクト内の Bing.com プロパティへのリンクは、指定された言語を適用します。

acceptLanguage?: string

プロパティ値

string

answerCount

応答に含める回答の数。 Bing返される回答は、ランキングに基づいています。 たとえば、Bingが要求の Web ページ、画像、ビデオ、および relatedSearches を返し、このパラメーターを 2 に設定した場合、応答には Web ページと画像が含まれます。同じ要求に responseFilter クエリ パラメーターを含めて Web ページとニュースに設定した場合、応答には Web ページのみが含まれます。

answerCount?: number

プロパティ値

number

clientId

Bingでは、このヘッダーを使用して、Bing API 呼び出し間で一貫した動作をユーザーに提供します。 Bing多くの場合、フライトの新機能や機能強化が行われ、さまざまなフライトでトラフィックを割り当てるためのキーとしてクライアント ID が使用されます。 複数の要求にわたってユーザーに同じクライアント ID を使用しない場合、Bingは、競合する複数のフライトにユーザーを割り当てることができます。 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスが一貫性を失う可能性があります。 たとえば、2 番目の要求に最初の要求とは異なるフライト割り当てがある場合、予期しないエクスペリエンスになる可能性があります。 また、Bingはクライアント ID を使用して、そのクライアント ID の検索履歴に合わせて Web 結果を調整し、ユーザーに豊富なエクスペリエンスを提供できます。 Bingは、このヘッダーを使用して、クライアント ID によって生成されたアクティビティを分析することで、結果のランク付けを改善するのにも役立ちます。 関連性の向上は、Bing API によって提供される結果の品質の向上に役立ち、API コンシューマーのクリックスルー率が高くなります。 重要: 省略可能ですが、このヘッダーは必須と考える必要があります。 同じエンド ユーザーとデバイスの組み合わせに対して複数の要求にわたってクライアント ID を保持すると、1) API コンシューマーは一貫したユーザー エクスペリエンスを受け取り、2) Bing API からの結果の品質を向上させ、クリックスルー率を高くすることができます。 デバイスでアプリケーションを使用する各ユーザーには、一意のBing生成されたクライアント ID が必要です。 このヘッダーを要求に含めなかった場合、Bingは ID を生成し、X-MSEdge-ClientID 応答ヘッダーに返します。 このヘッダーを要求に含めてはいけないのは、ユーザーがそのデバイスでアプリを初めて使用する場合だけです。 アプリがデバイス上のこのユーザーに対して行うBing API 要求ごとにクライアント ID を使用します。 クライアント ID を保持します。 ブラウザー アプリで ID を保持するには、永続的な HTTP Cookie を使用して、すべてのセッションで ID が使用されるようにします。 セッション Cookie を使用しないでください。 モバイル アプリなどの他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。 次回、ユーザーがそのデバイスでアプリを使用するときに、永続化したクライアント ID を取得します。 Bing応答には、このヘッダーが含まれている場合と含まれていない場合があります。 応答にこのヘッダーが含まれている場合は、クライアント ID をキャプチャし、そのデバイス上のユーザーに対する後続のすべてのBing要求に使用します。 X-MSEdge-ClientID を含める場合は、要求に Cookie を含めてはなりません。

clientId?: string

プロパティ値

string

clientIp

クライアント デバイスの IPv4 または IPv6 アドレス。 IP アドレスは、ユーザーの場所を検出するために使用されます。 Bingは、場所情報を使用して安全な検索動作を決定します。 省略可能ですが、常にこのヘッダーと X-Search-Location ヘッダーを指定することをお勧めします。 アドレスを難読化しないでください (たとえば、最後のオクテットを 0 に変更するなど)。 アドレスを難読化すると、デバイスの実際の場所の近くに場所が表示されず、誤った結果を提供Bing可能性があります。

clientIp?: string

プロパティ値

string

count

応答で返される検索結果の数。 既定値は 10 で、最大値は 50 です。 実際に配信される数は、要求された数より少ない場合があります。このパラメーターをオフセット パラメーターと共に使用して、結果をページングします。たとえば、ユーザー インターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に設定し、オフセットを 0 に設定して結果の最初のページを取得します。 後続のページごとに、オフセットを 10 ずつインクリメントします (例: 0、10、20)。 結果に複数のページが重複している可能性があります。

count?: number

プロパティ値

number

countryCode

結果の取得国の 2 文字の国コード。 この API は、米国市場のみをサポートしています。 このクエリ パラメーターを指定する場合は、このパラメーターを Us に設定する必要があります。 このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bingでは、言語リストから検索した最初のサポートされている言語を使用し、その言語を指定した国コードと組み合わせて、結果を返す市場を決定します。 言語リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索するか、指定された言語ではなく集計または既定の市場を結果に使用できます。 このクエリ パラメーターと Accept-Language クエリ パラメーターは、複数の言語を指定する場合にのみ使用する必要があります。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 このパラメーターと mkt クエリ パラメーターは相互に排他的であり、両方を指定しないでください。

countryCode?: string

プロパティ値

string

freshness

[日] - 過去 24 時間以内に検出Bing Web ページを返します。 週 - 過去 7 日以内に検出Bing Web ページを返します。 月 - 過去 30 日以内に検出された Web ページを返します。 このフィルターは、Web ページの結果にのみ適用され、ニュースや画像などの他の結果には適用されません。 指定できる値は、'Day'、'Week'、'Month' です。

freshness?: Freshness

プロパティ値

Freshness

location

クライアントの地理的位置を記述するキーと値のペアのセミコロン区切りのリスト。 Bingは、場所情報を使用して安全な検索動作を決定し、関連するローカル コンテンツを返します。 <のキー/値のペアを指定し、キー>: 値<>とします。 ユーザーの場所を指定するために使用するキーを次に示します。 lat (必須): クライアントの場所の緯度 (度単位)。 緯度は -90.0 以上で、+90.0 以下である必要があります。 負の値は南の緯度を示し、正の値は北の緯度を示します。 long (必須): クライアントの場所の経度 (度単位)。 経度は -180.0 以上で、+180.0 以下である必要があります。 負の値は西の経度を示し、正の値は東部経度を示します。 re (必須): 座標の水平方向の精度を指定する半径 (メートル単位)。 デバイスの位置情報サービスによって返される値を渡します。 一般的な値は、GPS/Wi-Fi の場合は 22m、セル タワーの三角形分割では 380m、逆 IP 参照では 18,000m です。 ts (省略可能): クライアントが場所にいた時刻の UTC UNIX タイムスタンプ。 (UNIX タイムスタンプは、1970 年 1 月 1 日以降の秒数です。head (省略可能): クライアントの相対見出しまたは移動方向。 移動方向を 0 ~ 360 の角度として指定し、真北を基準に時計回りにカウントします。 sp キーが 0 以外の場合にのみ、このキーを指定します。 sp (省略可能): クライアント デバイスが移動している水平速度 (速度) (メートル/秒)。 alt (省略可能): クライアント デバイスの高度 (メートル単位)。 は (省略可能): 座標の垂直方向の精度を指定する半径 (メートル単位)。 このキーは、alt キーを指定した場合にのみ指定します。 キーの多くは省略可能ですが、提供する情報が多いほど、場所の結果は正確になります。 省略可能ですが、ユーザーの地理的な場所を常に指定することをお勧めします。 場所を指定することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントが VPN を使用している場合) に特に重要です。 最適な結果を得るには、このヘッダーと X-MSEdge-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。

location?: string

プロパティ値

string

market

結果の出所となる市場。 通常、mkt はユーザーが要求を行っている国です。 ただし、Bingが結果を提供する国にユーザーがいない場合は、別の国になる可能性があります。 市場は <言語コード>-<国コード>の形式である必要があります。 たとえば、en-USします。 文字列では大文字と小文字が区別されません。 既知の場合は、常に市場を指定することをお勧めします。 市場を指定すると、Bing要求をルーティングし、適切で最適な応答を返すのに役立ちます。 市場コードに記載されていない市場を指定した場合、Bingは変更される可能性のある内部マッピングに基づいて最適な市場コードを使用します。 このパラメーターと cc クエリ パラメーターは相互に排他的であり、両方を指定しないでください。 既定値: 'en-us'。

market?: string

プロパティ値

string

offset

結果を返す前にスキップする検索結果の数を示す 0 から始まるオフセット。 既定値は 0 です。 オフセットは (totalEstimatedMatches - count) 未満にする必要があります。 このパラメーターを count パラメーターと共に使用して、結果をページングします。 たとえば、ユーザー インターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に設定し、オフセットを 0 に設定して結果の最初のページを取得します。 後続のページごとに、オフセットを 10 ずつインクリメントします (例: 0、10、20)。 結果に複数のページが重複している可能性があります。

offset?: number

プロパティ値

number

pragma

既定では、Bingはキャッシュされたコンテンツ (使用可能な場合) を返します。 Bingがキャッシュされたコンテンツを返さないようにするには、Pragma ヘッダーを no-cache (Pragma: no-cache など) に設定します。

pragma?: string

プロパティ値

string

promote

ランク付けに関係なく、応答に含める回答のコンマ区切りの一覧。 たとえば、answerCount) を 2 (2) に設定し、上位 2 つのランク付けされた回答を返Bing、応答にニュースを含める場合は、昇格をニュースに設定します。 上位の回答が Web ページ、画像、ビデオ、および関連検索である場合、ニュースはランク付けされた回答ではないため、応答には Web ページと画像が含まれます。 ただし、昇格をビデオに設定すると、Bingはビデオの回答を応答に昇格させ、Web ページ、画像、ビデオを返します。 昇格する回答は、answerCount の制限に対してカウントされません。 たとえば、ランク付けされた回答がニュース、画像、ビデオで、answerCount を 1 に設定してニュースに昇格した場合、応答にはニュースと画像が含まれます。 または、ランク付けされた回答がビデオ、画像、ニュースである場合、応答にはビデオとニュースが含まれます。 指定できる値は、コンピュテーション、画像、ニュース、RelatedSearches、SpellSuggestions、TimeZone、Videos、Web ページです。 answerCount を指定する場合にのみ使用します。

promote?: AnswerType[]

プロパティ値

AnswerType[]

responseFilter

応答に含める回答のコンマ区切りの一覧。 このパラメーターを指定しない場合、応答には関連するデータがあるすべての検索回答が含まれます。 使用可能なフィルター値は、コンピュテーション、画像、ニュース、RelatedSearches、SpellSuggestions、TimeZone、Videos、Web ページです。 このフィルターを使用して 1 つの回答を取得することもできますが、より豊富な結果を得るには、代わりに回答固有のエンドポイントを使用する必要があります。 たとえば、イメージのみを受信するには、Image Search API エンドポイントのいずれかに要求を送信します。 RelatedSearches と SpellSuggestions の回答は、Image Search API のように個別のエンドポイントをサポートしていません (Web Search API のみが返します)。 順位付けのために除外される回答を含めるには、昇格クエリ パラメーターを参照してください。

responseFilter?: AnswerType[]

プロパティ値

AnswerType[]

safeSearch

成人向けコンテンツをフィルター処理するために使用されるフィルター。 オフ: 成人用のテキスト、画像、またはビデオを含む Web ページを返します。 中: 成人用のテキストを含む Web ページを返しますが、成人用の画像やビデオは返しません。 厳密: 成人用のテキスト、画像、またはビデオを含む Web ページを返さないでください。 既定値は Moderate です。 Bingの成人向けポリシーで safeSearch が Strict に設定されている必要がある市場からの要求の場合、Bingは safeSearch 値を無視し、Strict を使用します。 site: クエリ演算子を使用する場合、safeSearch クエリ パラメーターの設定に関係なく、応答に成人向けコンテンツが含まれる可能性があります。 サイトを使用する: サイト上のコンテンツを認識していて、シナリオが成人用コンテンツの可能性をサポートしている場合にのみ使用します。 指定できる値は、'Off'、'Moderate'、'Strict' です。

safeSearch?: SafeSearch

プロパティ値

SafeSearch

setLang

ユーザー インターフェイス文字列に使用する言語。 ISO 639-1 2 文字の言語コードを使用して言語を指定します。 たとえば、英語の言語コードは EN です。 既定値は EN (英語) です。 省略可能ですが、常に言語を指定する必要があります。 通常、ユーザーが別の言語でユーザー インターフェイス文字列を表示する必要がない限り、setLang を mkt で指定された同じ言語に設定します。 このパラメーターと Accept-Language ヘッダーは相互に排他的です。両方を指定しないでください。 ユーザー インターフェイス文字列は、ユーザー インターフェイスのラベルとして使用される文字列です。 JSON 応答オブジェクトには、ユーザー インターフェイス文字列はほとんどありません。 また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定した言語が適用されます。

setLang?: string

プロパティ値

string

textDecorations

表示文字列に、ヒット強調表示文字などの装飾マーカーを含めるかどうかを決定するブール値。 true の場合、文字列にマーカーを含めることができます。 既定値は false です。 マーカーとして Unicode 文字または HTML タグのどちらを使用するかを指定するには、textFormat クエリ パラメーターを参照してください。

textDecorations?: boolean

プロパティ値

boolean

textFormat

テキスト装飾に使用するマーカーの種類 (textDecorations クエリ パラメーターを参照)。 指定できる値は Raw です。Unicode 文字を使用して、特別な書式設定が必要なコンテンツをマークします。 Unicode 文字の範囲は E000 から E019 です。 たとえば、Bingでは、E000 と E001 を使用して、クエリ用語の先頭と末尾にヒット強調表示のマークを付けます。 HTML - HTML タグを使用して、特別な書式設定が必要なコンテンツをマークします。 たとえば、 タグを使用して、表示文字列内のクエリ用語を強調表示します。 既定値は Raw です。 <、>、&などのエスケープ可能な HTML 文字を含む表示文字列の場合、textFormat が HTML に設定されている場合、Bingは必要に応じて文字をエスケープします (たとえば、< は <にエスケープされます)。 使用可能な値は、'Raw'、'Html' です。

textFormat?: TextFormat

プロパティ値

TextFormat

userAgent

要求を開始したユーザー エージェント。 Bingでは、ユーザー エージェントを使用して、モバイル ユーザーに最適化されたエクスペリエンスを提供します。 省略可能ですが、常にこのヘッダーを指定することを強くお勧めします。 ユーザー エージェントは、一般的に使用されるブラウザーが送信する文字列と同じである必要があります。 ユーザー エージェントの詳細については、RFC 2616 参照してください。

userAgent?: string

プロパティ値

string

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

msRest.RequestOptionsBase.abortSignal から継承された

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders から継承された

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress から継承された

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承された