รายละเอียดสถานที่ (ใหม่)

เลือกแพลตฟอร์ม: Android iOS JavaScript เว็บเซอร์วิส

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

คุณรับรหัสสถานที่ได้หลายวิธี คุณสามารถใช้สิ่งต่อไปนี้ได้

เครื่องมือสํารวจ 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 หรือใช้ส่วนหัว HTTP X-Goog-FieldMask ไม่มีการระบุรายการช่องที่แสดงผลเริ่มต้นในการตอบกลับ หากคุณละเว้นมาสก์ช่อง เมธอดจะแสดงข้อผิดพลาด

    การมาสก์ช่องเป็นแนวทางปฏิบัติในการออกแบบที่ดีเพื่อให้แน่ใจว่าคุณไม่ได้ขอข้อมูลที่ไม่จำเป็น ซึ่งช่วยหลีกเลี่ยงเวลาในการประมวลผลและการเรียกเก็บเงินที่ไม่จำเป็น

    ระบุรายการประเภทข้อมูลสถานที่ที่คั่นด้วยคอมมาเพื่อแสดงผล เช่น ดึงข้อมูลชื่อที่แสดงและที่อยู่ของสถานที่

    X-Goog-FieldMask: displayName,formattedAddress

    ใช้ * เพื่อเรียกข้อมูลทุกช่อง

    X-Goog-FieldMask: *

    ระบุฟิลด์ต่อไปนี้อย่างน้อย 1 ฟิลด์

    • ช่องต่อไปนี้จะทริกเกอร์ SKU รายละเอียดสถานที่ (รหัสเท่านั้น)

      attributions, id, name*, photos

      * ช่อง name มีชื่อทรัพยากรสถานที่ในรูปแบบ places/PLACE_ID ใช้ displayName เพื่อเข้าถึงชื่อข้อความของสถานที่

    • ช่องต่อไปนี้จะเรียกใช้ SKU รายละเอียดสถานที่ (สถานที่ตั้งเท่านั้น)

      addressComponents, adrFormatAddress, formattedAddress, location, plusCode, shortFormattedAddress, types, viewport

    • ฟิลด์ต่อไปนี้จะทริกเกอร์ SKU รายละเอียดสถานที่ (พื้นฐาน)

      accessibilityOptions, businessStatus, containingPlaces, displayName, googleMapsLinks*, googleMapsUri, iconBackgroundColor, iconMaskBaseUri, primaryType, primaryTypeDisplayName, pureServiceAreaBusiness, subDestinations, utcOffsetMinutes

      * ช่อง googleMapsLinks อยู่ในช่วงเวอร์ชันตัวอย่างก่อน GA และไม่มีการเรียกเก็บเงิน ซึ่งหมายความว่าการเรียกเก็บเงินคือ 0 บาทสำหรับการใช้งานในช่วงเวอร์ชันตัวอย่าง

    • ฟิลด์ต่อไปนี้จะทริกเกอร์ SKU รายละเอียดสถานที่ (ขั้นสูง)

      currentOpeningHours, currentSecondaryOpeningHours, internationalPhoneNumber, nationalPhoneNumber, priceLevel, priceRange, rating, regularOpeningHours, regularSecondaryOpeningHours, userRatingCount, websiteUri

    • ฟิลด์ต่อไปนี้จะทริกเกอร์ Place Details (Preferred) SKU

      allowsDogs, curbsidePickup, delivery, dineIn, editorialSummary, evChargeOptions, fuelOptions, goodForChildren, goodForGroups, goodForWatchingSports, liveMusic, menuForChildren, parkingOptions, paymentOptions, outdoorSeating, reservable, restroom, reviews, routingSummaries,* servesBeer, servesBreakfast, servesBrunch, servesCocktails, servesCoffee, servesDessert, servesDinner, servesLunch, servesVegetarianFood, servesWine, takeout

      * การค้นหาข้อความและการค้นหาในพื้นที่เท่านั้น

  • placeId

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

    สตริง places/PLACE_ID เรียกอีกอย่างว่าชื่อทรัพยากร ในการตอบกลับคำขอรายละเอียดสถานที่ (ใหม่), การค้นหาใกล้เคียง (ใหม่) และการค้นหาข้อความ (ใหม่) สตริงนี้จะอยู่ในช่อง name ของการตอบกลับ รหัสสถานที่แบบสแตนด์อโลนจะอยู่ในฟิลด์ id ของคำตอบ

พารามิเตอร์ที่ไม่บังคับ

  • languageCode

    ภาษาที่จะแสดงผลลัพธ์

    • ดู รายการภาษาที่รองรับ Google อัปเดตภาษาที่รองรับอยู่บ่อยครั้ง รายการนี้จึงอาจไม่ครอบคลุมทั้งหมด
    • หากไม่ได้ระบุ languageCode ค่าเริ่มต้นของ API จะเป็น en หากคุณระบุรหัสภาษาที่ไม่ถูกต้อง API จะแสดงข้อผิดพลาด INVALID_ARGUMENT
    • API จะพยายามอย่างเต็มที่เพื่อให้ที่อยู่ซึ่งอ่านได้ทั้งผู้ใช้และคนในพื้นที่ โดยจะแสดงผลที่อยู่เป็นภาษาท้องถิ่น ถอดเสียงเป็นอักษรที่ผู้ใช้อ่านได้ (หากจำเป็น) โดยคำนึงถึงภาษาที่ต้องการ ส่วนที่อยู่อื่นๆ ทั้งหมดจะแสดงผลในภาษาที่ต้องการ ระบบจะแสดงองค์ประกอบที่อยู่ทั้งหมดเป็นภาษาเดียวกัน ซึ่งเลือกจากคอมโพเนนต์แรก
    • หากชื่อไม่พร้อมใช้งานในภาษาที่ต้องการ API จะใช้ชื่อที่ตรงกันมากที่สุด
    • ภาษาที่ต้องการมีอิทธิพลเพียงเล็กน้อยต่อชุดผลลัพธ์ที่ API เลือกแสดงและลําดับที่แสดงผล โปรแกรมแปลพิกัดภูมิศาสตร์จะตีความตัวย่อแตกต่างกันไปตามภาษา เช่น ตัวย่อสำหรับประเภทถนน หรือคำพ้องความหมายที่อาจใช้ได้ในภาษาหนึ่งแต่ใช้ไม่ได้ในอีกภาษาหนึ่ง

  • 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"
  }
}

ลองใช้งาน

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

วิธีส่งคำขอ

  1. เลือกไอคอน API ขยายโปรแกรมสำรวจ API ที่ด้านขวาของหน้า
  2. ตั้งค่าพารามิเตอร์ name เป็นค่าต่อไปนี้ (ไม่บังคับ) 
    places/PLACE_ID
  3. (ไม่บังคับ) ขยายแสดงพารามิเตอร์มาตรฐาน แล้วตั้งค่าพารามิเตอร์ fields เป็นมาสก์ฟิลด์
  4. เลือกปุ่มดำเนินการ ในป๊อปอัป ให้เลือกบัญชีที่ต้องการใช้ส่งคําขอ

  5. ในแผงโปรแกรมสำรวจ API ให้เลือกไอคอนขยาย ขยายโปรแกรมสำรวจ API เพื่อขยายหน้าต่างโปรแกรมสำรวจ API