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)
  },
  "includeFutureOpeningBusinesses": boolean
}
ช่อง
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 หลัก
includedTypes[]

string

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

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

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

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

string

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

ระบุประเภทจาก ตาราง A ได้สูงสุด 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 สถานที่หนึ่งๆ จะมีประเภทหลักได้เพียงประเภทเดียวจากตารางประเภทที่รองรับที่เชื่อมโยงกับสถานที่นั้น

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

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

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

string

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

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

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

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

integer

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

object (LocationRestriction)

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

enum (RankPreference)

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

object (RoutingParameters)

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

boolean

ไม่บังคับ หากเป็นจริง ให้รวมธุรกิจที่ยังไม่เปิดแต่จะเปิดในอนาคต

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

โปรโตคอลการตอบกลับสำหรับการค้นหาสถานที่ใกล้เคียง

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

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

object (Place)

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

object (RoutingSummary)

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

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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.
}
ช่อง

ฟิลด์ Union type

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

object (Circle)

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

RankPreference

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

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