แสดงผลข้อมูลเมตาเกี่ยวกับการค้นหาที่ดำเนินการ ข้อมูลเมตาเกี่ยวกับเครื่องมือที่ใช้สำหรับการค้นหา และผลการค้นหา ใช้รูปแบบ URL ชุดเล็กๆ
คำขอ HTTP
GET https://customsearch.googleapis.com/customsearch/v1/siterestrict
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
| พารามิเตอร์ | |
|---|---|
| c2coff | 
 เปิดหรือปิดใช้การค้นหาภาษาจีนตัวย่อและตัวเต็ม ค่าเริ่มต้นของพารามิเตอร์นี้คือ 0 (ศูนย์) หมายความว่าฟีเจอร์นี้เปิดใช้อยู่ ค่าที่รองรับมีดังนี้ 
 | 
| cr | 
 จำกัดผลการค้นหาเฉพาะเอกสารที่มาจากประเทศที่กำหนดไว้เท่านั้น คุณสามารถใช้โอเปอเรเตอร์บูลีนในค่าของพารามิเตอร์ cr Google Search ระบุประเทศของเอกสารด้วยการวิเคราะห์สิ่งต่อไปนี้ 
 โปรดดูรายการค่าที่ถูกต้องสำหรับพารามิเตอร์นี้ในหน้าค่าพารามิเตอร์ประเทศ | 
| cx | 
 รหัส Programmable Search Engine ที่จะใช้กับคำขอนี้ | 
| 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 | 
 ดัชนีของผลลัพธ์แรกที่จะแสดงผล จำนวนผลการค้นหาเริ่มต้นต่อหน้าคือ 10 ดังนั้น  | 
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Search
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
- https://www.googleapis.com/auth/cse
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0