APIリファレンス

  色はAPIドキュメントにない非公式なものです

※引数列の数字横に「*」印がある場合は省略可能引数です。

 GSearchControl クラス

説 明
 コンストラクタ UIと検索結果を表示する機能を持った検索機能のコントローラ的役割を持つ基本クラスのインスタンスを生成します。

メソッド 説 明 引 数
addSearcher 検索対象オブジェクトを検索コントローラに追加します。 1 searcher 検索対象オブジェクト
(GSearch継承クラス)
*2 opt_options 検索コントローラオプション
(GSearcherOptions型)
cancelSearch 検索処理をキャンセルします。
clearAllResults 検索コントローラから検索結果をクリアします。
draw 検索結果を表示するHTML要素を設定します。
※要素の幅は250〜300pxくらいがちょうど良い。
1 element 描画するHTML要素
*2 opt_drawOptions 描画オプション
(GdrawOptions型)
execute 検索処理を実行します。 *1 opt_query 検索語
setLinkTarget 検索結果に埋め込まれたリンクターゲットを指定します。
(HTML:A要素のtarget属性に相当)
1 linkTarget ※GSearch定数参照
setNoResultsStringNEW   1 str  
setOnKeepCallback 検索結果に「コピー」等のラベルを表示させ、ラベルをクリックしたときに
第2引数のmethod関数を呼び出します。
1 object  
2 method
第1引数
resultオブジェクト
コールバック関数
*3 opt_keepLabel ※GSearchControl定数参照
setResultSetSize 検索結果を取得する件数を設定します。 1 switchTo ※GSearch定数参照
setSearchCompleteCallback 検索処理が完了したときに第2引数のmethod関数を呼び出します。 1 object メソッドが定義されているオブジェクト
2 method 呼び出されるメソッド
setSearchStartingCallback 検索処理が開始したときに第2引数のmethod関数を呼び出します。 1 object メソッドが定義されているオブジェクト
2 method 呼び出されるメソッド
setTimeoutInteval 既定の検索入力には「Go」画像ボタンが検索実行のトリガーとなるが、オリジナル検索用テキストボックスを利用する場合、「Go」ボタンが表示されない。
その場合、検索語を入力して(最後のキーストローク)から何秒後に検索を開始するかを設定します。
1 timeoutInterval ※GSearchControl定数参照
静的メソッド 説 明 引 数
inlineCurrentStyle   1 node  
*2 opt_deep  

引数名 定 数 説 明
timeouteInterval TIMEOUT_LONG 700ミリ秒後くらいに検索を開始する。
TIMEOUT_MEDIUM(*) 500ミリ秒後くらいに検索を開始する。
TIMEOUT_SHORT 350ミリ秒後くらいに検索を開始する。
opt_keeplabl KEEP_LABEL_COPY(*) 検索結果ごとに「コピー」ラベルを表示します。
KEEP_LABEL_BLANK 検索結果ごとに「_ (ブランク)」ラベルを表示します。
KEEP_LABEL_INCLUDE 検索結果ごとに「メッセージに追加」ラベルを表示します。
KEEP_LABEL_KEEP 検索結果ごとに「保持」ラベルを表示します。
KEEP_LABEL_SAVE 検索結果ごとに「保存」ラベルを表示します。
任意の文字 検索結果ごとに任意の文字を表示します。
expandMode EXPAND_MODE_CLOSED 縦型表示の場合にのみ、検索結果詳細表示部を閉じた状態で表示
EXPAND_MODE_OPEN 縦型表示の場合にのみ、検索結果詳細表示部を開いた状態で表示
EXPAND_MODE_PARTIAL(*) 縦型表示の場合にのみ、検索結果詳細表示部に最初の1件だけ開いた状態で表示
drawMode DRAW_MODE_LINEAR(*) 複数の検索対象オブジェクトを縦型に表示します。
DRAW_MODE_TABBED 複数の検索対象オブジェクトをタブ型で表示します。


 GSearchForm クラス

説 明 引数
 コンストラクタ 検索入力テキスト、検索ボタン、クリアボタンを持った軽量な検索機能コントローラをGSearchControlオブジェクトの管理下でなくスタンドアロンで使用できるインスタンスを生成します。 1 enableClear クリアボタンを表示するかどうか
2 element コントローラを表示するHTML DOM

メソッド 説 明 引 数
execute 検索処理を実行します。 *1 opt_string 検索語
setOnClearCallback 検索用フォームでクリア(Clear)されたときにobjectのmethod関数を呼び出します。 1 object メソッドが定義されているオブジェクト
2 method 呼び出されるメソッド
setOnSubmitCallback 検索用フォームが送信(Submit)されたときにobjectのmethod関数を呼び出します。 1 object メソッドが定義されているオブジェクト
2 method 呼び出されるメソッド

プロパティ 説 明
input フォームの検索用テキスト入力要素を取得・設定します。
userDefinedCell  


 GSearch クラス

説 明
 コンストラクタ (Googleを含む)特定の検索サービスから検索して結果を取得する機能を持った基底クラスです。
以下のGwebSearch、GlocalSearch、GvideoSearch、GblogSearch クラスはこのクラスを継承しており
通常このクラスを単独でインスタンスを生成して利用することはありません。

メソッド 説 明 引 数 戻り値
clearResults 検索結果をクリアします。
createResultHtml   1 result
execute 検索処理を実行します。 1 query 検索語
getAttribution   HTML DOM
getResultSetSize 設定されている結果セットサイズを取得します。 indicatior
setLinkTarget 検索結果に埋め込まれたリンクターゲットを指定します。
(HTML:A要素のtarget属性に相当)
1 linkTarget ※GSearch定数参照
setNoHtmlGeneration  
setQueryAddition 検索結果に表示する条件を付加します。

例)Web検索で
「"filetype:pdf"」と指定すると、リンク先がPDFファイルの結果のみ表示されます。
1 term 追加条件
setResultSetSize 取得する結果セットサイズを設定します。 1 indicator ※GSearchControl定数参照
setSearchCompleteCallback 検索処理が完了したときに第2引数のmethod関数を呼び出します。 1 object  
2 method  
*3 opt_arguments methodの引数
setUserDifinedLabel 検索結果セクションのヘッダ部のラベルをユーザ定義文字で設定します。 1 label ラベル文字
setUserDifinedClassSuffix 検索結果セクションのヘッダ部に設定するCSSクラスの接尾辞を設定します。
このヘッダラベルには「gsc-resultsRoot-classSuffix」CSSクラスでアクセスできます。
1 classSuffix CSSクラス接尾辞
静的メソッド 説 明 引 数 戻り値
getBranding   *1 opt_element    
*2 opt_orientation ※GSearch定数参照  
scaleImage   1 width    
2 height    
3 imageScaler    
4 opt_img    
setOnLoadCallback   1 handler

プロパティ 説 明
results 検索結果の格納された読み取り専用の配列オブジェクトです。
検索対象オブジェクトごとに下記の Result オブジェクトを内包しています。

引数名 定 数 説 明
switchTo
indicator
LARGE_RESULTSET 取得する検索結果を8件に設定します。
SMALL_RESULTSET(*) 取得する検索結果を4件に設定します。
linkTarget LINK_TARGET_BLANK(*) 新しいウィンドウに表示
LINK_TARGET_SELF 現在のウィンドウ又はフレームに表示
LINK_TARGET_TOP フレーム分割されていてもブラウザ全体に表示
LINK_TARGET_PARENT 現在のページの親フレームに表示
任意のフレーム又はウィンドウ 指定されたフレームあるいはウィンドウに表示
opt_orientation HORIZONTAL_BRANDING  
VERTICAL_BRANDING  
orderBy ORDER_BY_RELEVANCE  
ORDER_BY_DATE ブログの公開日付順に表示します。


 GwebSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google Web 検索サービス用のインターフェースクラスです。
検索が完了すると、GwebResult オブジェクトを提供してくれます。

メソッド 説 明 引 数
setSiteRestriction 指定されたサイト内からのみ検索結果を取得できるように設定します。 1 site 検索対象サイトアドレス
*2 opt_refinement  
*3 opt_moreResultsTemplate  


 GlocalSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google ローカル 検索サービス用のインターフェースクラスです。
検索が完了すると、GlocalResult オブジェクトを提供してくれます。

メソッド 説 明 引 数
setAddressLookupMode 地域を限定した住所検索機能をON/OFFします。 1 mode ※GlocalSearch定数参照
setCenterPoint ローカル検索のセンターポイントを設定します。
ここで指定した位置を中心に検索結果を取得します。
文字を指定した場合、その文字からローカル検索が行われその結果位置情報を中心に
本来のローカル検索が行われます。
1 location 文字列
or
GPoint型

引数名 定 数 説 明
mode ADDRESS_LOOKUP_DISABLED  
ADDRESS_LOOKUP_ENABLED(*)  


 GvideoSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google 動画 検索サービス用のインターフェースクラスです。
検索が完了すると、GvideoResult オブジェクトを提供してくれます。


メソッド 説 明 引 数
setResultOrder   1 orderBy ※GSearch定数参照


 GblogSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google ブログ 検索サービス用のインターフェースクラスです。
検索が完了すると、GblogResult オブジェクトを提供してくれます。

メソッド 説 明 引 数
setSiteRestriction 指定されたサイト内からのみ検索結果を取得できるように設定します。 1 site 検索対象サイトアドレス
setResultOrder 検索結果のソートソート順を設定します。 1 orderBy ※GSearch定数参照


 GnewsSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google ニュース 検索サービス用のインターフェースクラスです。
検索が完了すると、GnewsResult オブジェクトを提供してくれます。

メソッド 説 明 引 数
setSiteRestriction 指定されたサイト内からのみ検索結果を取得できるように設定します。 1 site 検索対象サイトアドレス
setResultOrder 検索結果のソートソート順を設定します。 1 orderBy ※GSearch定数参照


 GbookSearch クラス

説 明
 コンストラクタ GSearch クラスを継承した Google ブック 検索サービス用のインターフェースクラスです。
検索が完了すると、GbookResult オブジェクトを提供してくれます。

メソッド 説 明 引 数
setSiteRestrictionNEW   1 type  
2 opt_value  


 GimageSearch クラスNEW

説 明
 コンストラクタ GSearch クラスを継承した Google イメージ 検索サービス用のインターフェースクラスです。
検索が完了すると、GimageResult オブジェクトを提供してくれます。



 Result オブジェクト

説 明
  GwebSearch、GlocalSearch、GvideoSearch、GblogSearch クラスにより検索が実行されるとそれぞれが検索結果を返します。
しかしそれぞれの検索サービスの結果から得られる情報は異なり、下記の GsearchResultClass の値により判別することができます。

汎用プロパティ 説 明
GsearchResultClass 各Resultオブジェクト共通のプロパティで、検索結果のタイプを取得します。
この値により、実際のResultオブジェクトが、GwebResult、GlocalResult、GvideoResult、GblogResult、GnewsResult、GbookResult の
どのオブジェクトなのかを判断することができます。

GwebSearch.RESULT_CLASS    ⇒ GwebResult
GlocalSearch.RESULT_CLASS  ⇒ GlocalResult
GvideoSearch.RESULT_CLASS ⇒ GvideoResult
GblogSearch.RESULT_CLASS   ⇒ GblogResult
GnewsSearch.RESULT_CLASS   ⇒ GnewsResult
GbookSearch.RESULT_CLASS   ⇒ GbookResult
GimageSearch.RESULT_CLASS   ⇒ GimageResult
html 検索結果を配列オブジェクトとしてではなく、HTML DOMオブジェクトで取得します。
GwebResult プロパティ … 「GsearchResultClass=GwebSearch.Result_CLASS」のときに取得可能
cacheUrl WebのページキャッシュURL(最新でないかもしれないURL)
content Webの関連ページからの抜粋コンテンツ
title Webのタイトル
titleNoFormatting (HTML要素が取り除かれた)Webのタイトル
unescapedUrl WebのURL
url WebのURL
visibleUrl WebのURL
GlocalResult プロパティ … 「GsearchResultClass=GlocalSearch.Result_CLASS」のときに取得可能
city ローカルの都市
country ローカルの地方
ddUrl  
ddUrlFromHere  
ddUrlToHere  
lat ローカルの緯度
lng ローカルの経度
phoneNumbers ローカルの電話番号配列
typeとnumberプロパティを持ち、typeプロパティには「main」「fax」「mobile」などが設定されている。
region ローカルの地域
streetAddress ローカルの住所
title ローカルのタイトル
titleNoFormatting (HTML要素が取り除かれた)ローカルのタイトル
url Google Maps 詳細ページへ関連付けされたローカルのURL
GvideoResult プロパティ … 「GsearchResultClass=GvideoSearch.Result_CLASS」のときに取得可能
content 動画の断片
duration 動画の時間
playUrl  
published 動画の公開日(RFC-822 フォーマット)
publisher 動画の公開者
tbHeight 動画のサムネイルのピクセル高さ
tbWidth 動画のサムネイルのピクセル幅
tbUrl 動画のサムネイル画像のURL
title 動画のタイトル
titleNoFormatting (HTML要素が取り除かれた)動画のタイトル
url 動画のURL
GblogResult プロパティ … 「GsearchResultClass=GblogSearch.Result_CLASS」のときに取得可能
author ブログの著者
blogUrl ブログのURL
content ブログのコンテンツの概要
postUrl ブログの投稿ページへのURL
publishedDate ブログの公開日(RFC-822 フォーマット)
title ブログのタイトル
titleNoFormatting (HTML要素が取り除かれた)ブログのタイトル
GnewsResult プロパティ … 「GsearchResultClass=GnewsSearch.Result_CLASS」のときに取得可能
clusterUrl  
content ニュースのコンテンツの概要
location  
publishedDate ニュースの公開日(RFC-822 フォーマット)
publisher ニュースの提供者
relatedStories  
title ニュースのタイトル
titleNoFormatting (HTML要素が取り除かれた)ニュースのタイトル
unescapedUrl エスケープされていない生のニュースのURL
url エスケープされたニュースのURL
GbookResult プロパティ … 「GsearchResultClass=GbookSearch.Result_CLASS」のときに取得可能
authors 本の著者
bookId 本のISBNコード
pageCount 本のページ数
publishedYear 本の出版年
thumbnailHtml ブックカバーのサムネイル画像のHTML要素
title 本のタイトル
titleNoFormatting (HTML要素が取り除かれた)本のタイトル
url エスケープされた本のURL
unescapedUrl エスケープされていない生の本のURL
GimageResult プロパティ … 「GsearchResultClass=GimageSearch.Result_CLASS」のときに取得可能
content  
contentNoFormatting  
height イメージのピクセル高さ
originalContextUrl  
tbHeight サムネイルイメージのピクセル高さ
tbWidth サムネイルイメージのピクセル幅
tbUrl サムネイルイメージのURL
title イメージのタイトル、あるいはファイル名
titleNoFormatting  
unescapedUrl エスケープされていない生のイメージのURL
url エスケープされたイメージのURL
width イメージのピクセル幅
visibleUrl  


 GsearcherOptions クラス

説 明
 コンストラクタ GSearch クラスを継承した 検索対象オブジェクトクラスに対するオプションを設定するクラスです。

メソッド 説 明 引 数
setExpandMode 検索結果表示後の表示部の拡張モードを設定します。 1 expandMode ※GSearchControl定数参照
setImageResultsTbHeightNEW   1 height  
setNoResultsStringNEW   1 str  
setRoot 検索結果を既定外の場所に表示したい場合にそのHTML要素を設定します。 1 element 表示するHTML要素
setVideoResultsTbHeight 動画検索の結果に表示されるサムネイル画像の高さを設定します。 1 height ピクセル単位の高さ


 GdrawOptions クラス

説 明
 コンストラクタ 検索コントローラの描画モードに対するオプション設定用クラスです。

メソッド 説 明 引 数
setDrawMode 検索結果の描画モードを設定します。 1 drawMode ※GSearchControl定数参照
setInput オリジナルの検索用テキストボックスを使用したい場合にそのHTML要素を設定します。 1 inputElement 入力テキスト要素
setSearchFormatRoot 既定の検索フォームを表示するHTML要素を設定します。 1 element HTML要素