ชั้นเรียน: ช่างก่อสร้าง

gapi.cloudsearch.วิดเจ็ตsearchboxเครื่องมือสร้าง

class   static

เครื่องมือสร้างช่องค้นหา ใช้เครื่องมือสร้างและอย่าเรียกตัวสร้างช่องค้นหาโดยตรง

ผู้ผลิต

ช่างก่อสร้าง

new 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);

วิธีการ

สร้าง

create() ส่งคืน SearchBox

คิกรีเทิร์น

non-null SearchBox 

setAdapter

setAdapter(adapter) จะส่งกลับ Builder

ต้องระบุ ปรับแต่งประสบการณ์ในการค้นหาของผู้ใช้ด้วยอะแดปเตอร์นี้

พารามิเตอร์
อะแดปเตอร์	SearchBoxAdapter คุณลบล้างบางส่วนของเมธอดได้ ค่าต้องไม่เป็นค่าว่าง

คิกรีเทิร์น

non-null Builder สิ่งนี้

ตัวอย่าง

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) แสดงผล Builder

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งอาจมีโหนดย่อย Anchor ของการวางซ้อนการค้นหา โฆษณาซ้อนทับจะถูกเพิ่มเป็นรายการย่อยรายการสุดท้ายใน Anchor ตำแหน่งของโฆษณาซ้อนทับคือด้านล่างของจุดยึด

พารามิเตอร์
แท็ก Anchor	HTMLElement ค่าต้องไม่เป็นค่าว่าง

เลิกใช้

ใช้ "setAnchorElement" แทน

คิกรีเทิร์น

non-null Builder สิ่งนี้

setAnchorElement

setAnchorElement(anchorElement) แสดงผลเครื่องมือสร้าง

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งอาจมีโหนดย่อย Anchor ของการวางซ้อนการค้นหา โฆษณาซ้อนทับจะถูกเพิ่มเป็นรายการย่อยรายการสุดท้ายใน Anchor ตำแหน่งของโฆษณาซ้อนทับคือด้านล่างของจุดยึด

พารามิเตอร์
anchorElement	HTMLElement ค่าต้องไม่เป็นค่าว่าง

คิกรีเทิร์น

non-null Builder สิ่งนี้

setHints

setHints(hints) ส่งคืน Builder

Optional คำแนะนำในช่องค้นหาเมื่อป้อนข้อมูลว่างเปล่า เมื่ออินพุตว่างเปล่า ระบบจะสุ่มเลือกคำใบ้จากอาร์เรย์

พารามิเตอร์
คำใบ้	อาร์เรย์ของสตริง ค่าต้องไม่เป็นค่าว่าง

คิกรีเทิร์น

non-null Builder สิ่งนี้

setInput

setInput(input) แสดงผลเครื่องมือสร้าง

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนคำค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
อินพุต	HTMLElement ค่าต้องไม่เป็นค่าว่าง

เลิกใช้

ใช้ "setInputElement" แทน

คิกรีเทิร์น

non-null Builder สิ่งนี้

setInputElement

setInputElement(inputElement) แสดงผลเครื่องมือสร้าง

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนคำค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
inputElement	HTMLElement ค่าต้องไม่เป็นค่าว่าง

คิกรีเทิร์น

non-null Builder สิ่งนี้

setResultsContainer

setResultsContainer(resultsContainer) แสดงผลเครื่องมือสร้าง

Optional คอนเทนเนอร์สำหรับแสดงผลการค้นหา หากตั้งค่าไว้ ผลลัพธ์จะแสดงในคอนเทนเนอร์ผลการค้นหา หากไม่ได้ตั้งค่า ผลลัพธ์จะแสดงใน cloudsearch.google.com

พารามิเตอร์
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer ค่าต้องไม่เป็นค่าว่าง

ดูเพิ่มเติม

ResultsContainer

คิกรีเทิร์น

non-null Builder สิ่งนี้

setSearchApplicationId

setSearchApplicationId(searchApplicationId) จะแสดงตัวสร้าง

Optional ตั้งค่ารหัสแอปพลิเคชันการค้นหาที่จะใช้สำหรับคำขอ ต้องนำหน้าด้วย "searchapplications/"

พารามิเตอร์
searchApplicationId	สตริง

คิกรีเทิร์น

non-null Builder สิ่งนี้

setThrottleInterval

setThrottleInterval(throttleInterval) แสดงเครื่องมือสร้าง

Optional ช่วงเวลาควบคุมในหน่วยมิลลิวินาทีสำหรับคำขอเริ่มทำงาน ช่องค้นหาจะส่งคำขอน้อยกว่า 1 คำขอในทุก throttleInterval มิลลิวินาที หาก throttleInternal น้อยกว่า 200 ช่องค้นหาจะไม่สนใจค่าดังกล่าวและใช้ 200 เป็นช่วงแทน

พารามิเตอร์
throttleInterval	ตัวเลข

คิกรีเทิร์น

non-null Builder สิ่งนี้