- คำขอ HTTP
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- SearchDestinationsRequest.AddressQuery
- SearchDestinationsRequest.LocationQuery
- SearchDestinationsRequest.LocationQuery.PlaceFilter
- PlaceView.StructureType
- SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability
- NavigationPoint.TravelMode
- ปลายทาง
- PlaceView
- PlaceView.AddressComponent
- จุดสังเกต
- Landmark.Tag
- การเข้าชม
- Entrance.Tag
- StreetViewThumbnail
- ImageAnnotation
- ImageAnnotation.Coordinate
- NavigationPoint
- NavigationPoint.Usage
- Destination.ParkingOptions
- Destination.ParkingOptions.Availability
- Destination.ArrivalSummary
เมธอดนี้จะค้นหาปลายทางและแสดงผลรายการปลายทาง
คำขอ HTTP
POST https://geocode.googleapis.com/v4alpha/geocode/destinations
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
เนื้อความของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{ "travelModes": [ enum ( |
| ฟิลด์ | |
|---|---|
travelModes[] |
ไม่บังคับ รูปแบบการเดินทางเพื่อกรองจุดนำทาง ซึ่งจะส่งผลต่อช่อง |
languageCode |
ไม่บังคับ ภาษาที่ควรแสดงผลลัพธ์ |
regionCode |
ไม่บังคับ รหัสภูมิภาค รหัสภูมิภาคที่ระบุเป็นค่า ccTLD ("โดเมนระดับบนสุด") 2 อักขระ พารามิเตอร์นี้จะส่งผลต่อผลลัพธ์ตามกฎหมายที่เกี่ยวข้อง พารามิเตอร์นี้ยังส่งผลต่อผลลัพธ์จากบริการด้วย แต่จะไม่จำกัดผลลัพธ์โดยสมบูรณ์ |
ฟิลด์ Union ระบบจะสร้างปลายทางตามคำค้นหาหลักที่ระบุ หมายเหตุ: ระบบรองรับเฉพาะสถานที่และที่อยู่ที่มีจุดหมายปลายทางในการนำทางเท่านั้น ตัวอย่างเช่น สถานที่ที่แสดงถึงบ้านหรืออพาร์ตเมนต์คอมเพล็กซ์สามารถใช้เป็นคำค้นหาหลักได้ แต่สถานที่ที่แสดงถึงท้องถิ่นหรือเขตบริหารจะใช้เป็นคำค้นหาหลักไม่ได้ |
|
place |
ชื่อทรัพยากรของสถานที่ในรูปแบบ |
addressQuery |
ที่อยู่ |
locationQuery |
ตำแหน่งที่แน่นอน |
เนื้อหาการตอบกลับ
ข้อความตอบกลับสำหรับ DestinationService.SearchDestinations
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{
"destinations": [
{
object ( |
| ช่อง | |
|---|---|
destinations[] |
รายการปลายทาง บริการจะแสดงผลลัพธ์ 1 รายการหากระบุปลายทางหลักจากคำค้นหาหลักได้อย่างชัดเจน มิฉะนั้น บริการอาจแสดงผลลัพธ์หลายรายการเพื่อแยกความกำกวมหรือแสดงผลลัพธ์เป็น 0 |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/maps-platform.geocodehttps://www.googleapis.com/auth/maps-platform.destinations
SearchDestinationsRequest.AddressQuery
ที่อยู่ถนนที่ต้องการค้นหา ระบุที่อยู่ตามรูปแบบที่ใช้โดยบริการไปรษณีย์แห่งชาติของประเทศที่เกี่ยวข้อง
| การแสดง JSON |
|---|
{ // Union field |
| ช่อง | |
|---|---|
ฟิลด์ Union kind การค้นหาที่อยู่ kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
address |
ที่อยู่ตามถนนในรูปแบบที่อยู่ทางไปรษณีย์ |
addressQuery |
ที่อยู่ที่จัดรูปแบบเป็นบรรทัดเดียว |
SearchDestinationsRequest.LocationQuery
คำค้นหาสถานที่เพื่อระบุจุดหมายหลักที่อยู่ใกล้เคียง
หมายเหตุ: หากการค้นหาสถานที่อยู่ภายในอาคารที่มีสถานที่ย่อย สถานที่หลักที่แสดงอาจเป็นสถานที่ย่อย ในกรณีเหล่านี้ ช่อง containingPlaces จะรวมอาคารไว้ด้วย
| การแสดง JSON |
|---|
{ "placeFilter": { object ( |
| ฟิลด์ | |
|---|---|
placeFilter |
ไม่บังคับ ตัวกรองที่จะใช้กับปลายทางที่เป็นไปได้ |
ฟิลด์ Union kind คำค้นหาสถานที่ kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
location |
ตำแหน่ง LatLng ที่แน่นอน |
SearchDestinationsRequest.LocationQuery.PlaceFilter
ตัวกรองที่จะใช้กับผู้สมัครรับตำแหน่งปลายทาง
| การแสดง JSON |
|---|
{ "structureType": enum ( |
| ฟิลด์ | |
|---|---|
structureType |
ไม่บังคับ หากระบุไว้ ระบบจะรับประกันว่าปลายทางทั้งหมดจะมีสถานที่หลักที่มีประเภทโครงสร้างนี้ ซึ่งอาจส่งผลให้มีการกรองปลายทางบางแห่งออก หรือทำให้ปลายทางที่แสดงผลมีความละเอียดน้อยลง/มากขึ้น เช่น หากระบุ การใช้งานอีกอย่างหนึ่งของช่องนี้คือการแยกรูปหลายเหลี่ยมที่แสดงอาคารได้ง่ายขึ้น เช่น หากระบุ |
addressability |
ไม่บังคับ หากระบุไว้ จะแสดงเฉพาะปลายทางที่ตรงตามเกณฑ์การกำหนดเป้าหมายที่เกี่ยวข้อง |
PlaceView.StructureType
ประเภทของโครงสร้างที่สถานที่นี้แสดง
| Enum | |
|---|---|
STRUCTURE_TYPE_UNSPECIFIED |
ไม่ได้ใช้ |
POINT |
ตำแหน่งจุด |
SECTION |
ส่วนย่อยของอาคาร |
BUILDING |
อาคาร |
GROUNDS |
พื้นที่ขนาดใหญ่ที่มักมีอาคารหลายหลัง เช่น วิทยาเขตของมหาวิทยาลัย อพาร์ตเมนต์คอมเพล็กซ์ หรือศูนย์การค้า |
SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability
กำหนดตัวเลือกสำหรับการกรองการกำหนดเป้าหมาย ทั้งนี้ อาจมีการเพิ่มค่าใหม่ในอนาคต
| Enum | |
|---|---|
ADDRESSABILITY_UNSPECIFIED |
เมื่อไม่ได้ระบุ บริการจะเลือกค่าเริ่มต้นที่เหมาะสม |
ANY |
ความสามารถในการระบุตัวตนไม่ใช่เกณฑ์การกรอง ระบบจะแสดงผลปลายทางโดยไม่คำนึงถึงความสามารถในการระบุที่อยู่ |
PRIMARY |
จุดหมายทั้งหมดที่แสดงผลจะมีสถานที่หลักพร้อมที่อยู่หรือชื่อระดับถนน |
WEAK |
ปลายทางทั้งหมดที่แสดงจะมีสถานที่หลักหรือปลายทางย่อยที่มีที่อยู่หรือชื่อระดับถนน |
ปลายทาง
ปลายทาง ซึ่งรวมถึงสถานที่หลัก สถานที่ที่เกี่ยวข้อง ทางเข้า และจุดนำทาง
| การแสดง JSON |
|---|
{ "primary": { object ( |
| ช่อง | |
|---|---|
primary |
สถานที่หลักที่ระบุโดย |
containingPlaces[] |
สถานที่ที่มีความแม่นยำน้อยกว่าซึ่งมีสถานที่หลักอยู่ เช่น อาคารอพาร์ตเมนต์ที่มีอาคารนี้อยู่ |
subDestinations[] |
จุดหมายย่อยที่แม่นยำยิ่งขึ้นของสถานที่หลัก เช่น ยูนิตที่อยู่ในอาคาร หมายเหตุ: รายการจุดหมายย่อยนี้ครอบคลุมมากกว่าSubDestinationที่ Places API แสดงผล และจุดหมายย่อยแต่ละรายการมีข้อมูลมากกว่า |
landmarks[] |
จุดสังเกตที่ใช้สื่อสารได้ว่าจุดหมายอยู่ที่ใดหรือช่วยในการเดินทางไปถึง |
entrances[] |
ทางเข้าสำหรับจุดหมายนี้ |
navigationPoints[] |
จุดนำทางสำหรับปลายทางนี้ |
parkingOptions |
ตัวเลือกที่จอดรถสำหรับจุดหมายนี้ |
arrivalSummary |
ข้อมูลสรุปเกี่ยวกับประสบการณ์การเดินทางมาถึงที่จุดหมายที่ AI สร้างขึ้น |
PlaceView
แสดงมุมมองของ Place ใน Places API นอกจากนี้ ยังให้ข้อมูลเพิ่มเติมที่เฉพาะเจาะจงสำหรับจุดหมาย เช่น ประเภทโครงสร้างและรูปหลายเหลี่ยมที่แสดง
ในบางกรณี PlaceView ที่มีรหัสสถานที่เดียวกันอาจแตกต่างจากสิ่งที่ Places API แสดงผลสำหรับช่อง types และ displayName
| การแสดง JSON |
|---|
{ "place": string, "displayName": { object ( |
| ช่อง | |
|---|---|
place |
ชื่อทรัพยากรของสถานที่นี้ในรูปแบบ |
placeId |
ตัวระบุที่ไม่ซ้ำกันของสถานที่ |
displayName |
คำอธิบายสถานที่ที่มนุษย์อ่านได้ เช่น "ประตู B", "McDonalds" |
primaryType |
ประเภทสถานที่หลักของสถานที่นี้ ดูรายการค่าที่เป็นไปได้ที่ https://developers.google.com/maps/documentation/places/web-service/place-types หมายเหตุ: ช่องนี้ไม่ได้มีข้อมูลอยู่เสมอ เตรียมพร้อมที่จะใช้ช่อง |
types[] |
ประเภทสถานที่ที่เกี่ยวข้องทั้งหมดของสถานที่นี้ ดูรายการค่าที่เป็นไปได้ได้ที่ https://developers.google.com/maps/documentation/places/web-service/place-types |
formattedAddress |
ที่อยู่แบบบรรทัดเดียว |
postalAddress |
ที่อยู่ที่มีโครงสร้าง |
structureType |
ประเภทโครงสร้างที่สอดคล้องกับสถานที่นี้ |
location |
สถานที่ตั้งของสถานที่นี้ สำหรับสถานที่ที่มีรูปหลายเหลี่ยมที่แสดงผล จุดนี้อาจเป็นจุดที่เหมาะสำหรับการวางเครื่องหมายบนแผนที่ |
displayPolygon |
เส้นขอบรูปหลายเหลี่ยมของสถานที่ในรูปแบบ GeoJSON โดยใช้รูปแบบ RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 หมายเหตุ: รูปแบบ RFC 7946 รองรับ MultiPolygons ดังนั้นออบเจ็กต์ |
addressComponents[] |
คอมโพเนนต์ที่ซ้ำกันสำหรับระดับสถานที่แต่ละระดับ |
PlaceView.AddressComponent
องค์ประกอบที่มีโครงสร้างซึ่งประกอบกันเป็นที่อยู่ที่จัดรูปแบบแล้ว หากมีข้อมูลนี้
| การแสดง JSON |
|---|
{ "longText": string, "shortText": string, "types": [ string ], "languageCode": string } |
| ช่อง | |
|---|---|
longText |
คำอธิบายแบบข้อความเต็มหรือชื่อของคอมโพเนนต์ที่อยู่ ตัวอย่างเช่น องค์ประกอบที่อยู่ของประเทศออสเตรเลียอาจมีชื่อแบบยาวเป็น "ออสเตรเลีย" |
shortText |
ชื่อแบบย่อของคอมโพเนนต์ที่อยู่ (หากมี) เช่น คอมโพเนนต์ที่อยู่สำหรับประเทศออสเตรเลียอาจมีชื่อย่อเป็น "AU" |
types[] |
อาร์เรย์ที่ระบุประเภทขององค์ประกอบที่อยู่ ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types |
languageCode |
ภาษาที่ใช้จัดรูปแบบคอมโพเนนต์นี้ในรูปแบบ CLDR |
สถานที่สำคัญ
ระบบจะใช้จุดสังเกตเพื่อสื่อสารว่าจุดหมายปลายทางอยู่ที่ใดหรือช่วยให้คุณไปถึงจุดหมายปลายทาง
| การแสดง JSON |
|---|
{ "relationalDescription": { object ( |
| ช่อง | |
|---|---|
relationalDescription |
คำอธิบายที่มนุษย์อ่านได้ว่าจุดหมายเกี่ยวข้องกับสถานที่สำคัญอย่างไร เช่น "ใกล้ตึกเอ็มไพร์สเตต" หรือ "ตรงข้ามทำเนียบขาว" |
tags[] |
แท็กที่อธิบายวิธีใช้จุดสังเกตในบริบทของจุดหมาย |
straightLineDistanceMeters |
เอาต์พุตเท่านั้น ระยะทางแบบเส้นตรงจากจุดสังเกตนี้ไปยังจุดหมายปลายทางเป็นเมตร |
travelDistanceMeters |
เอาต์พุตเท่านั้น ระยะทางเดินจากสถานที่สำคัญนี้ไปยังจุดหมายเป็นเมตร |
ฟิลด์ Union landmark จุดสังเกต landmark ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
place |
สถานที่ที่แสดงถึงจุดสังเกตนี้ |
Landmark.Tag
รายการแท็กทั้งหมดที่เป็นไปได้ซึ่งอธิบายวิธีใช้สถานที่สำคัญในบริบทของจุดหมาย
หากที่อยู่มีทั้งแท็ก ADDRESS และ ARRIVAL แสดงว่าสถานที่สำคัญนั้นโดดเด่นในพื้นที่และอยู่ใกล้กับจุดหมาย
| Enum | |
|---|---|
TAG_UNSPECIFIED |
ไม่ได้ใช้ |
ADDRESS |
สถานที่ที่โดดเด่นในท้องถิ่นซึ่งใช้ระบุตำแหน่งทั่วไปของจุดหมายได้ โดยปกติจะอยู่ห่างจากจุดหมายไม่กี่ร้อยเมตร ซึ่งคล้ายกับสถานที่สำคัญที่ฟีเจอร์ตัวอธิบายที่อยู่ของ Geocoding API แสดงผล: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors |
ARRIVAL |
สถานที่ที่ใช้เพื่อช่วยให้ไปถึงจุดหมายได้ มีประโยชน์สำหรับการนำทางเมื่อคุณอยู่ใกล้จุดหมาย เช่น จุดสังเกตนี้อาจเป็นสถานที่ที่อยู่ฝั่งตรงข้ามถนนจากจุดหมาย จุดสังเกตที่มีแท็กนี้มักจะอยู่ใกล้กับจุดหมายมากกว่าจุดสังเกตที่มีแท็ก ADDRESS |
ทางเข้า
ทางเข้าคือคู่พิกัดละติจูด/ลองจิจูดเดียวที่กำหนดตำแหน่งของจุดเข้าและออกของสถานที่
| การแสดง JSON |
|---|
{ "location": { object ( |
| ช่อง | |
|---|---|
location |
ตำแหน่งของทางเข้า |
tags[] |
รายการแท็กที่อธิบายทางเข้า |
place |
โครงสร้างที่ทางเข้านี้ตั้งอยู่จริงในรูปแบบ |
streetViewThumbnail |
ภาพขนาดย่อของ Street View ที่แสดงทางเข้า คุณขอรูปภาพได้จาก Street View Static API ดู https://developers.google.com/maps/documentation/streetview/request-streetview |
streetViewAnnotation |
คำอธิบายประกอบของทางเข้าใน |
Entrance.Tag
ลักษณะที่อธิบายทางเข้า
| Enum | |
|---|---|
TAG_UNSPECIFIED |
ไม่ได้ใช้ |
PREFERRED |
ทางเข้ามักจะให้สิทธิ์เข้าถึงสถานที่หลักในปลายทางที่แสดง สถานที่อาจมีทางเข้าที่แนะนำหลายแห่ง หากทางเข้าไม่มีแท็กนี้ แสดงว่าทางเข้าอยู่ในอาคารเดียวกับสถานที่หลัก แต่ไม่ได้หมายความว่าทางเข้าจะให้สิทธิ์เข้าถึงสถานที่นั้น ตัวอย่างเช่น หากสถานที่หลักเป็นร้านอาหารในศูนย์การค้า ทางเข้า "ที่ต้องการ" จะเป็นทางเข้าที่น่าจะนำไปสู่ร้านอาหารนั้นๆ ส่วนทางเข้าอื่นๆ ที่แสดงผลจะเป็นทางเข้าอื่นๆ ของอาคาร เช่น ทางเข้าของร้านอาหารอื่นๆ ในศูนย์การค้า หากสถานที่หลักคือตัวอาคาร หมายเหตุ: |
StreetViewThumbnail
พารามิเตอร์สำหรับการแสดงภาพขนาดย่อของ Google Street View พารามิเตอร์เหล่านี้ใช้เพื่อขอรูปภาพ Street View จาก Street View Static API ได้ ดู https://developers.google.com/maps/documentation/streetview/request-streetview
| การแสดง JSON |
|---|
{ "pano": string, "widthPx": integer, "heightPx": integer, "headingDegree": number, "pitchDegree": number, "fovDegree": number } |
| ช่อง | |
|---|---|
pano |
รหัสพาโนรามาที่เฉพาะเจาะจง |
widthPx |
ความกว้างของภาพขนาดย่อเอาต์พุตเป็นพิกเซล หมายเหตุ: เมื่อขอคำอธิบายประกอบพร้อมกับภาพปก คุณต้องใช้ค่าความสูงและความกว้างเหล่านี้ในคำขอ Street View API เพื่อให้แน่ใจว่าพิกัดของคำอธิบายประกอบสอดคล้องกับรูปภาพอย่างถูกต้อง |
heightPx |
ความสูงของภาพปกเอาต์พุตในหน่วยพิกเซล หมายเหตุ: เมื่อขอคำอธิบายประกอบพร้อมกับภาพปก คุณต้องใช้ค่าความสูงและความกว้างเหล่านี้ในคำขอ Street View API เพื่อให้แน่ใจว่าพิกัดของคำอธิบายประกอบสอดคล้องกับรูปภาพอย่างถูกต้อง |
headingDegree |
การวางแนวนอนของกล้องในหน่วยองศา ช่วง [0, 360) 0 หมายถึงทิศเหนือ และ 90 หมายถึงทิศตะวันออก |
pitchDegree |
การวางแนวตั้งของกล้องเป็นองศา ช่วง [-90, 90] 0 คือเส้นขอบฟ้า +90 คือตรงขึ้นไป -90 คือตรงลงไป |
fovDegree |
ขอบเขตการมองเห็นแนวนอนเป็นองศา ช่วง (0, 180] ควบคุมระดับการซูม FOV ที่เล็กลงหมายถึงการซูมที่มากขึ้น |
ImageAnnotation
คำอธิบายประกอบในรูปภาพขนาดย่อ เช่น รูปหลายเหลี่ยมที่ร่างทางเข้า
| การแสดง JSON |
|---|
{
"coordinates": [
{
object ( |
| ช่อง | |
|---|---|
coordinates[] |
รายการพิกัดที่สร้างรูปหลายเหลี่ยมบนรูปภาพ โดยพิกัดจะเรียงตามลำดับทวนเข็มนาฬิกา |
ImageAnnotation.Coordinate
พิกัดพิกเซลของจุดบนรูปภาพ จุดเริ่มต้น (0,0) คือมุมซ้ายบนของพิกเซลซ้ายบนของรูปภาพ โดยแกน x ชี้ไปทางขวาและแกน y ชี้ลง
| การแสดง JSON |
|---|
{ "xPx": number, "yPx": number } |
| ช่อง | |
|---|---|
xPx |
พิกัด X |
yPx |
พิกัด Y |
Destination.ParkingOptions
ข้อมูลเกี่ยวกับตัวเลือกที่จอดรถสำหรับจุดหมายปลายทาง
| การแสดง JSON |
|---|
{
"availability": enum ( |
| ช่อง | |
|---|---|
availability |
ความพร้อมให้บริการที่จอดรถสำหรับจุดหมายนี้ |
onsiteParking |
มีที่จอดรถให้บริการที่จุดหมาย |
freeParkingLot |
มีที่จอดรถฟรี |
paidParkingLot |
มีที่จอดรถแบบเสียเงิน |
freeStreetParking |
มีที่จอดรถริมถนนแบบไม่เสียค่าใช้จ่าย |
paidStreetParking |
มีที่จอดรถริมถนนแบบเสียค่าใช้จ่าย |
valetParking |
มีบริการนำรถไปจอดให้ |
freeGarageParking |
มีโรงจอดรถแบบไม่เสียค่าใช้จ่าย |
paidGarageParking |
มีโรงจอดรถแบบเสียค่าใช้จ่าย |
Destination.ParkingOptions.Availability
การวัดผลแบบรวมว่าการหาที่จอดรถเมื่อไปสถานที่นี้ยากเพียงใด
ทั้งนี้ อาจมีการเพิ่มค่าใหม่ในอนาคต
| Enum | |
|---|---|
AVAILABILITY_UNSPECIFIED |
ไม่มีข้อมูลว่ามีที่จอดรถหรือไม่ |
PLENTY |
มีที่จอดรถให้บริการจำนวนมาก |
SOMEWHAT_DIFFICULT |
หาที่จอดรถค่อนข้างยาก |
DIFFICULT |
หาที่จอดรถยากมาก |
Destination.ArrivalSummary
ข้อมูลสรุปที่ AI สร้างขึ้นเกี่ยวกับประสบการณ์การเดินทางมาถึงจุดหมาย
| การแสดง JSON |
|---|
{ "text": { object ( |
| ช่อง | |
|---|---|
text |
สรุปประสบการณ์การเดินทางมาถึงที่จุดหมาย |
flagContentUrl |
ลิงก์ที่ผู้ใช้สามารถแจ้งปัญหาเกี่ยวกับข้อมูลสรุป |
disclosureText |
เอาต์พุตเท่านั้น มีข้อความการเปิดเผยข้อมูลสำหรับข้อมูลสรุปการมาถึง |