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 หากตั้งค่าเป็น "จริง" ระบบจะแสดงเฉพาะผลลัพธ์ประเภทเดียวกันเท่านั้น ค่าเริ่มต้นคือ "เท็จ"
locationBias

object (LocationBias)

ภูมิภาคที่จะค้นหา ตำแหน่งนี้มีการให้น้ำหนักพิเศษ ซึ่งหมายความว่าอาจมีการแสดงผลลัพธ์รอบๆ ตำแหน่งที่ระบุ ไม่สามารถตั้งค่าพร้อมกับ locationRestriction ได้
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

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

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

object (HighlightedText)
review

object (Review)

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

HighlightedText

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

การแสดง 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

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