- คำขอ HTTP
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- PostalAddress
- LanguageOptions
- ValidationResult
- การตัดสิน
- รายละเอียด
- ที่อยู่
- AddressComponent
- ComponentName
- ConfirmationLevel
- รหัสพิกัดภูมิศาสตร์
- LatLng
- PlusCode
- วิวพอร์ต
- AddressMetadata
- UspsData
- UspsAddress
ตรวจสอบที่อยู่
คำขอ HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "address": { object ( |
ช่อง | |
---|---|
address |
ต้องระบุ ที่อยู่ที่กำลังตรวจสอบ ที่อยู่ที่ไม่ได้จัดรูปแบบควรส่งผ่าน ความยาวรวมของช่องต่างๆ ในอินพุตนี้ต้องไม่เกิน 280 อักขระ ดูภูมิภาคที่รองรับได้ที่นี่ ค่า Address Validation API จะไม่สนใจค่าใน |
previousResponseId |
ฟิลด์นี้ต้องว่างเปล่าสำหรับคำขอตรวจสอบที่อยู่รายการแรก หากต้องมีคำขอเพิ่มเติมเพื่อตรวจสอบที่อยู่เดียวโดยสมบูรณ์ (เช่น หากการเปลี่ยนแปลงที่ผู้ใช้ดำเนินการหลังจากการตรวจสอบความถูกต้องครั้งแรกต้องได้รับการตรวจสอบอีกครั้ง) คำขอติดตามผลแต่ละรายการจะต้องป้อนข้อมูลในช่องนี้ด้วย |
enableUspsCass |
เปิดใช้โหมดที่เข้ากันได้กับ USPS CASS การดำเนินการนี้จะส่งผลต่อช่อง ขอแนะนำให้ใช้ |
languageOptions |
ไม่บังคับ ตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจมีการรองรับอย่างจำกัด และการเปลี่ยนแปลงในผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจใช้ไม่ได้กับเวอร์ชันก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอื่นๆ ข้อเสนอก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปจะอยู่ภายใต้ข้อกำหนดเฉพาะของบริการ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ในคำอธิบายขั้นตอนการเปิดตัว เปิดใช้ Address Validation API เพื่อรวมข้อมูลเพิ่มเติมในการตอบกลับ |
sessionToken |
ไม่บังคับ สตริงที่ระบุเซสชันการเติมข้อความอัตโนมัติเพื่อจุดประสงค์ในการเรียกเก็บเงิน ต้องเป็นสตริง base64 สำหรับ URL และชื่อไฟล์ที่ปลอดภัยและมีอักขระ ASCII ไม่เกิน 36 ตัว มิฉะนั้น ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT เซสชันนี้จะเริ่มต้นเมื่อผู้ใช้ทำการค้นหาจากการเติมข้อความอัตโนมัติ และสรุปเมื่อผู้ใช้เลือกสถานที่และมีการเรียกรายละเอียดสถานที่หรือการตรวจสอบที่อยู่ แต่ละเซสชันสามารถใส่คำค้นหาอัตโนมัติได้หลายรายการ ตามด้วยรายละเอียดสถานที่หรือคำขอตรวจสอบที่อยู่ 1 รายการ ข้อมูลเข้าสู่ระบบที่ใช้สำหรับแต่ละคำขอภายในเซสชันต้องเป็นของโปรเจ็กต์ Google Cloud Console เดียวกัน เมื่อเซสชันสิ้นสุดลง โทเค็นจะใช้ไม่ได้อีกต่อไป แอปของคุณต้องสร้างโทเค็นใหม่สำหรับแต่ละเซสชัน หากไม่ใส่พารามิเตอร์ หมายเหตุ: การตรวจสอบที่อยู่ใช้ได้เฉพาะในเซสชันที่มี API การเติมข้อความอัตโนมัติ (ใหม่) เท่านั้น แต่จะใช้ Autocomplete API ไม่ได้ ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/session-pricing |
เนื้อหาการตอบกลับ
การตอบกลับคำขอตรวจสอบที่อยู่
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"result": {
object ( |
ช่อง | |
---|---|
result |
ผลการตรวจสอบที่อยู่ |
responseId |
UUID ที่ระบุการตอบกลับนี้ หากที่อยู่ต้องได้รับการตรวจสอบอีกครั้ง UUID นี้ต้องมาพร้อมกับคำขอใหม่ |
PostalAddress
แสดงที่อยู่ไปรษณีย์ เช่น สำหรับที่อยู่ไปรษณีย์หรือที่อยู่การชำระเงิน หากใช้ที่อยู่ไปรษณีย์ บริการไปรษณีย์จะนำส่งสินค้าไปยังสถานที่ตั้งของ P.O ได้ กล่องหรือสิ่งอื่นที่คล้ายกัน ไม่ได้มีไว้เพื่อสร้างแบบจำลองตำแหน่งทางภูมิศาสตร์ (ถนน เมือง ภูเขา)
ในการใช้งานโดยทั่วไป ที่อยู่จะสร้างขึ้นผ่านข้อมูลจากผู้ใช้หรือจากการนำเข้าข้อมูลที่มีอยู่ ทั้งนี้ขึ้นอยู่กับประเภทของกระบวนการ
คำแนะนำเกี่ยวกับการป้อน / การแก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่ที่รองรับการปรับให้เป็นสากล เช่น https://github.com/google/libaddressinput) - ผู้ใช้ไม่ควรแสดงองค์ประกอบ UI สำหรับการป้อนหรือแก้ไขช่องนอกประเทศที่ใช้ช่องนั้น
ดูคำแนะนำเพิ่มเติมเกี่ยวกับวิธีใช้สคีมานี้ได้ที่ https://support.google.com/business/answer/6397478
การแสดง JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
ช่อง | |
---|---|
revision |
การแก้ไขสคีมาของ |
regionCode |
ไม่บังคับ รหัสภูมิภาค CLDR ของประเทศ/ภูมิภาคของที่อยู่ ดูรายละเอียดได้ที่ https://cldr.unicode.org/ และ https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html ตัวอย่างเช่น "CH" สำหรับสวิตเซอร์แลนด์ หากไม่ได้ระบุรหัสภูมิภาค ระบบจะอนุมานจากที่อยู่ หากทราบ ขอแนะนำให้ใส่รหัสภูมิภาคมาด้วยเพื่อประสิทธิภาพที่ดีที่สุด การมีภูมิภาคไม่สอดคล้องกันหรือซ้ำกันอาจทำให้ประสิทธิภาพไม่ดี ตัวอย่างเช่น หาก |
languageCode |
รหัสภาษาในที่อยู่ที่ป้อนจะถูกสงวนไว้สำหรับการใช้งานในอนาคต และจะไม่มีการดำเนินการใดๆ ในวันนี้ API จะแสดงที่อยู่เป็นภาษาที่เหมาะสมกับสถานที่ตั้งของที่อยู่ |
postalCode |
ไม่บังคับ รหัสไปรษณีย์ของที่อยู่ บางประเทศอาจไม่ได้ใช้หรือกำหนดให้มีการแสดงรหัสไปรษณีย์ แต่ประเทศที่ใช้รหัสเหล่านี้อาจทำให้มีการตรวจสอบเพิ่มเติมกับส่วนอื่นๆ ของที่อยู่ (เช่น การตรวจสอบรัฐ/รหัสไปรษณีย์ในสหรัฐอเมริกา) |
sortingCode |
ไม่บังคับ รหัสการจัดเรียงเพิ่มเติม รหัสเฉพาะประเทศ ซึ่งไม่มีใช้ในภูมิภาคส่วนใหญ่ ในที่ที่ใช้ ค่าอาจเป็นสตริง เช่น "CEDEX" ซึ่งอาจจะตามด้วยตัวเลข (เช่น "CEDEX 7") หรือเป็นเพียงตัวเลขเพียงอย่างเดียวซึ่งเป็นตัวแทนของ "รหัสเซกเตอร์" (จาเมกา), "ดัชนีพื้นที่นำส่ง" (มาลาวี) หรือ "ตัวบ่งชี้ที่ทำการไปรษณีย์" (เช่น โกตดิวัวร์) |
administrativeArea |
ไม่บังคับ เขตการปกครองสูงสุด ซึ่งใช้สำหรับที่อยู่ทางไปรษณีย์ของประเทศหรือภูมิภาค ตัวอย่างเช่น อาจเป็นรัฐ จังหวัด แคว้น หรือจังหวัด โดยเฉพาะอย่างยิ่งสำหรับสเปน ประเทศนี้เป็นจังหวัด ไม่ใช่ชุมชนปกครองตนเอง (เช่น "บาร์เซโลนา" ไม่ใช่ "คาตาโลเนีย") มีหลายประเทศไม่ใช้เขตบริหารในที่อยู่ทางไปรษณีย์ เช่น ในสวิตเซอร์แลนด์ ข้อมูลนี้ไม่ควรถูกปล่อยไว้ |
locality |
ไม่บังคับ โดยทั่วไปหมายถึงส่วนเมืองของที่อยู่ ตัวอย่าง: เมืองในสหรัฐอเมริกา, เขตไอที, เมืองไปรษณีย์ของสหราชอาณาจักร ในภูมิภาคของโลกที่ไม่มีการกำหนดพื้นที่ไว้อย่างดีหรือไม่เหมาะสมกับโครงสร้างนี้ ให้ปล่อยย่านนั้นว่างไว้และใช้บรรทัดที่อยู่ |
sublocality |
ไม่บังคับ สถานที่ตั้งย่อยของที่อยู่ ตัวอย่างเช่น ย่านใกล้เคียง เขตเมือง เขตต่างๆ |
addressLines[] |
ต้องระบุ บรรทัดที่อยู่ที่ไม่มีโครงสร้างซึ่งอธิบายถึงระดับที่ต่ำกว่าของที่อยู่ |
recipients[] |
โปรดหลีกเลี่ยงการตั้งค่าในช่องนี้ Address Validation API ไม่ได้ใช้อยู่ในปัจจุบัน แม้ว่าในขณะนี้ API จะไม่ปฏิเสธคำขอที่มีชุดช่องนี้ แต่ข้อมูลจะถูกทิ้งและจะไม่แสดงผลในการตอบกลับ |
organization |
โปรดหลีกเลี่ยงการตั้งค่าในช่องนี้ Address Validation API ไม่ได้ใช้อยู่ในปัจจุบัน แม้ว่าในขณะนี้ API จะไม่ปฏิเสธคำขอที่มีชุดช่องนี้ แต่ข้อมูลจะถูกทิ้งและจะไม่แสดงผลในการตอบกลับ |
LanguageOptions
ตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจมีการรองรับอย่างจำกัด และการเปลี่ยนแปลงในผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจใช้ไม่ได้กับเวอร์ชันก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอื่นๆ ข้อเสนอก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปจะอยู่ภายใต้ข้อกำหนดเฉพาะของบริการ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ในคำอธิบายขั้นตอนการเปิดตัว
เปิดใช้ Address Validation API เพื่อรวมข้อมูลเพิ่มเติมในการตอบกลับ
การแสดง JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
ช่อง | |
---|---|
returnEnglishLatinAddress |
ตัวอย่าง: แสดงผล |
ValidationResult
ผลลัพธ์ของการตรวจสอบที่อยู่
การแสดง JSON |
---|
{ "verdict": { object ( |
ช่อง | |
---|---|
verdict |
การแจ้งผลการตัดสินโดยรวม |
address |
ข้อมูลเกี่ยวกับที่อยู่เองซึ่งไม่ใช่รหัสพิกัดภูมิศาสตร์ |
geocode |
ข้อมูลเกี่ยวกับตำแหน่งและสถานที่ซึ่งที่อยู่นั้นระบุพิกัดทางภูมิศาสตร์ไป |
metadata |
ข้อมูลอื่นๆ ที่เกี่ยวข้องกับความสามารถในการนำส่ง เราไม่รับประกันว่าจะมีการเติมข้อมูล |
uspsData |
การแจ้งเกี่ยวกับการนำส่งเพิ่มเติมจาก USPS ให้บริการในภูมิภาค |
englishLatinAddress |
ตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจมีการรองรับอย่างจำกัด และการเปลี่ยนแปลงในผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจใช้ไม่ได้กับเวอร์ชันก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอื่นๆ ข้อเสนอก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปจะอยู่ภายใต้ข้อกำหนดเฉพาะของบริการ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ในคำอธิบายขั้นตอนการเปิดตัว แปลที่อยู่เป็นภาษาอังกฤษ ที่อยู่ที่แปลจะใช้ซ้ำเป็นอินพุต API ไม่ได้ บริการนี้มีเพื่อให้ผู้ใช้สามารถใช้ภาษาของตนเพื่อยืนยันหรือปฏิเสธการตรวจสอบความถูกต้องของที่อยู่เดิมที่ให้ไว้ หากบางส่วนของที่อยู่ไม่มีคำแปลภาษาอังกฤษ บริการจะแสดงส่วนนั้นในภาษาอื่นที่ใช้ตัวเขียนภาษาละติน ดูคำอธิบายวิธีการเลือกภาษาอื่นได้ที่นี่ หากบางส่วนของที่อยู่ไม่มีคำแปลหรือคำทับศัพท์ในภาษาที่ใช้อักษรละติน บริการแสดงส่วนนั้นเป็นภาษาท้องถิ่นที่เชื่อมโยงกับที่อยู่ เปิดใช้เอาต์พุตนี้โดยใช้แฟล็ก หมายเหตุ: ช่อง |
คำตัดสิน
ภาพรวมระดับสูงของผลการตรวจสอบที่อยู่และรหัสพิกัดภูมิศาสตร์
การแสดง JSON |
---|
{ "inputGranularity": enum ( |
ช่อง | |
---|---|
inputGranularity |
รายละเอียดของที่อยู่อินพุต ซึ่งเป็นผลมาจากการแยกวิเคราะห์ที่อยู่อินพุตและไม่ได้ให้สัญญาณสำหรับการตรวจสอบความถูกต้อง ดูสัญญาณการตรวจสอบได้จาก ตัวอย่างเช่น หากที่อยู่ที่ป้อนมีหมายเลขอพาร์ตเมนต์ที่เฉพาะเจาะจง |
validationGranularity |
ระดับรายละเอียดที่ API สามารถตรวจสอบที่อยู่ได้อย่างสมบูรณ์ ตัวอย่างเช่น ดูผลการตรวจสอบคอมโพเนนต์ตามที่อยู่ได้ใน |
geocodeGranularity |
ข้อมูลเกี่ยวกับรายละเอียดของ ซึ่งอาจแตกต่างจาก |
addressComplete |
ที่อยู่จะถือว่าสมบูรณ์หากไม่มีโทเค็นที่ยังไม่ได้รับการแก้ไข ไม่มีองค์ประกอบที่อยู่ที่ไม่คาดคิดหรือขาดหายไป หากไม่ได้ตั้งค่า จะแสดงค่านั้นเป็น |
hasUnconfirmedComponents |
ไม่สามารถจัดหมวดหมู่หรือตรวจสอบองค์ประกอบที่อยู่อย่างน้อย 1 รายการ ดูรายละเอียดที่ |
hasInferredComponents |
มีการอนุมานองค์ประกอบที่อยู่อย่างน้อย 1 รายการ (เพิ่มแล้ว) ที่ไม่ได้อยู่ในอินพุต ดูรายละเอียดได้ที่ |
hasReplacedComponents |
มีการแทนที่คอมโพเนนต์ที่อยู่อย่างน้อย 1 รายการ โปรดดูรายละเอียดที่ |
รายละเอียด
รายละเอียดต่างๆ ที่ที่อยู่หรือระบบพิกัดภูมิศาสตร์สามารถมีได้ เมื่อใช้เพื่อระบุรายละเอียดของที่อยู่ ค่าเหล่านี้จะบ่งบอกระดับความละเอียดของที่อยู่ที่ใช้ระบุปลายทางการส่งจดหมาย ตัวอย่างเช่น ที่อยู่ เช่น "123 Main Street, Redwood City, CA, 94061" ระบุ PREMISE
ในขณะที่ชื่อ "เรดวูดซิตี, CA, 94061" ระบุ LOCALITY
อย่างไรก็ตาม หากเราไม่สามารถค้นหารหัสพิกัดภูมิศาสตร์สำหรับ "123 ถนนสีลม" ในเรดวูดซิตี รหัสพิกัดภูมิศาสตร์ที่แสดงผลอาจมีความละเอียด LOCALITY
แม้ว่าที่อยู่จะละเอียดกว่า
Enum | |
---|---|
GRANULARITY_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
SUB_PREMISE |
ผลลัพธ์ที่อยู่ต่ำกว่าระดับอาคาร เช่น อพาร์ตเมนต์ |
PREMISE |
ผลลัพธ์ระดับอาคาร |
PREMISE_PROXIMITY |
รหัสพิกัดทางภูมิศาสตร์โดยประมาณของตำแหน่งระดับอาคารของที่อยู่ |
BLOCK |
ที่อยู่หรือรหัสพิกัดภูมิศาสตร์ระบุถึงพื้นที่บล็อค ใช้ในภูมิภาคที่มีที่อยู่ระดับบล็อกเท่านั้น เช่น ญี่ปุ่น |
ROUTE |
รหัสพิกัดภูมิศาสตร์หรือที่อยู่มีความละเอียดสำหรับใช้เส้นทาง เช่น ถนน ถนน หรือทางหลวง |
OTHER |
รายละเอียดอื่นๆ ทั้งหมดที่เก็บรวมไว้ด้วยกันเนื่องจากไม่มีการนำส่ง |
ที่อยู่
รายละเอียดของที่อยู่หลังการประมวลผล การประมวลผลภายหลังรวมถึงการแก้ไขส่วนที่สะกดผิดของที่อยู่ การเปลี่ยนส่วนที่ไม่ถูกต้อง และการอนุมานส่วนที่ขาดไป
การแสดง JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
ช่อง | |
---|---|
formattedAddress |
ที่อยู่หลังการประมวลผล ซึ่งอยู่ในรูปแบบที่อยู่บรรทัดเดียวตามกฎการจัดรูปแบบที่อยู่ของภูมิภาคที่ที่อยู่นั้นตั้งอยู่ |
postalAddress |
ที่อยู่ที่ประมวลผลแล้วซึ่งแสดงเป็นที่อยู่ไปรษณีย์ |
addressComponents[] |
รายการที่ไม่เรียงลำดับ องค์ประกอบที่อยู่แต่ละรายการของที่อยู่ที่จัดรูปแบบและแก้ไขแล้ว รวมถึงข้อมูลการตรวจสอบความถูกต้อง ซึ่งจะให้ข้อมูลเกี่ยวกับสถานะการตรวจสอบของแต่ละคอมโพเนนต์ ส่วนประกอบที่อยู่ไม่ได้เรียงลำดับตามวิธีที่ระบุ อย่าคาดเดาใดๆ เกี่ยวกับลำดับขององค์ประกอบที่อยู่ในรายการ |
missingComponentTypes[] |
ประเภทของคอมโพเนนต์ที่คาดว่าจะแสดงในที่อยู่ทางไปรษณีย์ที่มีรูปแบบถูกต้อง แต่ไม่พบในอินพุต และ ไม่สามารถอนุมานได้ คอมโพเนนต์ประเภทนี้ไม่มีใน |
unconfirmedComponentTypes[] |
ประเภทของคอมโพเนนต์ที่มีอยู่ใน |
unresolvedTokens[] |
โทเค็นในอินพุตที่แปลงไม่ได้ ซึ่งอาจเป็นอินพุตที่ระบบไม่รู้จักว่าเป็นส่วนที่ถูกต้องของที่อยู่ (เช่น ในข้อมูล เช่น "123235253253 Main St, San Francisco, CA, 94105" โทเค็นที่ยังไม่ได้แก้ไขอาจมีลักษณะดังนี้ |
AddressComponent
หมายถึงส่วนประกอบที่อยู่ เช่น ถนน เมือง หรือรัฐ
การแสดง JSON |
---|
{ "componentName": { object ( |
ช่อง | |
---|---|
componentName |
ชื่อคอมโพเนนต์นี้ |
componentType |
ประเภทขององค์ประกอบที่อยู่ โปรดดูรายการประเภทที่เป็นไปได้ในตารางที่ 2: ประเภทเพิ่มเติมที่บริการ Places แสดงผล |
confirmationLevel |
ระบุระดับความแน่นอนที่เรามีว่าคอมโพเนนต์ถูกต้อง |
inferred |
ระบุว่าคอมโพเนนต์ไม่ได้เป็นส่วนหนึ่งของอินพุต แต่เราได้อนุมานไว้สำหรับตำแหน่งที่อยู่และเชื่อว่าควรมีการระบุสำหรับที่อยู่ที่สมบูรณ์ |
spellCorrected |
ระบุการแก้ไขการสะกดคำผิดในชื่อคอมโพเนนต์ API จะไม่แจ้งการเปลี่ยนแปลงจากรูปแบบการสะกดคำหนึ่งเป็นอีกรูปแบบหนึ่งเสมอ เช่น เมื่อเปลี่ยน "กึ่งกลาง" "กึ่งกลาง" นอกจากนี้ จะไม่มีการแจ้งคำสะกดผิดที่พบบ่อยๆ ด้วย เช่น เมื่อเปลี่ยน "Amphitheater Pkwy" "Amphitheatre Pkwy" |
replaced |
บ่งบอกว่าได้แทนที่ชื่อคอมโพเนนต์ด้วยชื่ออื่น เช่น มีการแทนที่ด้วยรหัสไปรษณีย์ที่ไม่ถูกต้องด้วยรหัสที่ถูกต้องสำหรับที่อยู่ การเปลี่ยนแปลงนี้ไม่ใช่การเปลี่ยนแปลงเล็กน้อย คอมโพเนนต์อินพุตได้มีการเปลี่ยนแปลงเป็นอย่างอื่น |
unexpected |
ระบุองค์ประกอบของที่อยู่ที่ไม่คาดว่าจะแสดงอยู่ในที่อยู่ไปรษณีย์สำหรับภูมิภาคที่ระบุ เราเก็บข้อมูลดังกล่าวไว้เพียงเพราะข้อมูลนี้เป็นส่วนหนึ่งของข้อมูลที่ป้อน |
ComponentName
Wrapper สำหรับชื่อของคอมโพเนนต์
การแสดง JSON |
---|
{ "text": string, "languageCode": string } |
ช่อง | |
---|---|
text |
ข้อความชื่อ เช่น "5th Avenue" ชื่อถนนหรือ "1253" สำหรับหมายเลขถนน |
languageCode |
รหัสภาษา BCP-47 ส่วนนี้จะไม่ปรากฏหากชื่อคอมโพเนนต์ไม่ได้เชื่อมโยงกับภาษา เช่น หมายเลขถนน |
ConfirmationLevel
ค่าต่างๆ ที่เป็นไปได้สำหรับระดับการยืนยัน
Enum | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
CONFIRMED |
เรายืนยันได้ว่ามีคอมโพเนนต์นี้อยู่และสมเหตุสมผลในบริบทของที่อยู่ที่เหลือ |
UNCONFIRMED_BUT_PLAUSIBLE |
ระบบยืนยันคอมโพเนนต์นี้ไม่ได้ แต่เป็นไปได้ว่ามีคอมโพเนนต์ดังกล่าวอยู่ ตัวอย่างเช่น เลขที่ถนนในช่วงของบ้านเลขที่ที่ถูกต้องซึ่งเป็นที่รู้จักบนถนนที่ไม่ทราบบ้านเลขที่ที่ระบุ |
UNCONFIRMED_AND_SUSPICIOUS |
คอมโพเนนต์นี้ไม่ได้รับการยืนยันและมีแนวโน้มว่าจะไม่ถูกต้อง ตัวอย่างเช่น ย่านใกล้เคียงที่ไม่เหมาะกับที่อยู่ที่เหลือ |
รหัสพิกัดภูมิศาสตร์
มีข้อมูลเกี่ยวกับสถานที่ที่ได้รับการเข้ารหัสพิกัดภูมิศาสตร์ไว้
การแสดง JSON |
---|
{ "location": { object ( |
ช่อง | |
---|---|
location |
ตำแหน่งที่ระบุพิกัดทางภูมิศาสตร์ของอินพุต เราขอแนะนำให้ใช้รหัสสถานที่แทนที่จะใช้ที่อยู่ พิกัดละติจูด/ลองจิจูด หรือโค้ด Plus การใช้พิกัดเมื่อกำหนดเส้นทางหรือคำนวณเส้นทางขับขี่จะทำให้จุดตัดไปบนถนนที่ใกล้กับพิกัดเหล่านั้นมากที่สุดเสมอ ถนนนี้อาจไม่ใช่ถนนที่จะนำไปยังจุดหมายได้อย่างรวดเร็วหรือปลอดภัย และต้องไม่อยู่ใกล้จุดเข้าใช้งานไปยังที่พัก นอกจากนี้ เมื่อตำแหน่งถูกเข้ารหัสพิกัดภูมิศาสตร์แบบย้อนกลับ จะไม่มีการรับประกันว่าที่อยู่ที่ส่งกลับมาจะตรงกับที่อยู่เดิม |
plusCode |
Plus Code ที่ตรงกับ |
bounds |
ขอบเขตของสถานที่ที่ระบุพิกัดภูมิศาสตร์ |
featureSizeMeters |
ขนาดของสถานที่ที่ระบุพิกัดภูมิศาสตร์ในหน่วยเมตร นี่เป็นการวัดความหยาบของตำแหน่งที่ระบุพิกัดภูมิศาสตร์ไว้อีกแบบหนึ่ง แต่เป็นการวัดขนาดทางกายภาพ ไม่ใช่ในความหมายเชิงความหมาย |
placeId |
PlaceID ของสถานที่ที่ระบุพิกัดทางภูมิศาสตร์นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานที่ได้ที่นี่ |
placeTypes[] |
ประเภทของสถานที่ที่อินพุตระบุพิกัดทางภูมิศาสตร์ เช่น |
LatLng
วัตถุที่แสดงคู่ละติจูด/ลองจิจูด ค่านี้จะแสดงเป็นคู่ของค่าคู่เพื่อแสดงองศาละติจูดและลองจิจูด ออบเจ็กต์นี้ต้องเป็นไปตาม มาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงมาตรฐาน
การแสดง JSON |
---|
{ "latitude": number, "longitude": number } |
ช่อง | |
---|---|
latitude |
ละติจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-90.0, +90.0] |
longitude |
ลองจิจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-180.0, +180.0] |
PlusCode
Plus Code (http://plus.codes) คือการอ้างอิงตำแหน่งที่มี 2 รูปแบบ ได้แก่ โค้ดส่วนกลางที่กำหนดขนาด 14mx14m (1/8000 ขององศา) หรือสี่เหลี่ยมผืนผ้าที่เล็กกว่า และโค้ดประกอบ ซึ่งแทนที่คำนำหน้าด้วยตำแหน่งอ้างอิง
การแสดง JSON |
---|
{ "globalCode": string, "compoundCode": string } |
ช่อง | |
---|---|
globalCode |
รหัสสากล (แบบสมบูรณ์) ของสถานที่ เช่น "9FWM33GV+HQ" ซึ่งแสดงพื้นที่ 1/8000 x 1/8000 องศา (ประมาณ 14 x 14 เมตร) |
compoundCode |
รหัสรวมของสถานที่ เช่น "33GV+HQ, Ramberg,นอร์เวย์" ซึ่งมีส่วนต่อท้ายรหัสสากล และแทนที่คำนำหน้าด้วยชื่อที่จัดรูปแบบของเอนทิตีอ้างอิง |
วิวพอร์ต
วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงเป็นเส้นทแยงมุม 2 จุดตรงข้ามกับ low
และ high
จุด วิวพอร์ตจะถือเป็นพื้นที่ปิด กล่าวคือ มีอาณาเขต ขอบเขตของละติจูดต้องอยู่ระหว่าง -90 ถึง 90 องศา และขอบเขตของลองจิจูดต้องอยู่ระหว่าง -180 ถึง 180 องศา กรณีต่างๆ ได้แก่
หาก
low
=high
วิวพอร์ตจะประกอบด้วยจุดเดียวดังกล่าวหาก
low.longitude
>high.longitude
ระบบจะกลับช่วงลองจิจูด (วิวพอร์ตข้ามเส้นลองจิจูด 180 องศา)หาก
low.longitude
= -180 องศา และhigh.longitude
= 180 องศา วิวพอร์ตจะรวมลองจิจูดทั้งหมดหาก
low.longitude
= 180 องศาและhigh.longitude
= -180 องศา แสดงว่าช่วงลองจิจูดจะว่างเปล่าหาก
low.latitude
>high.latitude
ช่วงละติจูดว่างเปล่า
ต้องเติมข้อมูลทั้ง low
และ high
และในช่องที่แสดงไม่สามารถเว้นว่างได้ (ตามที่ระบุโดยคำจำกัดความด้านบน) วิวพอร์ตที่ว่างเปล่าจะทำให้เกิดข้อผิดพลาด
ตัวอย่างเช่น วิวพอร์ตนี้ล้อมรอบนิวยอร์กซิตี้ทั้งหมด
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
การแสดง JSON |
---|
{ "low": { object ( |
ช่อง | |
---|---|
low |
ต้องระบุ จุดต่ำของวิวพอร์ต |
high |
ต้องระบุ จุดสูงของวิวพอร์ต |
AddressMetadata
ข้อมูลเมตาสำหรับที่อยู่ เราไม่รับประกันว่าจะมีการเติมข้อมูล metadata
ทั้งหมดสำหรับทุกที่อยู่ที่ส่งไปยัง Address Validation API
การแสดง JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
ช่อง | |
---|---|
business |
ระบุว่านี่คือที่อยู่ของธุรกิจ หากไม่ได้ตั้งค่า แสดงว่าไม่ทราบค่า |
poBox |
ระบุว่าที่อยู่ของตู้ปณ. หากไม่ได้ตั้งค่า แสดงว่าไม่ทราบค่า |
residential |
ระบุว่านี่เป็นที่อยู่ของที่พักอาศัย หากไม่ได้ตั้งค่า แสดงว่าไม่ทราบค่า |
UspsData
ข้อมูล USPS สำหรับที่อยู่ เราไม่รับประกันว่าจะมีการเติมข้อมูล uspsData
อย่างครบถ้วนสำหรับที่อยู่ในสหรัฐอเมริกาหรือที่อยู่ PR ทุกรายการที่ส่งไปยัง Address Validation API ขอแนะนำให้รวมช่องที่อยู่สำรองในการตอบกลับนี้หากคุณใช้ uspsData เป็นส่วนหลักของคำตอบ
การแสดง JSON |
---|
{
"standardizedAddress": {
object ( |
ช่อง | |
---|---|
standardizedAddress |
ที่อยู่มาตรฐานของ USPS |
deliveryPointCode |
รหัสจุดนำส่ง 2 หลัก |
deliveryPointCheckDigit |
หมายเลขตรวจสอบของจุดนำส่ง หมายเลขนี้จะเพิ่มที่ส่วนท้ายของ delivery_point_barcode สำหรับจดหมายที่สแกนด้วยกลไก การใส่ตัวเลข delivery_point_barcode, deliveryPointCheckDigit, รหัสไปรษณีย์ และ ZIP+4 ทั้งหมดเข้าด้วยกันควรทำให้ตัวเลขหารด้วย 10 |
dpvConfirmation |
ค่าที่เป็นไปได้สำหรับการยืนยัน DPV แสดงผลอักขระเดียวหรือไม่แสดงค่า
|
dpvFootnote |
เชิงอรรถจากการตรวจสอบจุดนำส่ง เชิงอรรถหลายรายการสามารถต่อเข้าด้วยกันในสตริงเดียวกัน
|
dpvCmra |
ระบุว่าที่อยู่เป็น CMRA (Commercial Mail Receive Agency) ซึ่งเป็นธุรกิจส่วนตัวที่รับส่งจดหมายสำหรับลูกค้า แสดงผลอักขระเดี่ยว
|
dpvVacant |
สถานที่นี้ว่างไหม แสดงผลอักขระเดี่ยว
|
dpvNoStat |
ที่อยู่นี้ไม่ใช่ที่อยู่สถิติหรือที่อยู่ที่ใช้งานอยู่ ไม่มีที่อยู่สถิติคือที่อยู่ที่ไม่มีการเข้าใช้อย่างต่อเนื่องหรือที่อยู่ที่ USPS ไม่ได้ให้บริการ แสดงผลอักขระเดี่ยว
|
dpvNoStatReasonCode |
ระบุประเภท NoStat แสดงรหัสเหตุผลเป็น int
|
dpvDrop |
ธงระบุว่ามีการส่งอีเมลไปยังผู้รับเพียงตัวเดียวที่ไซต์ แสดงผลอักขระเดี่ยว
|
dpvThrowback |
ระบุว่าไม่มีการส่งอีเมลไปยังที่อยู่ แสดงผลอักขระเดี่ยว
|
dpvNonDeliveryDays |
การทำเครื่องหมายระบุว่าไม่มีการส่งอีเมลทุกวันของสัปดาห์ แสดงผลอักขระเดี่ยว
|
dpvNonDeliveryDaysValues |
จำนวนเต็มที่ระบุวันที่ไม่แสดงโฆษณา อาจมีการตรวจสอบโดยใช้แฟล็กบิตดังนี้ 0x40 – วันอาทิตย์เป็นวันที่ไม่แสดงโฆษณาขนาด 0x20 – วันจันทร์เป็นวันที่ไม่แสดงโฆษณาขนาด 0x10 – วันอังคารเป็นวันที่ไม่แสดงโฆษณาขนาด 0x08 – วันพุธเป็นวันที่ไม่แสดงโฆษณาขนาด 0x04 – วันพฤหัสบดีเป็นวันที่ไม่แสดงโฆษณา 0x02 – วันศุกร์เป็นวันที่ไม่แสดงโฆษณา 0x01 |
dpvNoSecureLocation |
ธงระบุว่าประตูเข้าถึงได้ แต่จะไม่มีการทิ้งพัสดุเนื่องจากข้อกังวลด้านความปลอดภัย แสดงผลอักขระเดี่ยว
|
dpvPbsa |
บ่งบอกว่าที่อยู่ตรงกับระเบียน PBSA แสดงผลอักขระเดี่ยว
|
dpvDoorNotAccessible |
ธงจะระบุที่อยู่ซึ่ง USPS ไม่สามารถเคาะประตูเพื่อส่งจดหมายได้ แสดงผลอักขระเดี่ยว
|
dpvEnhancedDeliveryCode |
บ่งบอกว่ารหัสการคืนสินค้า DPV ถูกต้องมากกว่า 1 รายการสำหรับที่อยู่ แสดงผลอักขระเดี่ยว
|
carrierRoute |
รหัสเส้นทางของผู้ให้บริการ รหัสอักขระ 4 ตัวที่ประกอบด้วยตัวอักษรนำหน้า 1 ตัวและตัวกำหนดเส้นทาง 3 หลัก คำนำหน้า:
|
carrierRouteIndicator |
สัญญาณบอกสถานะการจัดเรียงอัตราเส้นทางของผู้ให้บริการ |
ewsNoMatch |
ที่อยู่สำหรับจัดส่งตรงกัน แต่ไฟล์ EWS ระบุว่าที่อยู่ที่ตรงกันจะพร้อมใช้งานเร็วๆ นี้ |
postOfficeCity |
เมืองที่ทำการไปรษณีย์หลัก |
postOfficeState |
รัฐที่ทำการไปรษณีย์หลัก |
abbreviatedCity |
เมืองแบบย่อ |
fipsCountyCode |
รหัสเคาน์ตี FIPS |
county |
ชื่อเคาน์ตี |
elotNumber |
หมายเลขสายการเดินทางที่ปรับปรุงแล้ว (eLOT) |
elotFlag |
eLOT จากน้อยไปมาก/มากไปน้อย (A/D) |
lacsLinkReturnCode |
รหัสการคืนสินค้า LACSLink |
lacsLinkIndicator |
ตัวบ่งชี้ LACSLink |
poBoxOnlyPostalCode |
รหัสไปรษณีย์เท่านั้น |
suitelinkFootnote |
เชิงอรรถตั้งแต่การจับคู่ถนนหรืออาคารสูงไปจนถึงข้อมูลห้อง หากพบชื่อธุรกิจที่ตรงกัน ระบบจะแสดงผลหมายเลขรอง
|
pmbDesignator |
ผู้กำหนดหน่วย PMB (Private Mail Box) |
pmbNumber |
หมายเลข PMB (Private Mail Box) |
addressRecordType |
ประเภทของระเบียนที่อยู่ที่ตรงกับที่อยู่ที่ป้อน
|
defaultAddress |
ตัวบ่งชี้ว่าพบที่อยู่เริ่มต้น แต่มีที่อยู่ที่เจาะจงมากกว่า |
errorMessage |
ข้อความแสดงข้อผิดพลาดสำหรับการดึงข้อมูล USPS ข้อมูลนี้สร้างขึ้นเมื่อการประมวลผล USPS ถูกระงับเนื่องจากตรวจพบที่อยู่ที่สร้างขึ้นปลอม ฟิลด์ข้อมูล USPS อาจไม่สร้างขึ้นเมื่อเกิดข้อผิดพลาดนี้ |
cassProcessed |
ตัวบ่งชี้ว่าคำขอได้รับการประมวลผล CASS |
UspsAddress
ตัวแทน USPS ของที่อยู่ในสหรัฐอเมริกา
การแสดง JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
ช่อง | |
---|---|
firstAddressLine |
ที่อยู่บรรทัดแรก |
firm |
ชื่อบริษัท |
secondAddressLine |
ที่อยู่บรรทัดที่สอง |
urbanization |
ชื่อเขตเมืองของเปอร์โตริโก |
cityStateZipAddressLine |
เมือง + รัฐ + รหัสไปรษณีย์ |
city |
ชื่อเมือง |
state |
รหัสรัฐ 2 ตัวอักษร |
zipCode |
รหัสไปรษณีย์ เช่น 10009 |
zipCodeExtension |
ส่วนขยายรหัสไปรษณีย์ 4 หลัก เช่น 5023 |