Method: searchAlongRoute

ค้นหาสถานที่ตามเส้นทางการเดินทาง

คำขอ HTTP

POST https://mapstools.googleapis.com/v1alpha:searchAlongRoute

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

เนื้อความของคำขอ

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

การแสดง JSON
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
ช่อง
textQuery

string

ต้องระบุ คำค้นหาโดยใช้ภาษาธรรมชาติ (เช่น "ที่ชาร์จ EV" "กาแฟ")

languageCode

string

ไม่บังคับ ภาษาสำหรับข้อมูลสรุปและรายละเอียดสถานที่ ค่าเริ่มต้นคือ "en-US"

regionCode

string

ไม่บังคับ รหัสประเทศ/ภูมิภาค (CLDR) ของสถานที่ตั้ง (เช่น "US")

routingPreference

enum (RoutingPreference)

ไม่บังคับ ค่ากำหนดการกำหนดเส้นทางที่ไม่บังคับซึ่งระบุวิธีใช้ข้อมูลการจราจร ค่าเริ่มต้นคือ TRAFFIC_UNAWARE

includeExtendedDetails

boolean

ไม่บังคับ รวมรายละเอียดสถานที่เพิ่มเติมในการตอบกลับ

ตั้งค่าฟิลด์นี้เป็น true เมื่อคำขอของผู้ใช้ต้องการข้อมูลเชิงลึกเชิงคุณภาพที่สมบูรณ์ ไดนามิกแบบเรียลไทม์ หรือแอตทริบิวต์เอนทิตีเฉพาะทาง เช่น รีวิวเชิงคุณภาพ ความรู้สึกของลูกค้า และความคิดเห็น - ข้อเสนอที่เฉพาะเจาะจง เช่น รายการเมนู อาหาร อาหารพิเศษ เครื่องดื่ม หรือไฮไลต์ของธุรกิจ - บรรยากาศเชิงคุณภาพ การตกแต่งภายใน สุนทรียภาพ บรรยากาศ หรืออารมณ์ - ข้อมูลแบบเรียลไทม์และข้อมูลจำเพาะของสถานที่เฉพาะทาง นโยบาย/เคล็ดลับสำหรับผู้เข้าชม เวลารอ

ปล่อย false (ค่าเริ่มต้น) ไว้สำหรับการค้นหาเพื่อการสำรวจมาตรฐาน (เช่น อาหาร ประเภทของร้านค้า) การค้นหาสถานที่/ที่อยู่ ข้อมูลติดต่อ เวลาทำการ และข้อมูลเมตา/สิ่งอำนวยความสะดวกมาตรฐาน

การเปิดใช้ช่องนี้อาจทำให้เวลาในการตอบสนองสูงขึ้น

travelMode

enum (RouteTravelMode)

ไม่บังคับ ระบุโหมดการเดินทางที่ใช้ในการคำนวณเส้นทางและทางอ้อม ค่าเริ่มต้นคือ DRIVE WALK และ BICYCLE รองรับเฉพาะ routeEndpoints เท่านั้น ไม่รองรับ TRANSIT

ข้อกำหนดเส้นทาง: เส้นทางที่มีอยู่ โทเค็นเส้นทาง หรือปลายทางต้นทาง/ปลายทาง รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
encodedPolyline

string

สตริงเส้นประกอบที่เข้ารหัสซึ่งแสดงเส้นทาง ดู https://developers.google.com/maps/documentation/utilities/polylinealgorithm

retrievalToken

string

โทเค็นการดึงข้อมูลที่แสดงผลจากการเรียก v1alpha.computeRoutes ก่อนหน้าซึ่งแสดงถึงเส้นทาง

routeEndpoints

object (RouteEndpoints)

ปลายทางของเส้นทางที่ชัดเจน (ต้นทางและปลายทาง)

สิ้นสุดฟิลด์ที่แยกกัน

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ SearchAlongRouteResponse

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

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

  • https://www.googleapis.com/auth/maps-platform.mapstools