GSearchControl()google.search.SearchControl()

新しい検索コントロール オブジェクトを作成します。検索コントロール オブジェクトはサーチャー、つまり GSearchgoogle.search.Search インターフェースを実装するオブジェクトのコンテナです。検索コントロール オブジェクトは、1 つ以上の子サーチャーを持つまで動作しません。検索コントロールは .draw() メソッドを使う HTML コンテナにバインドされています。検索コントロールの draw() メソッドが呼び出されている場合、サーチャー オブジェクトが検索コントロールに追加されない可能性があることに注意してください。

想定される動作順は次のとおりです:

• sc = new GSearchControl()google.search.SearchControl();
• sc.addSearcher();
• sc.draw();

これらの手順が発生すると、検索コントロールはアクティブになり、検索をいつでも実行開始できます。

.addSearcher(searcher, opt_options?)

このメソッドは、検索コントロールにサーチャー オブジェクトを追加します。追加されると、検索コントロールがそのサーチャーのアクティビティを調整します。検索実行の調整、関連検索完了イベントの処理、結果のレンダリング先の提供、検索結果を保持またはクリッピングするための UI の提供を行います。

メソッドは、各種のサーチャー固有のオプションを指定するために使われる GsearcherOptionsgoogle.search.SearchOptions オブジェクト (省略可能) を受け入れます。

• searcher - サーチャー オブジェクトを指定します。
• opt_options - 指定した場合、このサーチャーのための設定オプションとなります。
• 戻り値 - n/a

.setTimeoutInterval(timeoutInterval)

アプリケーション側で入力コントロールを用意し、それを使うように検索コントロールに依頼する場合、検索コントロールは、入力タイマーを使って、いつ検索を実行するかを決定します。ユーザーが検索コントロールのテキスト入力領域に入力するたびに、カウントダウン タイマーが初期化されます。タイマーが実行されると、検索がリクエストされます。最後のキーストロークから検索開始までの間隔は、この API を使ってプログラムされます。注: コントロールのデフォルト値は GSearchControlgoogle.search.SearchControl.TIMEOUT_MEDIUM (約 500ms) です。

• timeoutInterval - timeoutInterval の値、つまり最後のキーストロークから、それによる検索の実行までの間隔を指定します。有効な値は次のとおりです:
  • GSearchControlgoogle.search.SearchControl.TIMEOUT_SHORT - 非常に短いディレイ (350ms 以下) を指定するために使われます。
  • GSearchControlgoogle.search.SearchControl.TIMEOUT_MEDIUM - 中程度のディレイ (500ms 以下) を指定するために使われます。
  • GSearchControlgoogle.search.SearchControl.TIMEOUT_LONG - 長いディレイ (700ms 以下) を指定するために使われます。
• 戻り値 - n/a

.setOnKeepCallback(object, method, opt_keepLabel?)

このメソッドは、検索コントロールによって管理されている検索結果のいずれかを、ユーザーがコピーのために選択したときに通知されることを呼び出し側が望んでいる、ということを検索コントロールに知らせるために使われます。このメソッドが呼び出されない場合、ユーザーには検索結果をコピーする機会が与えられません。メソッドが呼び出されると、各検索結果の下に、テキスト リンクの注釈が付けられます。このリンクをクリックすると、指定されたオブジェクト上で、検索結果に関連付けられた GResultgoogle.search.Result オブジェクトを経由して、指定されたメソッドが呼び出されます。このメソッドを使うと、呼び出し側では、組み込みシステムによって定義されたラベル値を指定して、ユーザーに結果をコピーするよう促すことができます。また、呼び出し側アプリケーションにとってより有効な情報となるラベルを指定することもできます。システム定義ラベルを使う場合、値は、残りのコントロールが実行されるときに使われる言語に自動的に翻訳されます。

• object - 指定されたメソッドが呼び出されるコンテキストを定義するアプリケーション レベルのオブジェクトを指定します。
• method - 呼び出すメソッドを指定します。たとえば、このメソッドが .setOnKeepCallback(foo, MyObject.prototype.myKeephandler) として呼び出される場合、ユーザーが keep ラベルをクリックすると foo.myKeephandler() の呼び出しが行われます。
• opt_keepLabel - 各検索結果の下にあるオプションのテキスト ラベルを指定します。このラベルがクリックされると、指定されたオブジェクト/メソッドへのコールバックがトリガーされます。有効な値は次のとおりです:
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_SAVE - save のラベル値
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_KEEP - keep のラベル値
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_INCLUDE - include のラベル値
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_COPY - copy のラベル値 (デフォルト)
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_BLANK - 空欄のラベル値が使われます。グラフィック (CSS を経由して選択可能) をコピーしたいだけのときに便利です。
  • 他の任意の値 - 渡された値がラベルになります。呼び出し側がローカリゼーションを担当します。
• 戻り値 - n/a

.cancelSearch()

このメソッドは、検索結果完了の受信を無視するよう検索コントロールに指示するのに使われます。このメソッドによって使われる内部状態は、新しい検索がリクエストされるたびに検索できるように、リセットされます。このメソッドの想定される使用法は、検索語句がゆっくり入力された場合に、意図と異なる語句による検索が行われ、それに伴って発生することがある UI の点滅への対応を支援することです。入力が検出されるたびにこのメソッドを使うことによって、入力の一部に基づく前回の検索を容易に無視することができます。

• 戻り値 - n/a

.setLinkTarget(linkTarget)

このメソッドは、検索結果に埋め込まれたリンクで使われるリンク ターゲットを設定するために呼び出されます。デフォルト値は GSearchgoogle.search.Search.LINK_TARGET_BLANK で、リンク先のページが新しいブラウザ ウィンドウに表示されることを示します。このメソッドが呼び出されると、検索コントロールを範囲とするリンクのターゲット設定が確立されます。これは、検索コントロールに現在アタッチされているすべてのサーチャーと、それ以降にコントロールに追加されたすべてのサーチャーに影響します。

• linkTarget - リンク先のページを表示するターゲット フレームを指定します。有効な値は次のとおりです:
  • GSearchgoogle.search.Search.LINK_TARGET_BLANK - リンク先のページを新しいウィンドウに表示します。例: <A href=... target=_blank ...>
  • GSearchgoogle.search.Search.LINK_TARGET_SELF - リンク先のページを同じウィンドウおよびフレームに表示します。例: <A href=... target=_self ...>
  • GSearchgoogle.search.Search.LINK_TARGET_TOP - リンク先のページを一番上のフレームに表示します。例: <A href=... target=_top ...>
  • GSearchgoogle.search.Search.LINK_TARGET_PARENT - リンク先のページを一番上のフレームに表示するか、現在のフレームを置き換えます。例: <A href=... target=_parent ...>
  • その他 - リンク先のページを指定されたフレームまたはウィンドウで表示します。例: <A href=... target=anything-else ...>
• 戻り値 - n/a

.setSearchStartingCallback(object, method)

このメソッドは、検索が開始される直前に通知されることを呼び出し側が望んでいるということを検索コントロールに知らせるために使われます。この呼び出しの粒度は、検索コントロール レベルではなく、サーチャー レベルですので注意してください。つまり、検索コントロールに 5 つのサーチャーがあるときに検索を実行すると、各サーチャーが検索開始を指示されるたびにこのメソッドが呼び出されるということです。

• object - 指定されたメソッドが呼び出されるコンテキストを定義するアプリケーション レベルのオブジェクトを指定します。
• method - 呼び出すメソッドを指定します。たとえば、このメソッドが .setSearchStartingCallback(foo, MyObject.prototype.mySearchStarting) として呼び出される場合、検索が開始されると foo.mySearchStarting(searchControl, searcher, query) の呼び出しが行われます。コールバックの最初の引数 searchControl は検索コントロールを指定します。2 番目の引数 searcher は検索を開始しようとしているサーチャーを指定します。3 番目の引数 query はクエリを指定します。
• 戻り値 - n/a

.inlineCurrentStyle(node, opt_deep?)

このユーティリティ関数は、指定された HTML ノード (または、opt_deep が指定されていればツリー) のために、現在計算されているスタイルをクローニングし、現在のスタイルをノードにインライン化するために使われます。この関数は特定の場合に便利です。主に、アプリケーション間で HTML の一部を受け渡す際に、一連の HTML スタイルを維持したいが、関連付けられたスタイルシートが受け取り側のアプリケーションにない場合に、keep ハンドラと組み合わせて使います。このシナリオの最も単純な例はメール アプリケーションです。たとえば、ユーザーは Google AJAX Search API を使って検索結果をメッセージ作成ウィンドウにクリッピングし、そのメッセージが別のユーザーに HTML として送信されます。受信者のメール アプリケーションによっては、Google AJAX Search API に対応しておらず、そのスタイルシートがないことがあります。このメソッドはそのような場合も考慮しています。発信側のメール アプリケーションが現在のスタイルシートをインライン化できるようにすることにより、意図どおりの形で受信者にメッセージが表示されるようにしています。

• node - スタイルがインライン化される HTML ノードを指定します。
• opt_deep - 指定される場合、インライン操作は現在のノードとその子孫に対してスタイルを回帰的にインライン化します。
• 戻り値 - n/a

このメソッドは、Safari ウェブ ブラウザ上では現在実装されていませんので注意してください。

GSearchFormgoogle.search.SearchForm(enableClear, element)

新しい検索フォーム オブジェクトを作成します。検索フォーム オブジェクトは、ユーザー インターフェース要素、メソッド、プロパティ、アプリケーションから GSearchgoogle.search.Search() オブジェクトのコレクションを制御するために設計されたコールバックを提供します。ユーザー インターフェースと機能は、GSearchControlgoogle.search.SearchControl()) を使って、アプリケーションが使用できるものを一致させます (実際、GSearchControlgoogle.search.SearchControl() は内部的にこのオブジェクトに基づいています。

想定される動作順は次のとおりです:

• sf = new GSearchFormgoogle.search.SearchForm(true/false, container);
• sf.setOnSubmitCallback(object, method);
• オプション - sf.setOnClearCallback(object, method);

これらの手順が発生すると、検索フォームはアクティブになり、ユーザー入力の受け取りをいつでも開始して処理できます。

メソッドは、必須の enableClear 引数と必須の element 引数を受け入れます。

• enableClear - true の場合、検索フォームはクリア ボタンを含みます。それ以外の場合、クリア ボタンは作成されません。
• element - このフォームのコンテナとなる HTML ノードを指定します。

.setOnSubmitCallback(object, method)

このメソッドは、検索フォームが送信されたときに呼び出されるオブジェクト/メソッドの組み合わせを登録します。このイベントは、ユーザーが検索ボタンをクリックするか、テキスト入力要素にフォーカスがある間にユーザーが Enter キーを押すと発生します。発生すると、指定されたオブジェクトはアクティブ オブジェクトになり、指定されたメソッドが呼び出されます。メソッドに渡される引数はこの検索フォームです。

典型的にはメソッドは以下のようになります:

App.prototype.onSubmit = function(form) {
  if (form.input.value) {
    this.localSearcher.execute(form.input.value);
  }
  return false;
}
                

上の例では、検索フォームがメソッドに渡され、メソッドは false を戻して、送信イベントを処理したことを示すことに注意してください。

• object - 指定されたメソッドが呼び出されるコンテキストを定義するアプリケーション レベルのオブジェクトを指定します。
• method - 呼び出すメソッドを指定します。メソッドはこのフォームへの参照を渡されます。false を戻す必要があります。

.execute(opt_string?)

このメソッドを使うと、アプリケーションからフォームを送信できます。これにはオプションで、フォームのテキスト入力要素の設定と、続いて .setOnSubmitCallback() を使って確立された、登録済みの送信時コールバック メソッドを呼び出す処理を含みます。

• opt_string - 存在する場合、送信時コールバック メソッドを呼び出す前に、フォームのテキスト入力要素に入力された状態になっている文字列値を指定します。
• 戻り値 - n/a

.input

このプロパティはフォームのテキスト入力要素です。アプリケーションはこのプロパティを自由自在に読み書きできます。一般的には、送信時コールバック ハンドラで使用されます。コントロールの下にあるサーチャー上で .execute() を呼び出すことによって、アプリケーションは form.input.value を読んでからこの文字列を処理します。

.userDefinedCell

検索フォームの内部構造は 1 対の HTML テーブルです。上のテーブルには、テキスト入力要素、ローカライズされた検索ボタン、およびオプションのクリア ボタンが含まれています。下のテーブルには、テーブル内の左側セルであるアプリケーション固有の自由なセルと、テキストと画像を含む Google ロゴが含まれます。このプロパティ、.userDefinedCell プロパティは、アプリケーション固有のコンテンツを持つように作成されたテーブル セルの DOM ノードです。アプリケーションはこの空間を自由に使って、検索フォームに密接な関係がある情報を、標準の Google ロゴと揃えて配置することができます。

GSearchgoogle.search.Search()

新しいサーチャー オブジェクトを作成します。注: これは基本クラスなので、アプリケーションがこのコンストラクタを直接使う可能性は高くなく、アプリケーションはその代わりにコンストラクタをサービス固有のサーチャー オブジェクト作成の副作用として使います (例: GwebSearchgoogle.search.WebSearch)。

.setResultSetSize(indicator)

このメソッドは、この特定のサーチャーによって戻される結果の数を選択するために呼び出されます。ただし、これはスカラーではありません。少数の結果と多数の結果のいずれかを示す列挙です。将来的には、このメソッドは中規模、および非常に大規模な結果セットをサポートするように拡張される可能性があります。

• indicator - 戻す検索結果の数を示す列挙を指定します。有効な値は次のとおりです:
  • GSearchgoogle.search.Search.LARGE_RESULTSET - 多数の結果をリクエストします (通常は 8 件の結果)。
  • GSearchgoogle.search.Search.SMALL_RESULTSET - 少数の結果をリクエストします (通常は 4 件の結果)。
• 戻り値 - n/a

.clearResults()

検索が正常に完了すると、サーチャー オブジェクトは、特定の検索から得られたものを記述する検索結果のコレクションを維持します。このメソッドは、サーチャーをリセットするために使われ、結果をすべてクリアします。このメソッドは、新しい検索の実行前に暗黙のうちに呼び出されます。

• 戻り値 - n/a

.setSearchCompleteCallback(object, method, opt_arguments?)

このメソッドは、検索完了時に通知するオブジェクトとメソッドを登録するために使われます。アプリケーションは、オプションで、opt_arguments を使ってコンテキスト引数を渡すことがあります。続いて引数は指定されたメソッドに渡されます。

• object - 指定されたメソッドが呼び出されるコンテキストを定義するアプリケーション レベルのオブジェクトを指定します。
• method - 呼び出すメソッドを指定します。たとえば、このメソッドが .setSearchCompleteCallback(foo, MyObject.prototype.mySearchCompleteHandler) として呼び出される場合、このサーチャーでの検索が完了すると foo.mySearchCompleteHandler(opt_arguments?) の呼び出しが行われます。
• 戻り値 - n/a

.setUserDefinedClassSuffix(classSuffix)

このメソッドは、検索結果セクションと、このサーチャーが検索コントロールで取得した検索結果コレクションの、ユーザー定義のクラス接尾辞を設定するために使われます。このメソッドを使う目的は、アプリケーションが、個別の検索結果セットの結果とヘッダーに特有のスタイルを設定できるようにすることです。このメソッドが「siteSearch」という値とともに呼び出されると想定すると、gsc-resultsRoot-siteSearch のクラスが、このサーチャーに関連するヘッダーと結果をラップする DIV 要素に適用されます。これは汎用 gsc-resultsRoot クラスへの追加であることに注意してください。

• classSuffix - gsc-resultsRoot- に付加されるユーザー定義のクラス接尾辞を指定します。このクラスは、このサーチャーに関連するヘッダーと結果をラップする DIV 要素に追加されます。
• 戻り値 - n/a

.setNoHtmlGeneration()

アプリケーションが検索コントロールを使っておらず、検索結果のプロパティの一部を使い、高度にカスタマイズされたフォーマットでそれを表示している場合があります。そのような場合は、アプリケーションで小規模な最適化を行うことができます。サーチャーは .html プロパティを生成しないようにプログラムできます。その場合、結果で有効な未加工のプロパティだけを利用できます。

• n/a - 入力引数なし
• 戻り値 - n/a

.setQueryAddition(term)

このメソッドは、サーチャーを介したすべてのクエリに不可される、省略可能な追加のクエリ語句を呼び出し側が設定 (またはクリア) することを可能にします。これを使うと通常、オリジナルの検索語句と多少異なる結果を提供できます。たとえば、GwebSearchgoogle.search.WebSearch() ベースのサーチャーが、この関数を search.setQueryAddition("filetype:pdf"); として呼び出し、「google」のクエリを実行すると「google filetpe:pdf」のクエリを実行した場合と同じ結果が得られます。この API を使う場合は、ユーザーのクエリが変更されたことを示せるように、.setUserDefinedLabel() を使うことを強くお勧めします。これは .setSiteRestriction() の使用時と同じ、一般的なアドバイスです。詳細はサンプルをご覧ください。

• term - このサーチャーを介した各クエリに付加される式を指定します (スペースを指定する必要はありません)。term の値が "" の場合、この API の効果はキャンセルされ、クエリは変更されません。
• 戻り値 - n/a

.gotoPage(page)^New!

検索が完了した後、cursor プロパティがサーチャー オプション上に表示されることがあります。これは、利用できる検索結果数の関数で、サーチャーの基礎となる機能です。cursor プロパティが存在する場合、このメソッドを使うと、別の検索結果群をフェッチできます。アプリケーションは page 引数を使うことによってどのページかを指定します。次にこの値が cursor.pages 配列をインデックス化するため、そして最終的には &start URL 引数の値を計算するために使われます。

• page - アプリケーションが求める結果のページ番号を指定します。この値は .cursor.pages プロパティに相対的にチェックされる範囲で、ページが範囲外であったり、基礎をなしているサーチャーに cursor プロパティがなかったりする場合、処理が行われません。
• 戻り値 - n/a

.scaleImage(width, height, imageScaler, opt_img)

このメソッドは、縦横比を変えずに画像の大きさをスケールするために使用される、静的ヘルパー関数です。現在の画像の縦と横の長さ、および imageScaler オブジェクト (.width および .height プロパティが含まれています) を渡すと、縦横比を保ってスケールされた imageScaler オブジェクトを関数が計算して戻します。戻されたオブジェクトの .height プロパティと .width プロパティを使って画像要素を作ることができます。

内部的には、GvideoSearchgoogle.search.VideoSearch オブジェクトが、サムネイルをスケールするために使う画像スケーラを定義します。アスペクト比 4 × 3 を維持するよう設計されており、次のように定義されています。

// imageScaling defaults 4x3 100x75 image
this.imageScaler = {width:100,height:75};
                

サムネイルの img 要素の作成時に、次のようにサムネイル画像のスケール後の縦と横の長さを計算します:

// scale the thumbnail image using the searchers .imageScaler.
// By default this is a 4x3 100x75 image,
// but its settable using .setVideoResultsTbHeight as well
var scaled = GSearchgoogle.search.Search.scaleImage(result.tbWidth,
                                result.tbHeight,  this.imageScaler);

// scaled.height and scaled.width now contain
// the values needed to proportionally scale the thumbnail
                

• width - 画像の元の横幅
• height - 画像の元の縦の長さ
• imageScaler - .height プロパティと .width プロパティで画像スケール後の縦と横の長さを指定する imageScaler オブジェクト。
• opt_img - オプションの img オブジェクトを指定します。指定されると、.height プロパティと .width プロパティがこの呼び出しによって設定されます。
• 戻り値 - .height プロパティと .width プロパティに縦横比を維持してスケールされた画像の寸法を含む imageScaler オブジェクト

.setOnLoadCallback(handler)^New!

このメソッドは、この呼び出しが含まれているドキュメントがロードされると呼び出される、指定されたハンドラ関数を登録する静的なヘルパー関数です。以前のドキュメントでは、ボディ要素の onload 属性の使用を推奨していました (たとえば <body onload="OnLoad()">)。ページと、ページによってロードされるすべてのコードを完全に制御しているときはそれでもよいのですが、この手法は、一部のランタイムで body.onload ハンドラが壊される問題の原因になることがあります。setOnLoadCallback() にはこの問題はないので、Google では、ドキュメント ロード時 (AJAX Search API が完全にロードされ、使用できる状態になったとき) にコードを呼び出すコールバックを登録する場合に、この方法をお勧めします。

• handler - これを含むドキュメントがロードされ、Search API が使用できる状態になると呼び出される必須の関数。
• 戻り値 - n/a

.results[]

このプロパティは、検索結果 1 件につき 1 つの検索結果オブジェクトの配列を含んでいます。このプロパティは検索を実行するたびにクリアされ、検索が完了するごとに配列に値が入れられます。レポートする結果がない場合、この配列の .length プロパティは 0 に設定されます。

GwebSearchgoogle.search.WebSearch()

このコンストラクタは、Google ウェブ検索サービスからの検索結果を提供するために設計されたサーチャー オブジェクトのインスタンスを作成するために使われます。

.setSiteRestriction(site, opt_refinement, opt_moreResultsTemplateNew!)

このメソッドは、このサーチャーによって戻されるウェブ検索の結果を制限するために使われます。検索結果を www.amazon.com 上のものに制限するには、単にこのメソッドを呼び出して値「www.amazon.com」を渡します。サイト制限をクリアするには、null の値を渡します。次のスニペットは、「amazon.com」へのサイト制限を設定する例を示します。より完成度の高いサンプルを、サイト制限のサンプルで参照できます。

var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction("amazon.com");
                

このメソッドを使うと、呼び出し側で検索を Google のカスタム検索エンジンに制限することができます。このメソッドに URL パスを指定する代わりに、カスタム検索エンジン ID を渡します。次のスニペットは、ID が 000455696194071821846:reviews であるカスタム検索エンジンへのサイト制限設定の例を示します。より完成度の高いサンプルを、カスタム検索エンジン サンプルで参照できます。

var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction("000455696194071821846:reviews");
                

このように使われる場合、opt_refinementを使って、省略可能なカスタム検索エンジン リファインメントを指定できます。このメカニズムを使って、検索エンジンのサブセットに対し、サイトを制限することができます。opt_refinement で指定された値は、指定された検索エンジンと関連付けられているカスタム検索エンジン リファインメント ラベルと一致する必要があります (下のコード スニペットを参照してください)。より完成度の高いサンプルを、カリキュラム検索エンジンのサンプルで参照できます。

var cseId = "017576662512468239146:omuauf_lfve";
var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction(cseId, "Lectures");
                

カスタム検索エンジンには、カスタマイズされた検索結果の表示ページが含まれることがあります。これをサポートするために、カスタム検索エンジン サイト制限が設定されている場合、オプションの opt_moreResultsTemplate 値が指定されることがあります。これは、[その他の結果] リンクを検索結果セットの一番下に生成するために使われる URL テンプレートを指定します。URL テンプレートは、プレースホルダ__QUERY__」および「__HL__」を含む必要があります。[その他の結果] リンクを生成するとき、システムはこれらのプレースホルダを現在のクエリ語句と UI 言語に置き換えます。このサンプルは、メインおよび左側のタブにおけるこのメカニズムの使用法を示しています: カリキュラム検索のサンプル。

カスタム検索エンジンの最新の拡張が、リンク済みカスタム検索エンジンです。これをサポートするために、サイト制限を指定する新しい匿名オブジェクト モードに加えて、上に示したオプションとモードのすべてをサポートするように、site 引数が拡張されました。site 引数がオブジェクトの場合、次のプロパティのいずれかが存在することがあります (優先順位順。つまり、複数のプロパティを指定した場合、下のリストで先に記載されているプロパティが優先されます):

• siteUrl - 検索は指定された URL に相対的です。
• cseId - 検索は、指定された次のようなカスタム検索エンジン ID に相対的です: 000455696194071821846:reviews
• crefUrl - 検索は、指定された URL によって参照されるリンク済みカスタム検索エンジンに想定的です。詳細は、このサンプルを参照してください。

cseId または crefUrl が指定される場合、opt_refinement を使って、省略可能なカスタム検索エンジン リファインメントを指定できます。このメカニズムを使って、検索エンジンのサブセットに対し、サイトを制限することができます。opt_refinement で指定された値は、指定された検索エンジンと関連付けられているカスタム検索エンジン リファインメント ラベルと一致する必要があります (下のコード スニペットを参照してください)。

searcher = new GwebSearch();
searcher.setSiteRestriction(
  {
    crefUrl : "http://www.google.com/cse/samples/vegetarian.xml"
  },
  "recipes");
                

• site - 部分的な URL (たとえば「www.amazon.com」、「google.com」)、またはカスタム検索エンジン ID (たとえば "000455696194071821846:reviews"、"000455696194071821846:shopping") などの形式でサイト制限設定を指定します。他の方法として、上で説明したように、匿名のオブジェクトを含めることができます。
• opt_refinement - site がカスタム検索エンジンを参照するとき、この省略可能な引数の値はカスタム検索エンジン リファインメントを指定します。
• opt_moreResultsTemplate - site がカスタム検索エンジンを参照するとき、この省略可能な引数の値は、検索コントロールで検索結果セットの下に表示される [その他の結果] リンクを作成するために使われる URL テンプレートを指定します。URL テンプレートは、プレースホルダ「__QUERY__」および「__HL__」を含む必要があります。[その他の結果] リンクを生成するとき、システムはこれらのプレースホルダを現在のクエリ語句と UI 言語に置き換えます。
• 戻り値 - n/a

GlocalSearchgoogle.search.LocalSearch()

このコンストラクタは、Google ローカル検索サービスからの検索結果を提供するために設計されたサーチャー オブジェクトのインスタンスを作成するために使われます。

.setCenterPoint(location)

このメソッドは、検索結果のスコープを設定するために使われる中心点を決定します。1 つのバリアントを受け入れます。これには文字列、GMap2google.maps.Map2、または GLatLnggoogle.maps.LatLng を指定できます。文字列の場合、文字列を GLatLnggoogle.maps.LatLng に解決しようとします。

• location - ローカル検索にスコープを設定するために使われる中心点を指定します。この引数はバリアントで、次を指定できます:
  • GMap2google.maps.Map2 プロパティがあることによって認識される getCenter()。この場合、指定されたマップの中心点がキャプチャされ、検索結果をスコープするために使われます。
  • x プロパティがあることによって認識される GLatLnggoogle.maps.LatLng。この場合、この点の値がキャプチャされ、ローカル検索のスコープを設定するための中心点として使用されます。
  • 名前によって住所を指定する string。この引数がある場合、検索式の一部として location の近くを指定し、ユーザーが Google ローカル検索を実行したかのように検索のスコープが設定されます。注: 文字列 location は非同期で GLatLnggoogle.maps.LatLng に解決されるため、このメソッドを使った場合、ジオコーディング処理が正常に完了すると、検索はこの場所に相対的に行われます。
• 戻り値 - n/a

.resizeStaticMapUrl(result, height, width, opt_zoom?)^New!

このユーティリティ関数は、指定された結果の staticMapUrl プロパティに関連付けられた画像のサイズを変更するようにできています。このプロパティは、完了時に、サイズを変更された静的なマップ画像を表す新しい値に置き換えられます。省略可能なズーム パラメータを渡して、サイズとズーム レベルの両方をこのメソッドで操作することができます。静的なマップ画像のデフォルト サイズは、中程度のズーム レベル GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_DEFAULT で 150 × 100 ピクセルです。静的マップ タイルのサンプルはこのメソッドを使う方法の 1 つを示しています (次のスニペットを参照してください)。

var img = document.createElement("img");
GlocalSearch.resizeStaticMapUrl(result, 80, 120);
img.src = result.staticMapUrl;
img.title = result.titleNoFormatting;
                

• result - サイズ変更される静的なマップ画像を持つ結果オブジェクトを指定します。完了時に、この結果オブジェクトの staticMapUrl プロパティが変更されます。
• height - 新しい画像の縦の長さを指定します (単位はピクセル)。デフォルトの縦の長さは 100 ピクセルです。
• width - 新しい画像の横の長さを指定します (単位はピクセル)。デフォルトの横の長さは 150 ピクセルです。
• opt_zoom - マップのズーム レベルを指定します (省略可能)。ズーム レベルが指定されない場合、値は変更されず、デフォルト値の GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_DEFAULT のままです。有効な値は GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_CLOSEST から GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_FARTHEST までです。
• 戻り値 - staticMapUrl の新しい値が戻されます。

.computeStaticMapUrl(results, height, width, opt_zoom?)^New!

このユーティリティ関数は、呼び出し側が指定した点のコレクションから静的なマップ画像を作成するようにできています。点は、検索結果オブジェクトのコレクション、数値の .lat と .lng プロパティを含むオブジェクトのコレクション、または GLatLnggoogle.maps.LatLng オブジェクトのコレクションのいずれかの形式です。最初の GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_MAX_POINTS オブジェクトのみが、インクルードするかどうかを検討されます。静的マップ タイルのサンプルはこのメソッドを使う方法の 1 つを示しています。このサンプルでは、北ヨーロッパの場所のコレクションから静的なマップが作成されます。検索結果がないときは、このデフォルト マップが表示されます。検索が完了すると、検索結果のコレクションを使って新しいマップ画像が計算されます。

// demonstrate computeStaticMapUrl with simple point array
this.worldPointsUrl = GlocalSearch.computeStaticMapUrl(
                        worldPoints,350, 400);
document.getElementById("resultsImg").src =
                        this.worldPointsUrl;
...
var worldPoints = [
  { lat : 48.8565, lng : 2.3509 },      // paris
  { lat : 52.5238, lng : 13.4119},      // berlin
  { lat : 52.3738, lng : 4.8909},       // amsterdam
  { lat : 55.676294, lng : 12.568115},  // copenhagen
  { lat : 60.160791, lng : 24.952548},  // helsinki
  { lat : 59.332725, lng : 18.064454},  // stockholm
  { lat : 59.913820, lng : 10.738741}   // oslo
];
                

• results - 静的なマップ画像にプロットされるオブジェクトの配列を指定します。
• height - 新しい画像の縦の長さを指定します (単位はピクセル)。
• width - 新しい画像の横の長さを指定します (単位はピクセル)。
• opt_zoom - マップのズーム レベルを指定します (省略可能)。ズーム レベルが指定されない場合、システムは適切なズーム レベルを計算します。指定された場合、有効な値は GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_CLOSEST から GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_FARTHEST までです。
• 戻り値 - このポイント コレクションのための静的マップの URL 。

GvideoSearchgoogle.search.VideoSearch()

このコンストラクタは、Google ウェブ検索サービスからの検索結果を提供するために設計されたサーチャー オブジェクトのインスタンスを作成するために使われます。

.setResultOrder(orderBy)

このサーチャーのデフォルトの挙動は、関連度順に結果を戻すことです。場合により、日付順に結果を表示しても便利なことがあります。このメソッドは、結果の順序を変更するために使えます。

• orderBy - 目的の結果順を指定します:
  • GSearchgoogle.search.Search.ORDER_BY_RELEVANCE - デフォルト。結果が関連度順に戻されることを示します。
  • GSearchgoogle.search.Search.ORDER_BY_DATE - この値は、結果が公開日順に戻されることを示します。
• 戻り値 - n/a

GblogSearchgoogle.search.BlogSearch()

このコンストラクタは、Google ブログ検索サービスからの検索結果を提供するために設計されたサーチャー オブジェクトのインスタンスを作成するために使われます。

.setSiteRestriction(site)

このメソッドは、このサーチャーによって戻されるブログ検索の結果セットを制限するために使われます。結果を blogspot.com 上のすべてのブログ結果に制限するには、値を「blogspot.com」にしてこのメソッドを呼び出します。結果を Live Journal 上の Nintendo DS ブログに制限するには、「http://community.livejournal.com/nintendo_ds/」で呼び出します。サイト制限をクリアするには、null の値を渡します。

• site - サイト制限設定を指定します。たとえば「blogspot.com」、「http://community.livejournal.com/nintendo_ds/」などです。
• 戻り値 - n/a

GnewsSearchgoogle.search.NewsSearch()

このコンストラクタは、Google ニュース サービスからの検索結果を提供するために設計されたサーチャー オブ�