ส่งคําขอตรวจสอบที่อยู่

ส่งคำขอตรวจสอบที่อยู่โดยส่งคำขอ POST ไปยังปลายทางใดปลายทางหนึ่งต่อไปนี้

• validateAddress (REST)
• ValidateAddress (gRPC)

นอกจากนี้ คําขอของคุณควรส่งเนื้อหาคําขอ JSON ไปยังคําขอที่กําหนดที่อยู่ที่จะตรวจสอบด้วย เนื้อหาของคําขอต่อไปนี้มี 1 ช่อง และ 3 ช่องย่อย

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"

นอกจากนี้ คุณยังละเว้น locality และระบุเป็นองค์ประกอบในอาร์เรย์ addressLines ได้ด้วย

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

ลองใช้งาน

ช่องคำขอที่อยู่

เนื้อหาของคําขอประกอบด้วยช่องเดียว ดังนี้

• address — ฟิลด์ประเภท PostalAddress ซึ่งต้องมีรายการอย่างน้อย 1 รายการใน addressLines

เมื่อส่งฟิลด์ address ไปยัง Address Validation API คุณจะต้องระบุเพียงฟิลด์เดียวเท่านั้น ซึ่งก็คือ addressLines อย่างไรก็ตาม คำขอที่อยู่แบบง่ายที่สุดควรมีช่องย่อยต่อไปนี้

• regionCode — แนะนำ ช่องนี้เป็นช่องที่ไม่บังคับ แต่หากไม่ระบุ ทาง Address Validation API จะอนุมานภูมิภาคจากที่อยู่ แต่ให้ใส่ regionCode ด้วยหากทราบเพื่อผลลัพธ์ที่ดีที่สุด ดูรายชื่อภูมิภาคที่รองรับได้ที่ภูมิภาคที่รองรับ
• addressLines — ต้องระบุ อาร์เรย์ที่มีที่อยู่ซึ่งอธิบายโครงสร้างที่อยู่ระดับล่าง

ดู PostalAddress ในคู่มืออ้างอิง

ตัวเลือก CASS™ ของ USPS

ไปรษณีย์สหรัฐอเมริกา® (USPS®)¹ ดูแลระบบสนับสนุนความถูกต้องในการเข้ารหัส (CASS™) เพื่อสนับสนุนและรับรองผู้ให้บริการตรวจสอบที่อยู่

สำหรับภูมิภาคสหรัฐอเมริกาและเปอร์โตริโกเท่านั้น คุณสามารถเปิดใช้การประมวลผล CASS ได้โดยตั้งค่า enableUspsCass เป็น true ในเนื้อหาคำขอ เพื่อให้ได้ผลลัพธ์ที่ดีที่สุดเมื่อใช้ CASS ให้ระบุที่อยู่ที่มีถนนและหมายเลขถนน รวมถึงเมือง รัฐ และรหัสไปรษณีย์

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

ลองใช้งาน

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

1. เลือกไอคอน API ที่ด้านขวาของหน้า

2. (ไม่บังคับ) ขยายแสดงพารามิเตอร์มาตรฐานและตั้งค่าพารามิเตอร์ fields เป็นมาสก์ช่อง

3. แก้ไขเนื้อหาคําขอ (ไม่บังคับ)

4. เลือกปุ่มดำเนินการ ในกล่องโต้ตอบ ให้เลือกบัญชีที่ต้องการใช้ส่งคำขอ

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