Method: cse.siterestrict.list

実行した検索、検索に使用したエンジン、検索結果に関するメタデータを返します。少数の URL パターンを使用します。

HTTP リクエスト

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
c2coff

string

[簡体字中国語と繁体字中国語検索] を有効または無効にします。

このパラメータのデフォルト値は 0(ゼロ)で、この機能が有効になっていることを意味します。サポートされている値は次のとおりです。

  • 1: 無効

  • 0: 有効(デフォルト)

cr

string

特定の国で作成されたドキュメントに検索結果を制限します。cr パラメータの値には、ブール演算子を使用できます。

Google 検索では、以下を分析してドキュメントの国を判別します。

  • ドキュメントの URL のトップレベル ドメイン(TLD)

  • ウェブサーバーの IP アドレスの地理的位置

このパラメータに使用できる値の一覧については、国のパラメータ値をご覧ください。

cx

string

このリクエストに使用するプログラム可能検索エンジン ID。

dateRestrict

string

日付に基づいて結果を URL に制限します。次の値がサポートされています。

  • d[number]: 指定した過去の日数の結果をリクエストします。

  • w[number]: 指定した週数の結果をリクエストします。

  • m[number]: 指定した月数の結果をリクエストします。

  • y[number]: 指定した年数の結果をリクエストします。

exactTerms

string

検索結果内のすべてのドキュメントに含める必要がある語句を示します。

excludeTerms

string

検索結果のどのドキュメントにも表示すべきでない語句を特定します。

fileType

string

結果を特定の拡張子のファイルに制限します。Google でインデックス登録できるファイル形式の一覧については、Search Console のヘルプセンターをご覧ください。

filter

string

重複コンテンツ フィルタのオンとオフを切り替えます。

  • Google の検索結果フィルタについて詳しくは、自動フィルタリングをご覧ください。ホストのクラウディング フィルタリングはマルチサイト検索にのみ適用されます。

  • デフォルトでは、検索結果の品質向上を目的に、すべての検索結果に対してフィルタリングが適用されます。

有効な値は次のとおりです。

  • 0: 重複コンテンツ フィルタをオフにします。

  • 1: 重複コンテンツ フィルタを有効にします。

gl

string

エンドユーザーの位置情報

  • gl パラメータ値は 2 文字の国コードです。gl パラメータは、オリジンの国がパラメータ値と一致する検索結果をブーストします。有効な値の一覧については、国コードのページをご覧ください。

  • gl パラメータ値を指定すると、より関連性の高い結果が得られます。これは特に、米国以外の国にお住まいのお客様のほか、より英語を話す米国以外の国にお住まいのお客様にも当てはまります。

googlehost

string

この権限のサポートは終了しており、同様の効果を得るには、gl パラメータを使用します。

検索に使用するローカル Google ドメイン(google.com、google.de、google.fr など)。

highRange

string

検索範囲の終了値を指定します。

  • lowRangehighRange を使用して、lowRange...highRange を含む包括的な検索範囲をクエリに追加します。
hl

string

ユーザー インターフェースの言語を設定します。

hq

string

指定したクエリ語句を AND 論理演算子で結合しているかのように追加します。

imgColorType

enum (ImgColorType)

モノクロ画像、グレースケール画像、透明画像、カラー画像を返します。有効な値は次のとおりです。

  • "color"

  • "gray"

  • "mono": 白黒

  • "trans": 背景を透明

imgDominantColor

enum (ImgDominantColor)

特定のドミナント カラーの画像を返します。有効な値は次のとおりです。

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

指定されたサイズの画像を返します。有効な値は次のとおりです。

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

特定の型の画像を返します。有効な値は次のとおりです。

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

検索範囲の開始値を指定します。lowRangehighRange を使用して、lowRange...highRange を含む包括的な検索範囲をクエリに追加します。

lr

string

検索対象を特定の言語(lr=lang_ja)。

有効な値は次のとおりです。

  • "lang_ar": アラビア語

  • "lang_bg": ブルガリア語

  • "lang_ca": カタロニア語

  • "lang_cs": チェコ語

  • "lang_da": デンマーク語

  • "lang_de": ドイツ語

  • "lang_el": ギリシャ語

  • "lang_en": 英語

  • "lang_es": スペイン語

  • "lang_et": エストニア語

  • "lang_fi": フィンランド語

  • "lang_fr": フランス語

  • "lang_hr": クロアチア語

  • "lang_hu": ハンガリー語

  • "lang_id": インドネシア語

  • "lang_is": アイスランド語

  • "lang_it": イタリア語

  • "lang_iw": ヘブライ語

  • "lang_ja": 日本語

  • "lang_ko": 韓国語

  • "lang_lt": リトアニア語

  • "lang_lv": ラトビア語

  • "lang_nl": オランダ語

  • "lang_no": ノルウェー語

  • "lang_pl": ポーランド語

  • "lang_pt": ポルトガル語

  • "lang_ro": ルーマニア語

  • "lang_ru": ロシア語

  • "lang_sk": スロバキア語

  • "lang_sl": スロベニア語

  • "lang_sr": セルビア語

  • "lang_sv": スウェーデン語

  • "lang_tr": トルコ語

  • "lang_zh-CN": 中国語(簡体)

  • "lang_zh-TW": 中国語(繁体)

num

integer

返される検索結果の数。

  • 有効な値は 1 ~ 10 の整数です。
orTerms

string

ドキュメントで確認する追加の検索キーワードを指定します。検索結果の各ドキュメントには、少なくとも 1 つの追加の検索キーワードが含まれている必要があります。

q

string

クエリ

relatedSite

string

検索結果がすべて、指定した URL に関連するページであることを指定します。

rights

string

ライセンスに基づくフィルタ。サポートされている値: cc_publicdomaincc_attributecc_sharealikecc_noncommercialcc_nonderived、およびこれらの組み合わせ。一般的な組み合わせをご覧ください。

safe

enum (Safe)

検索の安全性レベル。有効な値は次のとおりです。

  • "active": セーフサーチ フィルタリングを有効にします。

  • "off": セーフサーチ フィルタリングを無効にします。(デフォルト)

searchType

enum (SearchType)

検索タイプ image を指定します。指定しない場合、結果はウェブページに限定されます。

有効な値は次のとおりです。

  • "image": カスタム画像検索。
siteSearchFilter

enum (SiteSearchFilter)

siteSearch パラメータで指定したサイトの検索結果を含めるか除外するかを指定します。

有効な値は次のとおりです。

  • "e": 除外

  • "i": 一致

sort

string

結果に適用する並べ替え式。並べ替えパラメータでは、結果を指定した式(日付順)で並べ替えることができます。例: sort=date

start

integer (uint32 format)

最初に返される結果のインデックス。1 ページあたりのデフォルトの結果は 10 件なので、&start=11 は検索結果の 2 ページ目の先頭に表示されます。: JSON API の 100 を超える結果は、クエリに一致するドキュメントが 100 件も返されません。したがって、start + num の合計を 100 より大きい値に設定すると、エラーが発生します。また、num の最大値は 10 です。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Search のインスタンスが含まれます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cse

詳しくは、OAuth 2.0 の概要をご覧ください。