Builder

新着 Builder()

// Builds a search box.
function onload() {
  gapi.client.init({
    'apiKey': '<your api key>',
    'clientId': '<your client id>',
    // Add additional scopes if needed
    'scope': 'https://www.googleapis.com/auth/cloud_search.query',
    'hosted_domain': '<your G Suite domain>',
  });

  const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById('input'))
    .setAnchor(document.getElementById('input').parentElement)
    .build();
}
gapi.load('client:cloudsearch-widget', onload);

build

build() returns SearchBox

戻り値

non-null SearchBox 

setAdapter

setAdapter(adapter) が Builder を返す

必須。このアダプターを使用して、ユーザーの検索エクスペリエンスをカスタマイズします。

戻り値

non-null Builder これ

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) が Builder を返す

必須。子要素を含めることができる有効な HTMLElement を指定してください 説明します。 検索オーバーレイのアンカー。オーバーレイが追加される 最後の子として割り当てられますオーバーレイの位置は、 追加できます

非推奨

代わりに「setAnchorElement」を使用してください

戻り値

non-null Builder これ

setAnchorElement

setAnchorElement(anchorElement) が Builder を返す

必須。子要素を含めることができる有効な HTMLElement を指定してください 説明します。 検索オーバーレイのアンカー。オーバーレイが追加される 最後の子として割り当てられますオーバーレイの位置は、 追加できます

戻り値

non-null Builder これ

setHints

setHints(hints) が Builder を返す

（省略可）入力欄が空のときに表示されるヒント。 入力が空の場合、配列からランダムなヒントが選択されます。

戻り値

non-null Builder これ

setInput

setInput(input) は Builder を返す

必須。ユーザーがクエリを入力する HTMLElement。 <input> にする必要があります。または <textarea>

非推奨

代わりに「setInputElement」を使用してください

戻り値

non-null Builder これ

setInputElement

setInputElement(inputElement) returns Builder

必須。ユーザーがクエリを入力する HTMLElement。 <input> にする必要があります。または <textarea>

戻り値

non-null Builder これ

setResultsContainer

setResultsContainer(resultsContainer) はビルダーを返します。

（省略可）検索結果を表示するためのコンテナ。 設定すると、結果は検索結果コンテナにレンダリングされます。 設定しない場合、結果は cloudsearch.google.com に表示されます。

関連情報

ResultsContainer

戻り値

non-null Builder これ

setSearchApplicationId

setSearchApplicationId(searchApplicationId) は Builder を返します

（省略可）リクエストに使用する検索アプリケーション ID を設定します。必須 先頭に「searchapplications/」が付きます。

戻り値

non-null Builder これ

setThrottleInterval

setThrottleInterval(throttleInterval) がビルダーを返す

（省略可）リクエスト発生時のスロットル間隔（ミリ秒）。 検索ボックスで throttleInterval ごとに送信されるリクエストが 1 つ未満である ミリ秒単位です。throttleInternal が 200 未満の場合、検索ボックスは無視されます 代わりに 200 を使用します

戻り値

non-null Builder これ