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

ส่งคำขอตรวจสอบที่อยู่โดยออกคำขอ 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 ในคู่มืออ้างอิง

ตัวเลือก USPS CASSTM

Postal Service® (USPS®)¹ ของสหรัฐอเมริกามีระบบสนับสนุนความแม่นยำในการเขียนโค้ด (CASSTM) เพื่อรองรับและรับรองผู้ให้บริการตรวจสอบที่อยู่

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

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

ลองใช้เลย

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

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

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

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

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

5. ในแผง API Explorer ให้เลือกไอคอนขยาย เพื่อขยายหน้าต่าง API Explorer