Method: places.searchText

การค้นหาสถานที่ด้วยข้อความ

คำขอ HTTP

POST https://places.googleapis.com/v1/places:searchText

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

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
ช่อง
textQuery

string

ต้องระบุ การค้นหาข้อความสำหรับการค้นหาด้วยข้อความ
languageCode

string

รายละเอียดสถานที่จะแสดงเป็นภาษาที่ต้องการ ถ้ามี หากไม่ระบุหรือไม่รู้จักรหัสภาษา รายละเอียดสถานที่ของภาษาใดๆ อาจแสดงผล โดยแนะนำให้เป็นภาษาอังกฤษหากมีรายละเอียดดังกล่าว

รายการภาษาที่สนับสนุนในปัจจุบัน: https://developers.google.com/maps/faq#languagesupport
regionCode

string

รหัสประเทศ/ภูมิภาคแบบ Unicode (CLDR) ของประเทศที่ส่งคำขอ พารามิเตอร์นี้ใช้เพื่อแสดงรายละเอียดสถานที่ เช่น ชื่อสถานที่เฉพาะภูมิภาค (หากมี) พารามิเตอร์อาจส่งผลต่อผลลัพธ์ตามกฎหมายที่เกี่ยวข้อง

ดูข้อมูลเพิ่มเติมได้ที่ https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

โปรดทราบว่าขณะนี้ระบบยังไม่รองรับรหัสภูมิภาค 3 หลัก
rankPreference

enum (RankPreference)

วิธีจัดอันดับผลการค้นหาในคำตอบ
includedType

string

ประเภทสถานที่ที่ขอ ดูรายการประเภททั้งหมดที่รองรับได้ที่ https://developers.google.com/maps/documentation/places/web-service/place-types รองรับประเภทที่รวมอยู่เพียงประเภทเดียวเท่านั้น
openNow

boolean

ใช้เพื่อจำกัดการค้นหาไว้เฉพาะสถานที่ที่เปิดอยู่เท่านั้น ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ"
minRating

number

กรองผลลัพธ์ที่มีคะแนนเฉลี่ยของผู้ใช้ต่ำกว่าขีดจำกัดนี้ออก ค่าที่ถูกต้องต้องเป็นจำนวนลอยตัวระหว่าง 0 ถึง 5 (รวม) ที่ความถี่ 0.5 ได้แก่ [0, 0.5, 1.0, ... , 5.0] โดยรวม คะแนนอินพุตจะปัดเศษขึ้นให้ใกล้กับค่า 0.5(เพดาน) ที่ใกล้เคียงที่สุด ตัวอย่างเช่น คะแนน 0.6 จะตัดผลลัพธ์ทั้งหมดที่มีคะแนนต่ำกว่า 1.0 ออกไป
maxResultCount
(deprecated)

integer

เลิกใช้งานแล้ว: ใช้ pageSize แทน

จำนวนผลลัพธ์สูงสุดต่อหน้าที่สามารถส่งคืนได้ หากจำนวนผลลัพธ์ที่ใช้ได้มากกว่า maxResultCount ระบบจะแสดงผล nextPageToken ซึ่งส่งผ่านไปยัง pageToken เพื่อรับผลลัพธ์หน้าถัดไปในคำขอที่ตามมาได้ หากระบุค่า 0 หรือไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้น 20 ค่าสูงสุดคือ 20 ค่าที่มากกว่า 20 จะถูกเปลี่ยนเป็น 20 ค่าลบจะส่งกลับข้อผิดพลาด INVALID_ARGUMENT

หากระบุทั้ง maxResultCount และ pageSize ระบบจะไม่สนใจ maxResultCount
pageSize

integer

ไม่บังคับ จำนวนผลลัพธ์สูงสุดต่อหน้าที่สามารถส่งคืนได้ หากจำนวนผลลัพธ์ที่ใช้ได้มากกว่า pageSize ระบบจะแสดงผล nextPageToken ซึ่งส่งผ่านไปยัง pageToken เพื่อรับผลลัพธ์หน้าถัดไปในคำขอที่ตามมาได้ หากระบุค่า 0 หรือไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้น 20 ค่าสูงสุดคือ 20 ค่าที่มากกว่า 20 จะถูกตั้งค่าเป็น 20 ค่าลบจะส่งกลับข้อผิดพลาด INVALID_ARGUMENT

หากระบุทั้ง maxResultCount และ pageSize ระบบจะไม่สนใจ maxResultCount
pageToken

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้ TextSearch ครั้งก่อน ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์ทั้งหมดที่ไม่ใช่ pageToken, pageSize และ maxResultCount ที่ระบุไปยัง TextSearch จะต้องตรงกับการเรียกเริ่มต้นที่ระบุโทเค็นของหน้าเว็บ มิฉะนั้น ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
priceLevels[]

enum (PriceLevel)

ใช้เพื่อจำกัดการค้นหาไว้เฉพาะตำแหน่งที่มีการทำเครื่องหมายเป็นระดับราคาบางระดับ ผู้ใช้เลือกผสมผสานระดับราคาแบบใดก็ได้ ค่าเริ่มต้นคือเลือกระดับราคาทั้งหมด
strictTypeFiltering

boolean

ใช้เพื่อตั้งค่าการกรองประเภทที่เข้มงวดสำหรับincludeType หากตั้งค่าเป็น "จริง" ระบบจะแสดงผลเฉพาะผลการค้นหาประเภทเดียวกันเท่านั้น ค่าเริ่มต้นคือ false
locationBias

object (LocationBias)

ภูมิภาคที่จะค้นหา ตำแหน่งนี้ก่อให้เกิดความเอนเอียง ซึ่งหมายความว่าอาจมีการแสดงผลลัพธ์รอบๆ ตำแหน่งที่ระบุ ไม่สามารถตั้งค่าพร้อมกับข้อจำกัดตำแหน่ง
locationRestriction

object (LocationRestriction)

ภูมิภาคที่จะค้นหา สถานที่นี้ทำหน้าที่เป็นข้อจำกัด ซึ่งหมายความว่าจะไม่มีการแสดงผลการค้นหานอกสถานที่ตั้งที่ระบุ ไม่สามารถตั้งค่าพร้อมกับ locationBias
evOptions

object (EVOptions)

ไม่บังคับ ตั้งค่าตัวเลือก EV ที่ค้นหาได้ของคำขอค้นหาสถานที่

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

โปรโตคอลการตอบกลับสำหรับ places.searchText

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
ช่อง
places[]

object (Place)

รายการสถานที่ที่ตรงตามเกณฑ์การค้นหาข้อความของผู้ใช้
contextualContents[]

object (ContextualContent)

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

รายการเนื้อหาตามบริบทที่แต่ละรายการเชื่อมโยงอยู่กับตำแหน่งที่เกี่ยวข้องในดัชนีเดียวกันในฟิลด์ สถานที่ ขอแนะนำให้ใช้เนื้อหาที่เกี่ยวข้องกับ textQuery ในคำขอ หากเนื้อหาตามบริบทไม่พร้อมใช้งานในที่ใดตำแหน่งหนึ่ง ระบบจะแสดงเนื้อหาที่ไม่ใช่เนื้อหาตามบริบท ตารางนี้จะว่างเปล่าก็ต่อเมื่อเนื้อหาของสถานที่นี้ไม่พร้อมให้บริการ รายการนี้ควรมีข้อมูลจำนวนมากเท่ากับรายการสถานที่ หากมีการร้องขอ
nextPageToken

string

โทเค็นที่ส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไปได้ หากเว้นช่องนี้หรือเว้นว่าง จะไม่มีหน้าถัดไป

RankPreference

วิธีจัดอันดับผลการค้นหาในคำตอบ

Enum
RANK_PREFERENCE_UNSPECIFIED สำหรับคำค้นหาเชิงหมวดหมู่ เช่น "ร้านอาหารในนิวยอร์กซิตี้" RELEVANCE จะเป็นค่าเริ่มต้น สำหรับคำค้นหาที่ไม่เกี่ยวข้องกับหมวดหมู่ เช่น "Mountain View, CA" เราขอแนะนําให้ไม่ตั้งค่า rankPreference
DISTANCE จัดอันดับผลการค้นหาตามระยะทาง
RELEVANCE จัดอันดับผลการค้นหาตามความเกี่ยวข้อง ลำดับการจัดเรียงที่กำหนดโดยสแต็กการจัดอันดับปกติ

LocationBias

ภูมิภาคที่จะค้นหา ตำแหน่งนี้ก่อให้เกิดความเอนเอียง ซึ่งหมายความว่าอาจมีการแสดงผลลัพธ์รอบๆ ตำแหน่งที่ระบุ

การแสดง JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
ช่อง

ช่องการรวม type

type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
rectangle

object (Viewport)

กล่องสี่เหลี่ยมผืนผ้าที่กำหนดโดยมุมทิศตะวันออกเฉียงเหนือและทิศตะวันตกเฉียงใต้ rectangle.high() ต้องเป็นจุดทิศตะวันออกเฉียงเหนือของวิวพอร์ตรูปสี่เหลี่ยมผืนผ้า rectangle.low() ต้องเป็นจุดตะวันตกเฉียงใต้ของวิวพอร์ตรูปสี่เหลี่ยมผืนผ้า rectangle.low().latitude() ต้องไม่มากกว่า rectangle.high().latitude() ซึ่งจะทำให้ช่วงละติจูดว่างเปล่า วิวพอร์ตสี่เหลี่ยมผืนผ้าจะต้องกว้างไม่เกิน 180 องศา
circle

object (Circle)

วงกลมที่กำหนดโดยจุดศูนย์กลางและรัศมี

LocationRestriction

ภูมิภาคที่จะค้นหา สถานที่นี้ทำหน้าที่เป็นข้อจำกัด ซึ่งหมายความว่าจะไม่มีการแสดงผลการค้นหานอกสถานที่ตั้งที่ระบุ

การแสดง JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
ช่อง

ช่องการรวม type

type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
rectangle

object (Viewport)

กล่องสี่เหลี่ยมผืนผ้าที่กำหนดโดยมุมทิศตะวันออกเฉียงเหนือและทิศตะวันตกเฉียงใต้ rectangle.high() ต้องเป็นจุดทิศตะวันออกเฉียงเหนือของวิวพอร์ตรูปสี่เหลี่ยมผืนผ้า rectangle.low() ต้องเป็นจุดตะวันตกเฉียงใต้ของวิวพอร์ตรูปสี่เหลี่ยมผืนผ้า rectangle.low().latitude() ต้องไม่มากกว่า rectangle.high().latitude() ซึ่งจะทำให้ช่วงละติจูดว่างเปล่า วิวพอร์ตสี่เหลี่ยมผืนผ้าจะต้องกว้างไม่เกิน 180 องศา

EVOptions

ตัวเลือก EV ที่ค้นหาได้ของคำขอค้นหาสถานที่

การแสดง JSON 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
ช่อง
minimumChargingRateKw

number

ไม่บังคับ อัตราการชาร์จขั้นต่ำเป็นกิโลวัตต์ที่กำหนด สถานที่ที่มีอัตราการชาร์จต่ำกว่าอัตราที่ระบุจะถูกกรองออก
connectorTypes[]

enum (EVConnectorType)

ไม่บังคับ รายการประเภทหัวชาร์จ EV ที่แนะนำ ระบบจะกรองสถานที่ที่ไม่รองรับประเภทเครื่องมือเชื่อมต่อที่แสดงออก

ContextualContent

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

เนื้อหาที่มีบริบทของการค้นหาสถานที่

การแสดง JSON 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
ช่อง
reviews[]

object (Review)

รายการรีวิวเกี่ยวกับสถานที่นี้ โดยเกี่ยวข้องกับการค้นหาสถานที่
photos[]

object (Photo)

ข้อมูล (รวมถึงข้อมูลอ้างอิง) เกี่ยวกับรูปภาพของสถานที่นี้ ซึ่งเกี่ยวข้องกับการค้นหาสถานที่
justifications[]

object (Justification)

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

เหตุผลรองรับสำหรับสถานที่

การให้เหตุผล

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

เหตุผลรองรับสำหรับสถานที่ เหตุผลจะตอบคำถามที่ว่าเหตุใดสถานที่หนึ่งๆ อาจน่าสนใจสำหรับผู้ใช้ปลายทาง

การแสดง JSON 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
ช่อง

ช่องการรวม justification

justification ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
reviewJustification

object (ReviewJustification)

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

ReviewJustification

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

เหตุผลรองรับการตรวจสอบจากผู้ใช้ ซึ่งไฮไลต์ส่วนของรีวิวที่ผู้ใช้น่าจะสนใจ ตัวอย่างเช่น หากคำค้นหาคือ " Firewood พิซซ่า" คำอธิบายเหตุผลของรีวิวจะไฮไลต์ข้อความที่เกี่ยวข้องกับคำค้นหา

การแสดง JSON 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
ช่อง
highlightedText

object (HighlightedText)
review

object (Review)

รีวิวที่เป็นต้นแบบของข้อความที่ไฮไลต์

HighlightedText

ข้อความที่ไฮไลต์ตามเหตุผลรองรับ นี่เป็นเพียงข้อมูลย่อยของรีวิวเอง ส่วนคำที่จะไฮไลต์จะมีเครื่องหมาย {0/}edTextRange ข้อความที่ไฮไลต์อาจมีหลายคำ

การแสดง JSON 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
ช่อง
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

รายการช่วงของข้อความที่ไฮไลต์

HighlightedTextRange

ช่วงของข้อความที่ไฮไลต์

การแสดง JSON 
{
  "startIndex": integer,
  "endIndex": integer
}
ช่อง
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

ทดลอง: ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative เหตุผลของ BusinessAvailabilityAttributes ซึ่งแสดงแอตทริบิวต์บางอย่างที่ธุรกิจอาจมีความสนใจของผู้ใช้ปลายทาง

การแสดง JSON 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
ช่อง
takeout

boolean

หากสถานที่ให้บริการสั่งกลับบ้าน
delivery

boolean

หากสถานที่หนึ่งมีบริการจัดส่ง
dineIn

boolean

หากสถานที่ให้บริการแบบนั่งรับประทานที่ร้าน