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

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

ดูข้อมูลเพิ่มเติมได้ที่ 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

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

object (LocationBias)

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

object (LocationRestriction)

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

object (EVOptions)

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

object (RoutingParameters)

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

object (SearchAlongRouteParameters)

ไม่บังคับ Proto ของพารามิเตอร์เพิ่มเติมสำหรับการค้นหาตามเส้นทาง
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.
}
ช่อง

ฟิลด์ Union type

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

object (Viewport)

กล่องสี่เหลี่ยมผืนผ้าที่กำหนดโดยมุมตะวันออกเฉียงเหนือและตะวันตกเฉียงใต้ rectangle.high() ต้องเป็นจุดทางตะวันออกเฉียงเหนือของ Viewport สี่เหลี่ยมผืนผ้า 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.
}
ช่อง

ฟิลด์ Union type

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

object (Viewport)

กล่องสี่เหลี่ยมผืนผ้าที่กำหนดโดยมุมตะวันออกเฉียงเหนือและตะวันตกเฉียงใต้ rectangle.high() ต้องเป็นจุดทางตะวันออกเฉียงเหนือของ Viewport สี่เหลี่ยมผืนผ้า 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 จะช่วยให้คุณระบุภูมิภาคเพื่อกำหนดผลการค้นหาได้ แต่ตัวเลือกนี้จะช่วยให้คุณกำหนดผลการค้นหาตามเส้นทางการเดินทางได้

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

การแสดง 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.
}
ช่อง
ฟิลด์ Union 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.
}
ช่อง

ฟิลด์ Union 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

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