Method: places.searchNearby

ค้นหาสถานที่ที่อยู่ใกล้สถานที่

คำขอ HTTP

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

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

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

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
ช่อง
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 หลัก
includedTypes[]

string

ประเภทสถานที่ที่ระบุ (เช่น "ร้านอาหาร" หรือ "gas_station") จาก https://developers.google.com/maps/documentation/places/web-service/place-types

ระบุประเภทจากตาราง ก ได้สูงสุด 50 ประเภท

หากมีประเภทที่ขัดแย้งกัน กล่าวคือ มีประเภทหนึ่งๆ ปรากฏในทั้ง includeTypes และ excludedTypes ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

หากระบุประเภทสถานที่ที่มีข้อจำกัดประเภทหลายรายการ ระบบจะแสดงเฉพาะสถานที่ที่ตรงตามข้อจำกัดทั้งหมด ตัวอย่างเช่น หากมี {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} สถานที่ที่แสดงผลจะให้บริการที่เกี่ยวข้องกับ "ร้านอาหาร" แต่ไม่ได้ดำเนินการเป็น "ร้านอาหาร" เป็นหลัก
excludedTypes[]

string

ประเภทสถานที่ที่ยกเว้น (เช่น "ร้านอาหาร" หรือ "gas_station") จาก https://developers.google.com/maps/documentation/places/web-service/place-types

ระบุประเภทจากตาราง ก ได้สูงสุด 50 ประเภท

หากลูกค้าระบุทั้ง includedTypes (เช่น ร้านอาหาร) และ excludedTypes (เช่น คาเฟ่) การตอบกลับควรมีสถานที่ที่เป็นร้านอาหารแต่ไม่ใช่คาเฟ่ การตอบกลับจะมีสถานที่ที่ตรงกับ includedTypes อย่างน้อย 1 รายการและไม่มี excludedTypes รายการใดเลย

หากมีประเภทที่ขัดแย้งกัน เช่น ประเภทปรากฏทั้งใน includedTypes และ excludedTypes ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

หากระบุประเภทสถานที่ที่มีข้อจำกัดประเภทหลายรายการ ระบบจะแสดงเฉพาะสถานที่ที่ตรงตามข้อจำกัดทั้งหมด ตัวอย่างเช่น หากมี {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} สถานที่ที่แสดงผลจะให้บริการที่เกี่ยวข้องกับ "ร้านอาหาร" แต่ไม่ได้ดำเนินการเป็น "ร้านอาหาร" เป็นหลัก
includedPrimaryTypes[]

string

ประเภทสถานที่หลักที่รวมอยู่ (เช่น "restaurant" หรือ "gas_station") จาก https://developers.google.com/maps/documentation/places/web-service/place-types สถานที่หนึ่งๆ เชื่อมโยงกับประเภทหลักได้เพียงประเภทเดียวจากตารางประเภทที่รองรับ

ระบุประเภทจากตาราง ก ได้สูงสุด 50 ประเภท

หากมีประเภทหลักที่ขัดแย้งกัน เช่น ประเภทปรากฏทั้งใน includedPrimaryTypes และ excludedPrimaryTypes ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

หากระบุประเภทสถานที่ที่มีข้อจำกัดประเภทหลายรายการ ระบบจะแสดงเฉพาะสถานที่ที่ตรงตามข้อจำกัดทั้งหมด ตัวอย่างเช่น หากมี {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} สถานที่ที่แสดงผลจะให้บริการที่เกี่ยวข้องกับ "ร้านอาหาร" แต่ไม่ได้ดำเนินการเป็น "ร้านอาหาร" เป็นหลัก
excludedPrimaryTypes[]

string

ยกเว้นประเภทสถานที่หลัก (เช่น "ร้านอาหาร" หรือ "gas_station") จาก https://developers.google.com/maps/documentation/places/web-service/place-types

ระบุประเภทจากตาราง ก ได้สูงสุด 50 ประเภท

หากมีประเภทหลักที่ขัดแย้งกัน กล่าวคือ ประเภทหนึ่งๆ จะปรากฏในทั้งincludePrimaryTypes และ excludedPrimaryTypes ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

หากระบุประเภทสถานที่พร้อมข้อจำกัดหลายประเภท ระบบจะแสดงเฉพาะสถานที่ที่เป็นไปตามข้อจำกัดทั้งหมด ตัวอย่างเช่น หากมี {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} สถานที่ที่แสดงผลจะให้บริการที่เกี่ยวข้องกับ "ร้านอาหาร" แต่ไม่ได้ดำเนินการเป็น "ร้านอาหาร" เป็นหลัก
maxResultCount

integer

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

object (LocationRestriction)

ต้องระบุ ภูมิภาคที่จะค้นหา
rankPreference

enum (RankPreference)

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

object (RoutingParameters)

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

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

โปรโตคอลคำตอบสําหรับการค้นหาในบริเวณใกล้เคียง

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

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

object (Place)

รายการสถานที่ที่ตรงกับข้อกำหนดของผู้ใช้ เช่น ประเภทสถานที่ จำนวนสถานที่ และข้อจำกัดของสถานที่ที่เฉพาะเจาะจง
routingSummaries[]

object (RoutingSummary)

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

LocationRestriction

ภูมิภาคที่จะค้นหา

การแสดง JSON 
{

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

ฟิลด์สหภาพ type

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

object (Circle)

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

RankPreference

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

Enum
RANK_PREFERENCE_UNSPECIFIED ไม่ได้ตั้งค่า RankPreference จะใช้การจัดอันดับตามความนิยมโดยค่าเริ่มต้น
DISTANCE จัดอันดับผลการค้นหาตามระยะทาง
POPULARITY จัดอันดับผลการค้นหาตามความนิยม