Method: cse.siterestrict.list

แสดงผลข้อมูลเมตาเกี่ยวกับการค้นหาที่ดำเนินการ ข้อมูลเมตาเกี่ยวกับเครื่องมือที่ใช้สำหรับการค้นหา และผลการค้นหา ใช้รูปแบบ URL ชุดเล็กๆ

คำขอ HTTP

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
c2coff

string

เปิดหรือปิดใช้การค้นหาภาษาจีนตัวย่อและตัวเต็ม

ค่าเริ่มต้นของพารามิเตอร์นี้คือ 0 (ศูนย์) หมายความว่าฟีเจอร์นี้เปิดใช้อยู่ ค่าที่รองรับมีดังนี้

  • 1: ปิดใช้

  • 0: เปิดใช้ (ค่าเริ่มต้น)
cr

string

จำกัดผลการค้นหาเฉพาะเอกสารที่มาจากประเทศที่กำหนดไว้เท่านั้น คุณสามารถใช้โอเปอเรเตอร์บูลีนในค่าของพารามิเตอร์ cr

Google Search ระบุประเทศของเอกสารด้วยการวิเคราะห์สิ่งต่อไปนี้

  • โดเมนระดับบนสุด (TLD) ของ URL ของเอกสาร

  • สถานที่ตั้งทางภูมิศาสตร์ของที่อยู่ IP ของเว็บเซิร์ฟเวอร์

โปรดดูรายการค่าที่ถูกต้องสำหรับพารามิเตอร์นี้ในหน้าค่าพารามิเตอร์ประเทศ
cx

string

รหัส Programmable Search Engine ที่จะใช้กับคำขอนี้
dateRestrict

string

จำกัดผลการค้นหาเฉพาะ URL โดยอิงตามวันที่ ค่าที่รองรับมีดังนี้

  • d[number]: คำขอผลลัพธ์จากจำนวนวันที่ผ่านมาที่ระบุ

  • w[number]: คำขอผลลัพธ์จากจำนวนสัปดาห์ที่ผ่านมาที่ระบุ

  • m[number]: คำขอผลลัพธ์จากจำนวนเดือนที่ผ่านมาที่ระบุ

  • y[number]: คำขอผลลัพธ์จากจำนวนปีที่ผ่านมาที่ระบุ
exactTerms

string

ระบุวลีที่เอกสารทั้งหมดในผลการค้นหาต้องมี
excludeTerms

string

ระบุคำหรือวลีที่ไม่ควรปรากฏในเอกสารในผลการค้นหา
fileType

string

จำกัดผลการค้นหาเฉพาะไฟล์ของนามสกุลที่ระบุ โปรดดูรายการประเภทไฟล์ที่ Google จัดทำดัชนีได้ในศูนย์ช่วยเหลือของ Search Console
filter

string

ควบคุมการเปิดหรือปิดตัวกรองเนื้อหาที่ซ้ำกัน

  • ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวกรองผลการค้นหาของ Google ได้ที่การกรองอัตโนมัติ โปรดทราบว่าการกรองจำนวนโฮสต์ของโฮสต์จะมีผลกับการค้นหาจากหลายเว็บไซต์เท่านั้น

  • โดยค่าเริ่มต้น Google จะใช้การกรองกับผลการค้นหาทั้งหมดเพื่อปรับปรุงคุณภาพของผลการค้นหาเหล่านั้น

ค่าที่ยอมรับมีดังนี้

  • 0: ปิดตัวกรองเนื้อหาที่ซ้ำกัน

  • 1: เปิดตัวกรองเนื้อหาที่ซ้ำกัน
gl

string

ตำแหน่งทางภูมิศาสตร์ของผู้ใช้ปลายทาง

  • ค่าพารามิเตอร์ gl คือรหัสประเทศ 2 ตัวอักษร พารามิเตอร์ gl จะกระตุ้นผลการค้นหาที่มีประเทศต้นทางตรงกับค่าพารามิเตอร์ โปรดดูรายการค่าที่ถูกต้องในหน้ารหัสประเทศ

  • การระบุค่าพารามิเตอร์ gl ควรนำไปสู่ผลลัพธ์ที่เกี่ยวข้องมากขึ้น โดยเฉพาะอย่างยิ่งสำหรับลูกค้าต่างชาติ และที่สำคัญคือสำหรับลูกค้าในประเทศที่พูดภาษาอังกฤษนอกเหนือจากสหรัฐอเมริกา
googlehost

string

เลิกใช้งานแล้ว ใช้พารามิเตอร์ gl เพื่อให้ได้ผลลัพธ์ที่คล้ายกัน

โดเมนท้องถิ่นของ Google (เช่น google.com, google.de หรือ google.fr) ที่จะใช้ในการค้นหา
highRange

string

ระบุค่าสิ้นสุดสำหรับช่วงการค้นหา

  • ใช้ lowRange และ highRange เพื่อเพิ่มช่วงการค้นหาที่ครอบคลุม lowRange...highRange ลงในคำค้นหา
hl

string

ตั้งค่าภาษาอินเทอร์เฟซผู้ใช้
hq

string

เพิ่มข้อความค้นหาที่ระบุต่อท้ายการค้นหา เสมือนว่าข้อมูลนั้นถูกรวมกับโอเปอเรเตอร์ตรรกะ AND
imgColorType

enum (ImgColorType)

แสดงรูปภาพขาวดำ โทนสีเทา โปร่งใส หรือรูปภาพสี ค่าที่ยอมรับมีดังนี้

  • "color"

  • "gray"

  • "mono": ขาวดำ

  • "trans": พื้นหลังโปร่งใส
imgDominantColor

enum (ImgDominantColor)

แสดงรูปภาพของสีที่โดดเด่น ค่าที่ยอมรับมีดังนี้

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

แสดงรูปภาพที่มีขนาดตามที่ระบุ ค่าที่ยอมรับมีดังนี้

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

แสดงรูปภาพประเภทหนึ่ง ค่าที่ยอมรับมีดังนี้

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

ระบุค่าเริ่มต้นสำหรับช่วงการค้นหา ใช้ lowRange และ highRange เพื่อเพิ่มช่วงการค้นหาที่ครอบคลุม lowRange...highRange ลงในคำค้นหา
lr

string

จำกัดการค้นหาไว้เฉพาะเอกสารที่เขียนในภาษาหนึ่งๆ (เช่น lr=lang_ja).

ค่าที่ยอมรับมีดังนี้

  • "lang_ar": อาหรับ

  • "lang_bg": บัลแกเรีย

  • "lang_ca": คาตาลัน

  • "lang_cs": เช็ก

  • "lang_da": เดนมาร์ก

  • "lang_de": เยอรมัน

  • "lang_el": กรีก

  • "lang_en": อังกฤษ

  • "lang_es": สเปน

  • "lang_et": เอสโตเนีย

  • "lang_fi": ฟินแลนด์

  • "lang_fr": ฝรั่งเศส

  • "lang_hr": โครเอเชีย

  • "lang_hu": ฮังการี

  • "lang_id": อินโดนีเซีย

  • "lang_is": ไอซ์แลนด์

  • "lang_it": อิตาลี

  • "lang_iw": ฮีบรู

  • "lang_ja": ญี่ปุ่น

  • "lang_ko": เกาหลี

  • "lang_lt": ลิทัวเนีย

  • "lang_lv": ลัตเวีย

  • "lang_nl": ดัตช์

  • "lang_no": นอร์เวย์

  • "lang_pl": โปแลนด์

  • "lang_pt": โปรตุเกส

  • "lang_ro": โรมาเนีย

  • "lang_ru": รัสเซีย

  • "lang_sk": สโลวัก

  • "lang_sl": สโลวีเนีย

  • "lang_sr": เซอร์เบีย

  • "lang_sv": สวีเดน

  • "lang_tr": ตุรกี

  • "lang_zh-CN": ภาษาจีน (ตัวย่อ)

  • "lang_zh-TW": ภาษาจีน (ตัวเต็ม)
num

integer

จำนวนผลการค้นหาที่จะแสดงผล

  • ค่าที่ถูกต้องคือจำนวนเต็มระหว่าง 1 ถึง 10
orTerms

string

ระบุข้อความค้นหาเพิ่มเติมที่ต้องตรวจสอบในเอกสาร ซึ่งเอกสารแต่ละรายการในผลการค้นหาต้องมีข้อความค้นหาเพิ่มเติมอย่างน้อย 1 รายการ
q

string

การค้นหา
relatedSite
(deprecated)

string

เลิกใช้งานแล้ว
rights

string

ตัวกรองตามการอนุญาตให้ใช้สิทธิ ค่าที่รองรับ ได้แก่ cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived และชุดค่าผสมของค่าเหล่านี้ ดูชุดค่าผสมทั่วไป
safe

enum (Safe)

ค้นหาระดับความปลอดภัย ค่าที่ยอมรับมีดังนี้

  • "active": เปิดใช้การกรองด้วยฟีเจอร์ค้นหาปลอดภัย

  • "off": ปิดใช้การกรองด้วยฟีเจอร์ค้นหาปลอดภัย (ค่าเริ่มต้น)
searchType

enum (SearchType)

ระบุประเภทการค้นหา: image หากไม่ระบุ ระบบจะจำกัดผลการค้นหาให้แสดงเฉพาะหน้าเว็บ

ค่าที่ยอมรับมีดังนี้

  • "image": การค้นหารูปภาพที่กำหนดเอง
siteSearchFilter

enum (SiteSearchFilter)

ควบคุมว่าจะรวมหรือยกเว้นผลการค้นหาจากเว็บไซต์ที่มีชื่อในพารามิเตอร์ siteSearch

ค่าที่ยอมรับมีดังนี้

  • "e": ไม่รวม

  • "i": รวม
sort

string

นิพจน์การจัดเรียงที่จะใช้กับผลลัพธ์ พารามิเตอร์จัดเรียงจะระบุว่าจะจัดเรียงผลลัพธ์ตามนิพจน์ที่ระบุ เช่น จัดเรียงตามวันที่ ตัวอย่างเช่น Sort=date
start

integer (uint32 format)

ดัชนีของผลลัพธ์แรกที่จะแสดงผล จำนวนผลการค้นหาเริ่มต้นต่อหน้าคือ 10 ดังนั้น &start=11 จะเริ่มต้นที่ด้านบนของหน้าที่ 2 ของผลการค้นหา หมายเหตุ: JSON API จะไม่แสดงผลลัพธ์มากกว่า 100 รายการ แม้จะมีเอกสารมากกว่า 100 รายการที่ตรงกับการค้นหาก็ตาม ดังนั้นการตั้งค่าผลรวมของ start + num เป็นตัวเลขที่มากกว่า 100 จะทำให้เกิดข้อผิดพลาด และโปรดทราบว่าค่าสูงสุดสำหรับ num คือ 10

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Search

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cse

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0