บทนำ
เมื่อมีรหัสสถานที่แล้ว คุณจะ ขอรายละเอียดเพิ่มเติมเกี่ยวกับสถานประกอบการหรือ จุดที่น่าสนใจที่เฉพาะเจาะจงได้โดยการเริ่มคำขอ รายละเอียดสถานที่ (ใหม่) คำขอรายละเอียดสถานที่ (ใหม่) จะแสดงข้อมูลที่ครอบคลุมมากขึ้นเกี่ยวกับสถานที่ที่ระบุ เช่น ที่อยู่แบบเต็ม หมายเลขโทรศัพท์ คะแนนและรีวิวของผู้ใช้
คุณรับรหัสสถานที่ได้หลายวิธี โดยคุณสามารถใช้สิ่งต่อไปนี้ได้
- การค้นหาข้อความ (ใหม่) หรือ การค้นหาในบริเวณใกล้เคียง (ใหม่)
- Geocoding API
- Routes API
- Address Validation API
- เติมข้อความอัตโนมัติ (ใหม่)
โปรแกรมสำรวจ API ช่วยให้คุณส่งคำขอแบบเรียลไทม์เพื่อให้คุ้นเคยกับ API และตัวเลือก API ดังนี้
คำขอรายละเอียดสถานที่ (ใหม่)
คำขอรายละเอียดสถานที่ (ใหม่) คือคำขอ HTTP GET ในรูปแบบต่อไปนี้
https://places.googleapis.com/v1/places/PLACE_ID
ส่งพารามิเตอร์ทั้งหมดเป็นพารามิเตอร์ URL หรือในส่วนหัวเป็นส่วนหนึ่งของคำขอ GET เช่น
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=API_KEY
หรือในคำสั่ง curl
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
คำตอบของรายละเอียดสถานที่ (ใหม่)
รายละเอียดสถานที่ (ใหม่) จะแสดงผลเป็น ออบเจ็กต์ JSON เป็นการตอบกลับ ในการตอบกลับ
- การตอบกลับจะแสดงด้วยออบเจ็กต์
Place
ออบเจ็กต์Place
มีข้อมูลโดยละเอียดเกี่ยวกับ สถานที่ - FieldMask ที่ส่งในคำขอจะระบุรายการฟิลด์
ที่แสดงผลในออบเจ็กต์
Place
ออบเจ็กต์ JSON ที่สมบูรณ์อยู่ในรูปแบบต่อไปนี้
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "displayName": { "text": "Trinidad" } ... }
พารามิเตอร์ที่จำเป็น
-
FieldMask
ระบุรายการช่องที่จะแสดงผลในการตอบกลับโดยการสร้างมาสก์ของช่องการตอบกลับ ส่งมาสก์ฟิลด์การตอบกลับไปยังเมธอดโดยใช้พารามิเตอร์ URL
$fields
หรือfields
หรือโดยใช้ส่วนหัว HTTPX-Goog-FieldMask
ไม่มีรายการฟิลด์ที่ส่งคืนเริ่มต้นในการตอบกลับ หากคุณละเว้นมาสก์ของฟิลด์ เมธอดจะแสดงข้อผิดพลาดการมาสก์ฟิลด์เป็นแนวทางปฏิบัติในการออกแบบที่ดีเพื่อให้มั่นใจว่าคุณจะไม่ขอข้อมูลที่ไม่จำเป็น ซึ่งจะช่วยหลีกเลี่ยงเวลาในการประมวลผลและการเรียกเก็บเงินที่ไม่จำเป็น
ระบุรายการประเภทข้อมูลสถานที่ที่คั่นด้วยคอมมาเพื่อส่งคืน เช่น เพื่อดึงชื่อที่แสดงและที่อยู่ของสถานที่
X-Goog-FieldMask: displayName,formattedAddress
ใช้
*
เพื่อดึงข้อมูลทุกช่องX-Goog-FieldMask: *
ระบุช่องต่อไปนี้อย่างน้อย 1 ช่อง
ฟิลด์ต่อไปนี้จะทริกเกอร์ SKU ที่มีเฉพาะรหัสข้อมูลสำคัญของรายละเอียดสถานที่
attributions
id
name
*
photos
* ฟิลด์
name
มีชื่อทรัพยากรของสถานที่ ในรูปแบบplaces/PLACE_ID
หากต้องการรับชื่อข้อความของสถานที่ ให้ขอฟิลด์displayName
ใน Pro SKUฟิลด์ต่อไปนี้จะทริกเกอร์ SKU ของรายละเอียดสถานที่ที่จำเป็น
addressComponents
addressDescriptor
*
adrFormatAddress
formattedAddress
location
plusCode
postalAddress
shortFormattedAddress
types
viewport
* ตัวอธิบายที่อยู่โดยทั่วไปพร้อมให้บริการแก่ลูกค้าในอินเดียและเป็นเวอร์ชันทดลองในประเทศอื่นๆฟิลด์ต่อไปนี้จะทริกเกอร์ Place Details Pro SKU
accessibilityOptions
businessStatus
containingPlaces
displayName
googleMapsLinks
googleMapsUri
iconBackgroundColor
iconMaskBaseUri
primaryType
primaryTypeDisplayName
pureServiceAreaBusiness
subDestinations
utcOffsetMinutes
ฟิลด์ต่อไปนี้จะทริกเกอร์ SKU ของรายละเอียดสถานที่สำหรับองค์กร
currentOpeningHours
currentSecondaryOpeningHours
internationalPhoneNumber
nationalPhoneNumber
priceLevel
priceRange
rating
regularOpeningHours
regularSecondaryOpeningHours
userRatingCount
websiteUri
ฟิลด์ต่อไปนี้จะทริกเกอร์ SKU รายละเอียดสถานที่ Enterprise + Atmosphere
allowsDogs
curbsidePickup
delivery
dineIn
editorialSummary
evChargeAmenitySummary
evChargeOptions
fuelOptions
generativeSummary
goodForChildren
goodForGroups
goodForWatchingSports
liveMusic
menuForChildren
neighborhoodSummary
parkingOptions
paymentOptions
outdoorSeating
reservable
restroom
reviews
reviewSummary
routingSummaries
*
servesBeer
servesBreakfast
servesBrunch
servesCocktails
servesCoffee
servesDessert
servesDinner
servesLunch
servesVegetarianFood
servesWine
takeout
* การค้นหาข้อความและการค้นหาในบริเวณใกล้เคียงเท่านั้น
-
placeId
ตัวระบุข้อความที่ระบุค่าเฉพาะของสถานที่ ซึ่งได้จาก การค้นหาข้อความ (ใหม่) หรือ การค้นหาใกล้เคียง (ใหม่) ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานที่ได้ที่ ภาพรวมของรหัสสถานที่
สตริง
places/PLACE_ID
เรียกอีกอย่างว่าชื่อทรัพยากรของสถานที่ ในการตอบกลับจากคำขอ Place Details (ใหม่), Nearby Search (ใหม่) และ Text Search (ใหม่) สตริงนี้จะอยู่ในฟิลด์name
ของการตอบกลับ รหัสสถานที่แบบสแตนด์อโลน อยู่ในฟิลด์id
ของการตอบกลับ
พารามิเตอร์ที่ไม่บังคับ
languageCode
ภาษาที่จะแสดงผลลัพธ์
- ดู รายการภาษาที่รองรับ Google มักจะอัปเดต ภาษาที่รองรับอยู่เสมอ ดังนั้นรายการนี้จึงอาจไม่ครอบคลุมทั้งหมด
-
หากไม่ได้ระบุ
languageCode
API จะใช้en
เป็นค่าเริ่มต้น หาก คุณระบุรหัสภาษาที่ไม่ถูกต้อง API จะแสดงข้อผิดพลาดINVALID_ARGUMENT
- API จะพยายามอย่างเต็มที่เพื่อให้ที่อยู่แบบถนนที่อ่านได้สำหรับทั้งผู้ใช้และคนในพื้นที่ เพื่อให้บรรลุเป้าหมายดังกล่าว ระบบจะแสดงที่อยู่ ในภาษาท้องถิ่น โดยแปลงเป็นสคริปต์ที่ผู้ใช้อ่านได้หากจำเป็น ตามภาษาที่ต้องการ ส่วนที่อยู่อื่นๆ จะแสดงในภาษาที่ต้องการ คอมโพเนนต์ของที่อยู่ ทั้งหมดจะแสดงในภาษาเดียวกัน ซึ่งเลือกจากคอมโพเนนต์แรก
- หากชื่อไม่มีให้บริการในภาษาที่ต้องการ API จะใช้ชื่อที่ ใกล้เคียงที่สุด
- ภาษาที่ต้องการมีผลเล็กน้อยต่อชุดผลลัพธ์ที่ API เลือกที่จะแสดงผล และลำดับที่แสดงผล Geocoder จะตีความตัวย่อแตกต่างกันไปตามภาษา เช่น ตัวย่อของประเภทถนน หรือคำพ้องความหมายที่อาจ ใช้ได้ในภาษาหนึ่งแต่ใช้ไม่ได้ในอีกภาษาหนึ่ง
regionCode
รหัสภูมิภาคที่ใช้จัดรูปแบบการตอบกลับ โดยระบุเป็นค่า รหัส CLDR 2 อักขระ ไม่มีค่าเริ่มต้น
หากชื่อประเทศของฟิลด์
formattedAddress
ในการตอบกลับตรงกับregionCode
ระบบจะไม่แสดงรหัสประเทศในformattedAddress
พารามิเตอร์นี้จะไม่มีผลกับadrFormatAddress
ซึ่งจะมีชื่อประเทศอยู่เสมอ หรือกับshortFormattedAddress
ซึ่งจะไม่มีชื่อประเทศอยู่เลยรหัส CLDR ส่วนใหญ่จะเหมือนกับรหัส ISO 3166-1 โดยมีข้อยกเว้นที่สำคัญบางประการ ตัวอย่างเช่น ccTLD ของสหราชอาณาจักรคือ "uk" (.co.uk) ขณะที่รหัส ISO 3166-1 คือ "gb" (ในทางเทคนิคสำหรับ นิติบุคคลของ "สหราชอาณาจักรบริเตนใหญ่และไอร์แลนด์เหนือ") พารามิเตอร์นี้อาจส่งผลต่อผลลัพธ์ตามกฎหมายที่เกี่ยวข้อง
-
sessionToken
โทเค็นเซสชันคือสตริงที่ผู้ใช้สร้างขึ้นซึ่งติดตามการเรียกใช้การเติมข้อความอัตโนมัติ (ใหม่) เป็น "เซสชัน" ฟีเจอร์เติมข้อความอัตโนมัติ (ใหม่) ใช้โทเค็นเซสชันเพื่อ จัดกลุ่มการค้นหาและวางระยะการเลือกของการค้นหาการเติมข้อความอัตโนมัติของผู้ใช้ลงในเซสชันที่ไม่ต่อเนื่อง เพื่อวัตถุประสงค์ในการเรียกเก็บเงิน ระบบจะส่งโทเค็นเซสชันไปยังการเรียกรายละเอียดสถานที่ (ใหม่) ที่ตามหลังการเรียกการเติมข้อความอัตโนมัติ (ใหม่) ดูข้อมูลเพิ่มเติมได้ที่ โทเค็นเซสชัน
ตัวอย่างรายละเอียดสถานที่ (ใหม่)
ตัวอย่างต่อไปนี้จะขอรายละเอียดของสถานที่โดยใช้
placeId
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
โปรดทราบว่าส่วนหัว X-Goog-FieldMask
ระบุว่าการตอบกลับ
มีช่องข้อมูลต่อไปนี้ id,displayName
จากนั้นคำตอบจะอยู่ในรูปแบบต่อไปนี้
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "displayName": { "text": "Googleplex", "languageCode": "en" } }
เพิ่มประเภทข้อมูลลงในมาสก์ฟิลด์เพื่อแสดงข้อมูลเพิ่มเติม
เช่น เพิ่ม formattedAddress,plusCode
เพื่อรวมที่อยู่และ Plus Code ในการตอบกลับ
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName,formattedAddress,plusCode" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
ตอนนี้คำตอบอยู่ในรูปแบบต่อไปนี้
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "formattedAddress": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA", "plusCode": { "globalCode": "849VCWC7+RW", "compoundCode": "CWC7+RW Mountain View, CA, USA" }, "displayName": { "text": "Googleplex", "languageCode": "en" } }
รับตัวอธิบายที่อยู่
ข้อบ่งชี้ที่อยู่จะให้ข้อมูลเชิงสัมพันธ์เกี่ยวกับตำแหน่งของสถานที่ ซึ่งรวมถึงสถานที่สำคัญและพื้นที่โดยรอบ
ตัวอย่างต่อไปนี้แสดงคำขอรายละเอียดสถานที่ (ใหม่) สำหรับห้างสรรพสินค้า
ในห้างสรรพสินค้าในซานโฮเซ ในตัวอย่างนี้ คุณจะใส่ addressDescriptors
ในมาสก์ฟิลด์
curl -X GET https://places.googleapis.com/v1/places/ChIJ8WvuSB7Lj4ARFyHppkxDRQ4 \ -H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: name,displayName,addressDescriptor"
การตอบกลับประกอบด้วยสถานที่ที่ระบุในคำขอ รายการสถานที่สำคัญใกล้เคียงและระยะห่างจากสถานที่นั้น รวมถึงรายการพื้นที่และความสัมพันธ์ในการบรรจุของพื้นที่กับสถานที่นั้น
{ "name": "places/ChIJ8WvuSB7Lj4ARFyHppkxDRQ4", "displayName": { "text": "Macy's", "languageCode": "en" }, "addressDescriptor": { "landmarks": [ { "name": "places/ChIJVVVVUB7Lj4ARXyb4HFVDV8s", "placeId": "ChIJVVVVUB7Lj4ARXyb4HFVDV8s", "displayName": { "text": "Westfield Valley Fair", "languageCode": "en" }, "types": [ "clothing_store", "department_store", "establishment", "food", "movie_theater", "point_of_interest", "restaurant", "shoe_store", "shopping_mall", "store" ], "spatialRelationship": "WITHIN", "straightLineDistanceMeters": 220.29175 }, { "name": "places/ChIJ62_oCR7Lj4AR_MGWkSPotD4", "placeId": "ChIJ62_oCR7Lj4AR_MGWkSPotD4", "displayName": { "text": "Nordstrom", "languageCode": "en" }, "types": [ "clothing_store", "department_store", "establishment", "point_of_interest", "shoe_store", "store" ], "straightLineDistanceMeters": 329.45178 }, { "name": "places/ChIJmx1c5x7Lj4ARJXJy_CU_JbE", "placeId": "ChIJmx1c5x7Lj4ARJXJy_CU_JbE", "displayName": { "text": "Monroe Parking Garage", "languageCode": "en" }, "types": [ "establishment", "parking", "point_of_interest" ], "straightLineDistanceMeters": 227.05153 }, { "name": "places/ChIJxcwBziHLj4ARUQLAvtzkRCM", "placeId": "ChIJxcwBziHLj4ARUQLAvtzkRCM", "displayName": { "text": "Studios Inn by Daiwa Living California Inc.", "languageCode": "en" }, "types": [ "establishment", "lodging", "point_of_interest", "real_estate_agency" ], "straightLineDistanceMeters": 299.9955 }, { "name": "places/ChIJWWIlNx7Lj4ARpe1E0ob-_GI", "placeId": "ChIJWWIlNx7Lj4ARpe1E0ob-_GI", "displayName": { "text": "Din Tai Fung", "languageCode": "en" }, "types": [ "establishment", "food", "point_of_interest", "restaurant" ], "straightLineDistanceMeters": 157.70943 } ], "areas": [ { "name": "places/ChIJb3F-EB7Lj4ARnHApQ_Hu1gI", "placeId": "ChIJb3F-EB7Lj4ARnHApQ_Hu1gI", "displayName": { "text": "Westfield Valley Fair", "languageCode": "en" }, "containment": "WITHIN" }, { "name": "places/ChIJXYuykB_Lj4AR1Ot8nU5q26Q", "placeId": "ChIJXYuykB_Lj4AR1Ot8nU5q26Q", "displayName": { "text": "Valley Fair", "languageCode": "en" }, "containment": "WITHIN" }, { "name": "places/ChIJtYoUX2DLj4ARKoKOb1G0CpM", "placeId": "ChIJtYoUX2DLj4ARKoKOb1G0CpM", "displayName": { "text": "Central San Jose", "languageCode": "en" }, "containment": "WITHIN" } ] } }
ลองใช้งาน
โปรแกรมสำรวจ API ช่วยให้คุณส่งคำขอตัวอย่างได้ เพื่อให้คุ้นเคยกับ API และตัวเลือก API
เลือกไอคอน API api ทางด้านขวาของหน้า
แก้ไขพารามิเตอร์คำขอ (ไม่บังคับ)
เลือกปุ่มดำเนินการ ในกล่องโต้ตอบ ให้เลือกบัญชี ที่ต้องการใช้เพื่อส่งคำขอ
ในแผงโปรแกรมสำรวจ API ให้เลือกไอคอนเต็มหน้าจอ fullscreen เพื่อขยายหน้าต่างโปรแกรมสำรวจ API