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

ส่งคำขอตรวจสอบที่อยู่โดยส่งคำขอ 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 — ต้องระบุ อาร์เรย์ซึ่งมีที่อยู่ซึ่งระบุค่าที่ต่ำกว่า ของที่อยู่

ตัวเลือก USPS CASSTM

ไปรษณีย์สหรัฐอเมริกา® (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 พารามิเตอร์ ลงในช่อง mask

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

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

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