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)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
ช่อง
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

ใช้เพื่อจำกัดการค้นหาให้แสดงเฉพาะสถานที่ที่เปิดอยู่ในปัจจุบัน ค่าเริ่มต้นคือ False
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 ก่อนหน้านี้ ระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป

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

enum (PriceLevel)

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

boolean

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

object (LocationBias)

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

object (LocationRestriction)

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

object (EVOptions)

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

object (RoutingParameters)

ไม่บังคับ พารามิเตอร์เพิ่มเติมสำหรับการกําหนดเส้นทางไปยังผลลัพธ์
searchAlongRouteParameters

object (SearchAlongRouteParameters)

ไม่บังคับ พารามิเตอร์โปรโตคอลเพิ่มเติมสำหรับการค้นหาตามเส้นทาง
includePureServiceAreaBusinesses

boolean

ไม่บังคับ รวมธุรกิจที่ให้บริการตามสถานที่เพียงอย่างเดียวหากตั้งค่าช่องเป็น "จริง" ธุรกิจที่ให้บริการตามสถานที่เพียงอย่างเดียวคือธุรกิจที่บริการแบบถึงที่หรือออกให้บริการแก่ลูกค้าโดยตรง โดยไม่ได้ให้บริการลูกค้า ณ ที่อยู่ธุรกิจ ตัวอย่างเช่น บริการทำความสะอาดหรือช่างประปา ธุรกิจเหล่านั้นไม่มีที่อยู่หรือสถานที่ตั้งจริงบน Google Maps โดย Places จะไม่แสดงฟิลด์ location, plusCode และฟิลด์อื่นๆ ที่เกี่ยวข้องกับสถานที่ตั้งสำหรับธุรกิจเหล่านี้

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

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

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

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

object (Place)

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

object (RoutingSummary)

รายการสรุปการกำหนดเส้นทางที่แต่ละรายการเชื่อมโยงกับสถานที่ที่เกี่ยวข้องในดัชนีเดียวกันในช่อง places หากสรุปเส้นทางไม่พร้อมใช้งานสำหรับสถานที่ใดสถานที่หนึ่ง สรุปเส้นทางจะมีรายการว่าง รายการนี้จะมีจํานวนรายการเท่ากับรายการสถานที่หากมีการขอ
contextualContents[]

object (ContextualContent)

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

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

string

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

string

ลิงก์ช่วยให้ผู้ใช้ค้นหาด้วยข้อความค้นหาเดียวกันกับที่ระบุไว้ในคำขอบน Google Maps ได้

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

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

  • https://www.googleapis.com/auth/cloud-platform

RankPreference

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

Enum
RANK_PREFERENCE_UNSPECIFIED สําหรับคําค้นหาแบบหมวดหมู่ เช่น "ร้านอาหารในนิวยอร์กซิตี้" ระบบจะใช้ "ความเกี่ยวข้อง" เป็นค่าเริ่มต้น สําหรับการค้นหาที่ไม่ใช่หมวดหมู่ เช่น "ภูเก็ต" เราขอแนะนําให้คุณไม่ตั้งค่า 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 ที่ต้องการ ระบบจะกรองสถานที่ที่ไม่รองรับประเภทขั้วต่อที่ระบุไว้ออก

SearchAlongRouteParameters

ระบุเส้นประกอบที่คำนวณไว้ล่วงหน้าจาก Routes API ซึ่งกำหนดเส้นทางที่จะค้นหา การค้นหาตามเส้นทางคล้ายกับการใช้ตัวเลือกคำขอ locationBias หรือ locationRestriction เพื่อกำหนดทิศทางของผลการค้นหา อย่างไรก็ตาม แม้ว่าตัวเลือก locationBias และ locationRestriction จะช่วยให้คุณระบุภูมิภาคเพื่อกำหนดทิศทางของผลการค้นหาได้ แต่ตัวเลือกนี้จะช่วยให้คุณกำหนดทิศทางของผลการค้นหาตามเส้นทางการเดินทางได้

เราไม่รับประกันว่าผลการค้นหาจะไปตามเส้นทางที่ระบุ แต่ระบบจะจัดอันดับภายในพื้นที่การค้นหาที่กำหนดโดยเส้นประกอบ และตาม locationBias หรือ locationRestriction (ไม่บังคับ) โดยอิงตามเวลาอ้อมทางขั้นต่ำจากต้นทางไปยังปลายทาง ผลลัพธ์อาจอยู่ตามเส้นทางอื่น โดยเฉพาะอย่างยิ่งหากเส้นประกอบที่ระบุไม่ได้กำหนดเส้นทางที่ดีที่สุดจากต้นทางไปยังปลายทาง

การแสดง JSON 
{
  "polyline": {
    object (Polyline)
  }
}
ช่อง
polyline

object (Polyline)

ต้องระบุ เส้นประกอบของเส้นทาง

เส้นประกอบ

เส้นประกอบของเส้นทาง รองรับเฉพาะรูปหลายเหลี่ยมที่เข้ารหัส ซึ่งสามารถส่งเป็นสตริงและมีการบีบอัดแบบไม่สูญเสียข้อมูลมากนัก นี่คือเอาต์พุตเริ่มต้นของ Routes API

การแสดง JSON 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
ช่อง
ฟิลด์สหภาพ polyline_type บรรจุประเภทของเส้นประกอบ เอาต์พุต Routes API จะเริ่มต้นที่ encoded_polyline polyline_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
encodedPolyline

string

รูปหลายเหลี่ยมที่เข้ารหัสตามที่ Routes API แสดงผลโดยค่าเริ่มต้น ดูเครื่องมือโปรแกรมเปลี่ยนไฟล์และโปรแกรมถอดรหัส

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

ข้อความที่ไฮไลต์โดยเหตุผลรองรับ ข้อมูลนี้เป็นข้อมูลย่อยของรีวิว HighlightedTextRange จะทําเครื่องหมายคําที่ไฮไลต์ ข้อความอาจไฮไลต์คำหลายคำ

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

ในกรณีที่สถานที่ให้บริการอาหารในร้าน