Method: cse.list

実行された検索に関するメタデータ、検索に使用されたエンジンに関するメタデータ、検索結果を返します。

HTTP リクエスト

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

この 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

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

  • lowRange と highRange を使用して、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

検索範囲の開始値を指定します。lowRange と highRange を使用して、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
(deprecated)

string

廃止されました。
rights

string

ライセンスに基づくフィルタ。サポートされている値: cc_publicdomain、cc_attribute、cc_sharealike、cc_noncommercial、cc_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 の概要をご覧ください。