実行された検索に関するメタデータ、検索に使用されたエンジンに関するメタデータ、検索結果を返します。
HTTP リクエスト
GET https://customsearch.googleapis.com/customsearch/v1
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
c2coff |
中国語(簡体字、繁体字)の検索を有効または無効にします。 このパラメータのデフォルト値は 0(ゼロ)であり、機能が有効になっていることを意味します。サポートされている値は次のとおりです。
|
cr |
検索結果を、特定の国で作成されたドキュメントに限定します。cr パラメータの値にはブール演算子を使用できます。 Google 検索では、以下の情報を基にドキュメントの国を判定します。
このパラメータに有効な値の一覧については、国パラメータ値のページをご覧ください。 |
cx |
このリクエストで使用するプログラム可能検索エンジンの ID。 |
dateRestrict |
日付に基づいて、検索結果を URL に制限します。次の値がサポートされています。
|
exactTerms |
検索結果内のすべてのドキュメントに含まれるフレーズを識別します。 |
excludeTerms |
検索結果のどのドキュメントにも表示すべきではない単語またはフレーズを識別します。 |
fileType |
結果を指定した拡張子のファイルに制限します。Google でインデックス登録可能なファイル形式の一覧については、Search Console ヘルプセンターをご覧ください。 |
filter |
重複コンテンツ フィルタのオンとオフを制御します。
有効な値は次のとおりです。
|
gl |
エンドユーザーの位置情報。
|
googlehost |
この権限のサポートは終了しており、同様の効果を得るには、 検索に使用するローカルの Google ドメイン(google.com、google.de、google.fr など)。 |
highRange |
検索範囲の終了値を指定します。
|
hl |
ユーザー インターフェースの言語を設定します。
|
hq |
指定したクエリ語句を、論理 AND 演算子で結合されているかのようにクエリに追加します。 |
imgColorType |
モノクロ画像、グレースケール画像、透明画像、カラー画像を返します。有効な値は次のとおりです。
|
imgDominantColor |
特定のドミナント カラーの画像を返します。有効な値は次のとおりです。
|
imgSize |
指定されたサイズの画像を返します。有効な値は次のとおりです。
|
imgType |
型の画像を返します。有効な値は次のとおりです。
|
linkSite |
すべての検索結果に特定の URL へのリンクを含めるよう指定します。 |
lowRange |
検索範囲の開始値を指定します。 |
lr |
検索対象を特定の言語(例: 有効な値は次のとおりです。
|
num |
返される検索結果の数。
|
orTerms |
ドキュメント内をチェックする追加の検索キーワードを指定します。検索結果の各ドキュメントには、追加の検索キーワードが 1 つ以上含まれている必要があります。 |
q |
クエリ |
relatedSite |
廃止されました。 |
rights |
ライセンスに基づくフィルタ。サポートされている値: |
safe |
安全性レベルを検索します。有効な値は次のとおりです。
|
searchType |
検索タイプ 有効な値は次のとおりです。
|
siteSearch |
常に結果に含める、または結果から除外するサイトを指定します(下記の |
siteSearchFilter |
有効な値は次のとおりです。
|
sort |
結果に適用する並べ替え式です。ソート パラメータでは、指定した式に従って結果を並べ替える(日付順で並べ替え)ことを指定します。例: sort=date。 |
start |
最初に返される結果のインデックス。1 ページあたりのデフォルトの結果数は 10 件であるため、 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功した場合、レスポンスの本文には Search
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cse
詳細については、OAuth 2.0 の概要をご覧ください。