- คำขอ 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 |
ไม่บังคับ สตริงที่ระบุเซสชันการเติมข้อความอัตโนมัติเพื่อจุดประสงค์ในการเรียกเก็บเงิน ต้องเป็น URL และสตริง base64 ที่ปลอดภัยสำหรับชื่อไฟล์ที่มีความยาวอักขระ ASCII ไม่เกิน 36 ตัว มิฉะนั้น ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT เซสชันจะเริ่มต้นเมื่อผู้ใช้ป้อนคำค้นหาที่เติมข้อความอัตโนมัติ และสรุปเมื่อผู้ใช้เลือกสถานที่และเรียกรายละเอียดสถานที่หรือตรวจสอบที่อยู่ แต่ละเซสชันจะมีคำค้นหาที่เติมข้อความอัตโนมัติได้หลายรายการ ตามด้วยรายละเอียดสถานที่หรือคำขอตรวจสอบที่อยู่ 1 รายการ ข้อมูลเข้าสู่ระบบที่ใช้สำหรับแต่ละคำขอภายในเซสชันต้องเป็นของโปรเจ็กต์ Google Cloud Console เดียวกัน เมื่อเซสชันสิ้นสุดลง โทเค็นจะใช้ไม่ได้อีกต่อไป แอปของคุณต้องสร้างโทเค็นใหม่สําหรับแต่ละเซสชัน หากไม่ระบุพารามิเตอร์ หมายเหตุ: การตรวจสอบที่อยู่ใช้ได้เฉพาะในเซสชันที่มี API การเติมข้อความอัตโนมัติ (ใหม่) เท่านั้น และไม่สามารถใช้กับ API การเติมข้อความอัตโนมัติ ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/session-pricing |
เนื้อหาการตอบกลับ
การตอบกลับคำขอตรวจสอบที่อยู่
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"result": {
object ( |
ช่อง | |
---|---|
result |
ผลการตรวจสอบที่อยู่ |
responseId |
UUID ที่ระบุการตอบกลับนี้ หากต้องตรวจสอบที่อยู่อีกครั้ง UUID นี้ต้องมาพร้อมกับคำขอใหม่ |
PostalAddress
แสดงที่อยู่ไปรษณีย์ เช่น ที่อยู่สำหรับนำส่งทางไปรษณีย์หรือที่อยู่การชำระเงิน ตามที่อยู่ไปรษณีย์ บริการไปรษณีย์สามารถจัดส่งสินค้าไปยังสถานที่ตั้ง ตู้ ปณ. หรืออื่นๆ ที่คล้ายกันได้ แต่ไม่ได้มีไว้เพื่อสร้างแบบจำลองสถานที่ตั้งทางภูมิศาสตร์ (ถนน เมือง ภูเขา)
ในการใช้งานโดยทั่วไป ที่อยู่จะสร้างขึ้นผ่านการป้อนข้อมูลของผู้ใช้ หรือจากการนำเข้าข้อมูลที่มีอยู่ โดยขึ้นอยู่กับประเภทของกระบวนการ
คําแนะนําเกี่ยวกับการป้อน / แก้ไขที่อยู่ - ใช้วิดเจ็ตที่อยู่ที่พร้อมสําหรับการปรับให้เป็นสากล เช่น 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 |
ไม่บังคับ โดยทั่วไปจะหมายถึงส่วนเมืองของที่อยู่ ตัวอย่าง: เมืองในสหรัฐอเมริกา ชุมชนไอที เขตไปรษณีย์ของสหราชอาณาจักร ในภูมิภาคของโลกซึ่งกำหนดท้องถิ่นไว้ไม่ดีหรือไม่อยู่ในโครงสร้างนี้ ให้ปล่อยย่านว่างไว้และใช้ addressLines |
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 จะvalidateที่อยู่ได้โดยสมบูรณ์ เช่น ดูผลการตรวจสอบองค์ประกอบตามที่อยู่ได้ใน |
geocodeGranularity |
ข้อมูลเกี่ยวกับรายละเอียดของ ซึ่งอาจแตกต่างจาก |
addressComplete |
ระบบจะถือว่าที่อยู่เสร็จสมบูรณ์หากไม่มีโทเค็นที่ยังไม่ได้แก้ไข หรือไม่มีองค์ประกอบที่อยู่ที่ไม่คาดคิดหรือขาดหายไป หากไม่ได้ตั้งค่า แสดงว่าค่าเป็น |
hasUnconfirmedComponents |
ไม่สามารถจัดหมวดหมู่หรือตรวจสอบคอมโพเนนต์ที่อยู่อย่างน้อย 1 รายการ โปรดดูรายละเอียดที่ |
hasInferredComponents |
คอมโพเนนต์ที่อยู่อย่างน้อย 1 รายการที่อนุมาน (เพิ่มแล้ว) ซึ่งไม่มีในอินพุต โปรดดูรายละเอียดที่ |
hasReplacedComponents |
มีการแทนที่องค์ประกอบที่อยู่อย่างน้อย 1 รายการ โปรดดูรายละเอียดที่ |
รายละเอียด
รายละเอียดต่างๆ ที่ที่อยู่หรือพิกัดภูมิศาสตร์มีได้ เมื่อใช้เพื่อระบุรายละเอียดของที่อยู่ ค่าเหล่านี้จะระบุความละเอียดที่ที่อยู่ระบุปลายทางจัดส่ง เช่น ที่อยู่อย่าง "123 Main Street, Redwood City, CA, 94061" จะระบุเป็น PREMISE
ขณะที่อย่าง "Redwood City, CA, 94061" จะระบุเป็น LOCALITY
อย่างไรก็ตาม หากเราไม่สามารถค้นหารหัสพิกัดภูมิศาสตร์ของ "123 Main Street" ในเรดวูดซิตี พิกัดภูมิศาสตร์ที่แสดงอาจมีรายละเอียด 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 ไม่ได้แสดงการเปลี่ยนแปลงจากการสะกดรูปแบบหนึ่งไปเป็นอีกรูปแบบหนึ่งเสมอไป เช่น เมื่อเปลี่ยนจาก "centre" เป็น "center" และมักจะไม่มีการแจ้งการสะกดผิดที่พบบ่อยเสมอไป เช่น เมื่อเปลี่ยนจาก "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 (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, รามเบิร์ก, นอร์เวย์" ซึ่งมีส่วนต่อท้ายของรหัสสากล และแทนที่คำนำหน้าด้วยชื่อที่มีการจัดรูปแบบของเอนทิตีอ้างอิง |
วิวพอร์ต
วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงเป็นแนวทแยงมุม 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
อย่างครบถ้วนสําหรับที่อยู่ในสหรัฐอเมริกาหรือการประชาสัมพันธ์ทั้งหมดที่ส่งไปยัง 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 (ตัวแทนรับส่งจดหมายเชิงพาณิชย์) ซึ่งเป็นธุรกิจส่วนตัวที่รับจดหมายสำหรับลูกค้าหรือไม่ แสดงผลอักขระเดี่ยว
|
dpvVacant |
สถานที่นี้ว่างไหม แสดงผลอักขระเดี่ยว
|
dpvNoStat |
ที่อยู่นี้ไม่ใช่ที่อยู่สถิติหรือที่อยู่ที่ใช้งานอยู่ ไม่มีที่อยู่สถิติคือที่อยู่ที่ไม่ได้ใช้อย่างต่อเนื่องหรือที่อยู่ที่ USPS ไม่ได้ให้บริการ แสดงผลอักขระเดี่ยว
|
dpvNoStatReasonCode |
ระบุประเภท NoStat แสดงผลรหัสเหตุผลเป็น int
|
dpvDrop |
Flag บ่งบอกว่ามีการส่งจดหมายไปยังผู้รับเดียวในเว็บไซต์หนึ่งๆ แสดงผลอักขระเดี่ยว
|
dpvThrowback |
ระบุว่าไม่ได้ส่งจดหมายไปยังที่อยู่ดังกล่าว แสดงผลอักขระเดี่ยว
|
dpvNonDeliveryDays |
Flag หมายความว่าไม่มีการส่งอีเมลทุกวันของสัปดาห์ แสดงผลอักขระเดี่ยว
|
dpvNonDeliveryDaysValues |
จำนวนเต็มที่ระบุวันที่ไม่ได้นำส่ง สามารถสืบสวนได้โดยใช้ธงบิต 0x40 – วันอาทิตย์เป็นวันที่ไม่ได้นำส่ง ขนาด 0x02 – วันจันทร์เป็นวันที่ไม่ได้นำส่ง 0x10 – วันอังคารเป็นวันที่ไม่ได้นำส่ง 0x08 โดยวันพุธเป็นวันที่ไม่ได้นำส่ง 0x04 – วันพฤหัสบดีเป็นวันที่นำส่งไม่ได้ ขนาด 0x02 – วันเสาร์เป็นวันที่ไม่ได้นำส่ง 0x01 – วันเสาร์เป็นวันที่ไม่ได้นำส่ง 0x01 |
dpvNoSecureLocation |
ธงระบุว่าประตูเข้าได้ แต่พัสดุจะไม่ถูกทิ้งไว้เนื่องจากข้อกังวลด้านความปลอดภัย แสดงผลอักขระเดี่ยว
|
dpvPbsa |
ระบุว่าที่อยู่ตรงกับระเบียน PBSA แสดงผลอักขระเดี่ยว
|
dpvDoorNotAccessible |
การแจ้งหมายถึงที่อยู่ที่ USPS ไม่สามารถเคาะประตูบ้านเพื่อส่งอีเมลได้ แสดงผลอักขระเดี่ยว
|
dpvEnhancedDeliveryCode |
ระบุว่าโค้ดแสดงผล DPV มากกว่า 1 รหัสที่ถูกต้องสำหรับที่อยู่ แสดงผลอักขระเดี่ยว
|
carrierRoute |
รหัสเส้นทางของผู้ให้บริการขนส่ง รหัสอักขระ 4 ตัวที่ประกอบด้วยคำนำหน้าตัวอักษร 1 ตัวและตัวระบุเส้นทาง 3 หลัก คำนำหน้า:
|
carrierRouteIndicator |
สัญญาณบอกสถานะการจัดเรียงอัตราของผู้ให้บริการขนส่ง |
ewsNoMatch |
ที่อยู่สำหรับจัดส่งนั้นจับคู่ได้ แต่ไฟล์ EWS ระบุว่าการจับคู่ที่ตรงกันทั้งหมดจะพร้อมใช้งานเร็วๆ นี้ |
postOfficeCity |
เมืองที่ทำการไปรษณีย์หลัก |
postOfficeState |
รัฐที่ทำการไปรษณีย์หลัก |
abbreviatedCity |
เมืองแบบย่อ |
fipsCountyCode |
รหัสประเทศ FIPS |
county |
ชื่ออำเภอ |
elotNumber |
หมายเลข Enhanced Line of Travel (eLOT) |
elotFlag |
eLOT การแจ้งจากน้อยไปมาก/มากไปน้อย (A/D) |
lacsLinkReturnCode |
โค้ดส่งกลับ LACSLink |
lacsLinkIndicator |
สัญญาณบอกสถานะ LACSLink |
poBoxOnlyPostalCode |
รหัสไปรษณีย์สำหรับตู้ ปณ. เท่านั้น |
suitelinkFootnote |
เชิงอรรถจากการจับคู่ถนนหรือสถิติที่สูงกับข้อมูลห้องชุด หากพบการจับคู่ชื่อธุรกิจ หมายเลขรองจะแสดงผล
|
pmbDesignator |
ตัวกำหนดหน่วย PMB (กล่องจดหมายส่วนตัว) |
pmbNumber |
หมายเลข PMB (กล่องจดหมายส่วนตัว) |
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 |