یک درخواست اعتبار سنجی آدرس ارسال کنید

با ارسال یک درخواست POST به یکی از نقاط پایانی زیر، درخواست اعتبارسنجی آدرس را ارسال کنید:

• validateAddress (REST)
• ValidateAddress (gRPC)

درخواست شما همچنین باید یک بدنه درخواست JSON را به درخواستی ارسال کند که آدرسی را برای تأیید اعتبار تعریف می کند. بدنه درخواست زیر شامل یک فیلد و سه زیر فیلد است:

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 ، که باید حداقل یک ورودی در addressLines داشته باشد.

هنگام ارسال فیلد address به Address Validation API، فقط باید یک فیلد ارائه دهید: addressLines . با این حال، ساده ترین درخواست آدرس باید شامل زیرفیلدهای زیر باشد:

• regionCode - توصیه می شود. این یک فیلد اختیاری است، اما اگر حذف شود، Address Validation API منطقه را از آدرس استنتاج می کند. با این حال، برای بهترین نتیجه، اگر می دانید regionCode وارد کنید. برای لیست مناطق پشتیبانی شده، به مناطق پشتیبانی شده مراجعه کنید.
• addressLines - لازم است. آرایه ای با آدرس هایی که ساختار پایین آدرس را توصیف می کند.

آدرس PostalAddress را در راهنمای مرجع ببینید.

گزینه USPS CASS™

خدمات پستی ایالات متحده® (USPS®) ¹ سیستم پشتیبانی دقت کدگذاری (CASS™) را برای پشتیبانی و تأیید ارائه دهندگان اعتبارسنجی آدرس حفظ می کند.

فقط برای مناطق ایالات متحده و روابط عمومی، می توانید پردازش 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. به صورت اختیاری نمایش پارامترهای استاندارد را گسترش دهید و پارامتر fields روی فیلد ماسک تنظیم کنید.

2. به صورت اختیاری بدنه درخواست را ویرایش کنید.

3. دکمه Execute را انتخاب کنید. در گفتگو، حسابی را که می‌خواهید برای ارسال درخواست استفاده کنید، انتخاب کنید.

4. در پانل API Explorer، نماد گسترش را انتخاب کنید، ، برای گسترش پنجره API Explorer.