Package google.maps.addressvalidation.v1

با مجموعه‌ها، منظم بمانید ذخیره و دسته‌بندی محتوا براساس اولویت‌های شما.

string

آدرس پس از پردازش، به عنوان یک آدرس تک خطی با پیروی از قوانین قالب‌بندی آدرس منطقه‌ای که آدرس در آن قرار دارد، قالب‌بندی شده است.

توجه: فرمت این آدرس ممکن است با فرمت آدرس در قسمت postal_address مطابقت نداشته باشد. برای مثال، postal_address همیشه کشور را به‌عنوان یک region_code ۲ حرفی، مانند «US» یا «NZ» نشان می‌دهد. در مقابل، این فیلد از شکل طولانی‌تری از نام کشور مانند «USA» یا «نیوزیلند» استفاده می‌کند.

PostalAddress

آدرس پس از پردازش به عنوان یک آدرس پستی نشان داده شده است.

AddressComponent

لیست نامرتب اجزای آدرس منفرد آدرس فرمت شده و تصحیح شده، همراه با اطلاعات اعتبارسنجی. این اطلاعات در مورد وضعیت اعتبار سنجی اجزای جداگانه ارائه می دهد.

اجزای آدرس به روش خاصی مرتب نمی شوند. هیچ گونه فرضی در مورد ترتیب اجزای آدرس در لیست انجام ندهید.

string

انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی با فرمت صحیح وجود داشته باشند اما در ورودی و یافت نشدند قابل استنباط نیستند. یک مثال ممکن است ['street_number', 'route'] برای ورودی مانند "Boulder, Colorado, 80301, USA" باشد. لیست انواع ممکن را می توان در اینجا یافت.

توجه: زمانی که فکر می کنید قبلاً جزء گم شده را تهیه کرده اید، ممکن است یک نوع مؤلفه گم شده را ببینید. به عنوان مثال، این ممکن است زمانی اتفاق بیفتد که آدرس ورودی حاوی نام ساختمان باشد، اما نه شماره مقدمات. در آدرس "渋谷区渋谷３丁目 Shibuya Stream"، نام ساختمان "Shibuya Stream" دارای premise نوع مؤلفه است، اما شماره فرض وجود ندارد، بنابراین missing_component_types حاوی premise خواهد بود.

string

انواع مؤلفه‌هایی که در address_components وجود دارند، اما صحت آن‌ها تأیید نشد. این فیلد به منظور راحتی ارائه شده است: محتویات آن معادل تکرار از طریق address_components برای یافتن انواع همه مؤلفه‌هایی است که در آن سطح confirmation_level CONFIRMED نشده است یا پرچم inferred روی true تنظیم نشده است. لیست انواع ممکن را می توان در اینجا یافت.

string

هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد. به عنوان مثال، برای ورودی‌هایی مانند «Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US»، نشانه‌های حل‌نشده ممکن است مانند ["Parcel", "0000123123", "&", "0000456456"] باشند.

ComponentName

نام این جزء

string

نوع جزء آدرس جدول 2 را ببینید: انواع اضافی که توسط سرویس Places برگردانده شده است برای لیستی از انواع احتمالی.

ConfirmationLevel

نشان دهنده میزان اطمینانی است که ما در مورد صحیح بودن مؤلفه داریم.

bool

نشان می دهد که مؤلفه بخشی از ورودی نبوده است، اما ما آن را برای مکان آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود.

bool

تصحیح یک غلط املایی در نام مؤلفه را نشان می دهد. API همیشه تغییرات را از یک نوع املایی به دیگری علامت گذاری نمی کند، مانند زمانی که "مرکز" به "مرکز" تغییر می کند. همچنین همیشه اشتباهات املایی رایج را علامت گذاری نمی کند، مانند زمانی که "Amphitheatre Pkwy" را به "Amphitheatre Pkwy" تغییر می دهید.

bool

نشان می دهد که نام مؤلفه با یک نام کاملاً متفاوت جایگزین شده است، به عنوان مثال یک کد پستی اشتباه با کدی که برای آدرس صحیح است جایگزین شده است. این یک تغییر زیبایی نیست، جزء ورودی به دیگری تغییر کرده است.

bool

یک جزء آدرس را نشان می دهد که انتظار نمی رود در آدرس پستی منطقه داده شده وجود داشته باشد. ما آن را فقط به این دلیل حفظ کرده ایم که بخشی از ورودی بوده است.

bool

نشان می دهد که این آدرس یک کسب و کار است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

bool

نشان می دهد که آدرس یک صندوق پستی. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

bool

نشان می دهد که این آدرس یک محل سکونت است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

string

متن نام. به عنوان مثال، "5th Avenue" برای نام یک خیابان یا "1253" برای یک شماره خیابان.

string

کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان مرتبط نباشد، این مورد وجود نخواهد داشت.

LatLng

مکان جغرافیایی کد شده ورودی.

استفاده از شناسه‌های مکان بر استفاده از آدرس‌ها، مختصات طول و عرض جغرافیایی یا کدهای بعلاوه ترجیح داده می‌شود. استفاده از مختصات هنگام مسیریابی یا محاسبه مسیرهای رانندگی همیشه باعث می شود که نقطه به نزدیکترین جاده به آن مختصات گیر کند. ممکن است این جاده ای نباشد که به سرعت یا ایمن به مقصد منتهی شود و ممکن است نزدیک یک نقطه دسترسی به ملک نباشد. علاوه بر این، هنگامی که یک مکان معکوس جغرافیایی کدگذاری می شود، هیچ تضمینی وجود ندارد که آدرس برگشتی با آدرس اصلی مطابقت داشته باشد.

PlusCode

کد مثبت مربوط به location .

Viewport

محدوده مکان ژئوکد شده.

float

اندازه مکان ژئوکد شده، بر حسب متر. این یکی دیگر از معیارهای درشت بودن مکان جغرافیایی کد شده است، اما در اندازه فیزیکی به جای معنای معنایی.

string

شناسه مکان مکانی که این ورودی به آن کد جغرافیایی می‌دهد.

برای اطلاعات بیشتر درباره شناسه‌های مکان اینجا را ببینید.

string

نوع(های) مکانی که ورودی به آن کدگذاری شده است. برای مثال، ['locality', 'political'] . لیست کامل انواع را می توان در اینجا یافت.

bool

پیش نمایش: یک google.maps.addressvalidation.v1.Address را به انگلیسی برگردانید. برای جزئیات به google.maps.addressvalidation.v1.ValidationResult.english_latin_address مراجعه کنید.

string

کد جهانی (کامل) مکان، مانند "9FWM33GV+HQ"، که یک منطقه 1/8000 در 1/8000 درجه (~14 در 14 متر) را نشان می دهد.

string

کد ترکیبی Place، مانند "33GV+HQ، Ramberg، Norway"، حاوی پسوند کد جهانی و جایگزینی پیشوند با نام قالب بندی شده یک نهاد مرجع.

ValidationConclusion

مورد نیاز. نتیجه توالی تلاش‌های اعتبارسنجی

اگر این فیلد روی VALIDATION_CONCLUSION_UNSPECIFIED تنظیم شود، یک خطای INVALID_ARGUMENT برگردانده خواهد شد.

string

مورد نیاز. شناسه پاسخی که این بازخورد برای آن است. این باید [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] از اولین پاسخ در یک سری تلاش‌های اعتبارسنجی آدرس باشد.

string

خط اول آدرس

string

نام شرکت

string

خط آدرس دوم

string

نام شهرنشینی پورتوریکویی

string

شهر + ایالت + کد پستی.

string

نام شهر.

string

کد دولتی 2 حرفی

string

کد پستی به عنوان مثال 10009.

string

پسوند کد پستی 4 رقمی به عنوان مثال 5023.

UspsAddress

آدرس استاندارد USPS

string

کد نقطه تحویل 2 رقمی

string

رقم بررسی نقطه تحویل این شماره برای نامه های اسکن شده مکانیکی به انتهای بارکد_point_delivery اضافه می شود. با جمع کردن تمام ارقام بارکد_نقطه_تحویل، رقم_بررسی_نقطه_تحویل، کد پستی و ZIP+4 عددی قابل تقسیم بر 10 به دست می‌آید.

string

مقادیر ممکن برای تایید DPV. یک کاراکتر را برمی‌گرداند یا هیچ مقداری را برمی‌گرداند.

• N : اطلاعات اعداد اولیه و ثانویه تأیید DPV نشد.
• D : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه وجود نداشت.
• S : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه موجود بود اما تأیید نشد.
• Y : آدرس DPV برای شماره های اولیه و ثانویه تایید شد.
• خالی: اگر پاسخ حاوی مقدار dpv_confirmation نباشد، آدرس برای تایید DPV ارسال نشده است.

string

پاورقی از اعتبار سنجی نقطه تحویل. ممکن است چندین پاورقی در یک رشته به هم متصل شوند.

• AA : آدرس ورودی با فایل ZIP+4 مطابقت دارد
• A1 : آدرس ورودی با فایل ZIP+4 مطابقت نداشت
• BB : مطابق با DPV (همه اجزا)
• CC : شماره ثانویه مطابقت ندارد و لازم نیست
• C1 : شماره ثانویه مطابقت ندارد اما لازم است
• N1 : آدرس بلند مرتبه فاقد شماره ثانویه است
• M1 : شماره اولیه وجود ندارد
• M3 : شماره اصلی نامعتبر است
• P1 : آدرس ورودی PO، RR یا شماره جعبه HC موجود نیست
• P3 : آدرس ورودی PO، RR یا شماره جعبه HC نامعتبر است
• F1 : آدرس ورودی مطابق با یک آدرس نظامی است
• G1 : آدرس ورودی با یک آدرس تحویل عمومی مطابقت دارد
• U1 : آدرس ورودی مطابق با یک کد پستی منحصر به فرد
• PB : آدرس ورودی با رکورد PBSA مطابقت دارد
• RR : آدرس تأیید شده توسط DPV با اطلاعات PMB
• R1 : آدرس تایید شده DPV بدون اطلاعات PMB
• R7 : رکورد مسیر حامل R777 یا R779
• IA : آدرس آگاه شناسایی شد
• TA : عدد اولیه با حذف یک آلفای انتهایی مطابقت دارد

string

نشان می دهد که آیا آدرس یک CMRA (آژانس دریافت نامه های تجاری) است - یک کسب و کار خصوصی که نامه دریافت می کند برای مشتریان. یک کاراکتر را برمی‌گرداند.

• Y : آدرس یک CMRA است
• N : آدرس یک CMRA نیست

string

آیا این مکان خالی است؟ یک کاراکتر را برمی‌گرداند.

• Y : آدرس خالی است
• N : آدرس خالی نیست

string

آیا این یک آدرس بدون آمار است یا یک آدرس فعال؟ هیچ آدرس آماری، آدرس هایی نیستند که به طور مداوم اشغال نمی شوند یا آدرس هایی که USPS سرویس نمی دهد. یک کاراکتر را برمی‌گرداند.

• Y : آدرس فعال نیست
• N : آدرس فعال است

int32

نوع NoStat را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند.

• 1 : IDA (Internal Drop Address) - آدرس هایی که ایمیل را مستقیماً از USPS دریافت نمی کنند اما به آدرس drop تحویل داده می شوند که به آنها خدمات ارائه می دهد.
• 2 : CDS - آدرس هایی که هنوز قابل تحویل نیستند. به عنوان مثال، یک بخش فرعی جدید که در آن قطعات و اعداد اولیه تعیین شده است، اما هنوز ساختاری برای اشغال وجود ندارد.
• 3 : برخورد - آدرس هایی که در واقع DPV را تأیید نمی کنند.
• 4 : CMZ (کالج، نظامی و انواع دیگر) - ZIP + 4 رکورد USPS در داده ها گنجانده شده است.
• 5 : معمولی - نشان دهنده آدرس هایی است که تحویل دریافت نمی کنند و آدرس ها به عنوان تحویل های احتمالی محاسبه نمی شوند.
• 6 : ثانویه مورد نیاز - آدرس به اطلاعات ثانویه نیاز دارد.

string

پرچم نشان می‌دهد که نامه‌ها به یک مورد در یک سایت تحویل داده می‌شود. یک کاراکتر را برمی‌گرداند.

• Y : نامه به یک نفر در یک سایت تحویل داده می شود.
• N : نامه به یک فرد قابل دریافت در یک سایت تحویل داده نمی شود.

string

نشان می دهد که نامه به آدرس خیابان تحویل داده نمی شود. یک کاراکتر را برمی‌گرداند.

• Y : نامه به آدرس خیابان تحویل داده نمی شود.
• N : نامه به آدرس خیابان تحویل داده می شود.

string

پرچم نشان می دهد که تحویل نامه در هر روز هفته انجام نمی شود. یک کاراکتر را برمی‌گرداند.

• Y : تحویل پست هر روز هفته انجام نمی شود.
• N : هیچ نشانه ای وجود ندارد که تحویل نامه در هر روز هفته انجام نمی شود.

int32

تعداد صحیح شناسایی روزهای بدون تحویل با استفاده از پرچم‌های بیت قابل بازجویی است: 0x40 - یکشنبه یک روز بدون تحویل است 0x20 - دوشنبه یک روز بدون تحویل است 0x10 - سه‌شنبه یک روز بدون تحویل است 0x08 - چهارشنبه یک روز بدون تحویل است 0x04 - پنج‌شنبه یک روز بدون تحویل است 0x02 روز شنبه است - جمعه یک روز بدون تحویل است 0x02 - جمعه یک روز بدون تحویل است روز

string

پرچم نشان می دهد که درب قابل دسترسی است، اما بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند. یک کاراکتر را برمی‌گرداند.

• Y : بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند.
• N : هیچ نشانه ای وجود ندارد که بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند.

string

نشان می دهد که آدرس با رکورد PBSA مطابقت داده شده است. یک کاراکتر را برمی‌گرداند.

• Y : آدرس با رکورد PBSA مطابقت داشت.
• N : آدرس با رکورد PBSA مطابقت نداشت.

string

پرچم نشان‌دهنده آدرس‌هایی است که USPS نمی‌تواند برای تحویل نامه به درب بزند. یک کاراکتر را برمی‌گرداند.

• Y : در قابل دسترس نیست.
• N : هیچ نشانه ای وجود ندارد که درب قابل دسترسی نیست.

string

نشان می دهد که بیش از یک کد بازگشتی DPV برای آدرس معتبر است. یک کاراکتر را برمی‌گرداند.

• Y : آدرس DPV برای شماره های اولیه و ثانویه تایید شد.
• N : اطلاعات اعداد اولیه و ثانویه تأیید DPV نشد.
• S : آدرس فقط برای شماره اولیه DPV تأیید شد، و اطلاعات شماره ثانویه موجود بود اما تأیید نشد، یا یک آلفای انتهایی روی یک شماره اولیه حذف شد تا مطابقت DPV و اطلاعات ثانویه مورد نیاز باشد.
• D : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه وجود نداشت.
• R : آدرس تأیید شده است اما به مسیر فانتوم R777 و R779 اختصاص داده شده است و تحویل USPS ارائه نشده است.

string

کد مسیر حامل یک کد چهار کاراکتری متشکل از یک پیشوند یک حرفی و یک نشانگر مسیر سه رقمی.

پیشوندها:

• C : مسیر حامل (یا مسیر شهری)
• R : مسیر روستایی
• H : مسیر قرارداد بزرگراه
• B : بخش صندوق پست
• G : واحد تحویل عمومی

string

نشانگر مرتب‌سازی نرخ مسیر حامل.

bool

آدرس تحویل قابل تطبیق است، اما فایل EWS نشان می دهد که به زودی یک تطابق دقیق در دسترس خواهد بود.

string

شهر پست اصلی

string

ایالت اداره پست اصلی

string

شهر به اختصار.

string

کد شهرستان FIPS.

string

نام شهرستان.

string

شماره خط سفر پیشرفته (eLOT).

string

پرچم صعودی/نزولی eLOT (A/D).

string

کد بازگشت LACSlink.

string

نشانگر LACSLlink

bool

کد پستی فقط صندوق پستی

string

پاورقی از تطبیق یک خیابان یا رکورد بلند با اطلاعات مجموعه. اگر نام تجاری مطابقت پیدا شود، شماره ثانویه برگردانده می شود.

• A : مطابقت رکورد SuiteLink، آدرس کسب و کار بهبود یافته است.
• 00 : مطابقت ندارد، آدرس کسب و کار بهبود نیافته است.

string

تعیین کننده واحد PMB (جعبه پست خصوصی).

string

شماره PMB (صندوق پست خصوصی)؛

string

نوع رکورد آدرسی که با آدرس ورودی مطابقت دارد.

• F : شرکت. این تطبیق با یک سابقه شرکت است، که بهترین سطح تطابق موجود برای یک آدرس است.
• G : تحویل عمومی. این یک مسابقه با رکورد تحویل عمومی است.
• H : ساختمان / آپارتمان. این یک تطابق با رکورد ساختمان یا آپارتمان است.
• P : صندوق پستی. این مطابق با صندوق پستی است.
• R : قرارداد مسیر روستایی یا بزرگراه: این مطابق با رکورد یک مسیر روستایی یا یک قرارداد بزرگراه است، که هر دو ممکن است محدوده‌های Box Number مرتبط داشته باشند.
• S : STREET RECORD: این تطبیق با یک رکورد خیابانی است که دارای محدوده اعداد اولیه معتبر است.

bool

نشان می دهد که یک آدرس پیش فرض پیدا شده است، اما آدرس های خاص تری وجود دارد.

string

پیام خطا برای بازیابی اطلاعات USPS. زمانی که پردازش USPS به دلیل شناسایی آدرس‌های ایجاد شده مصنوعی به حالت تعلیق در می‌آید، پر می‌شود.

فیلدهای داده USPS ممکن است در صورت وجود این خطا پر نشوند.

bool

نشانگر این است که درخواست CASS پردازش شده است.

PostalAddress

مورد نیاز. آدرس در حال تایید است. آدرس های بدون قالب باید از طریق address_lines ارسال شوند.

طول کل فیلدهای این ورودی نباید از 280 کاراکتر تجاوز کند.

مناطق پشتیبانی شده را می توانید در اینجا پیدا کنید.

مقدار language_code در آدرس ورودی برای استفاده های بعدی محفوظ است و امروز نادیده گرفته می شود. نتیجه آدرس تأیید شده بر اساس زبان ترجیحی برای آدرس داده شده، همانطور که توسط سیستم شناسایی شده است، پر می شود.

Address Validation API مقادیر موجود در recipients و organization را نادیده می گیرد. هر مقدار در آن فیلدها کنار گذاشته می شود و برگردانده نمی شود. لطفا آنها را تنظیم نکنید.

string

این فیلد باید برای اولین درخواست اعتبارسنجی آدرس خالی باشد. اگر درخواست‌های بیشتری برای اعتبارسنجی کامل یک آدرس ضروری باشد (مثلاً اگر تغییراتی که کاربر پس از اعتبارسنجی اولیه ایجاد می‌کند نیاز به تأیید مجدد داشته باشد)، آن‌وقت هر درخواست پیگیری باید از همان اولین پاسخ در دنباله اعتبارسنجی، این فیلد را با response_id پر کند.

bool

حالت سازگار با USPS CASS را فعال می کند. این فقط فیلد google.maps.addressvalidation.v1.ValidationResult.usps_data google.maps.addressvalidation.v1.ValidationResult را تحت تأثیر قرار می دهد. توجه: برای درخواست‌های دارای USPS CASS برای آدرس‌هایی در پورتوریکو، یک address google.type.PostalAddress.region_code باید به‌عنوان "PR" ارائه شود، یا یک google.type.PostalAddress.administrative_area از address باید به‌عنوان "پورتوریکو" (بدون حروف کوچک) یا "PR" ارائه شود.

توصیه می شود از یک address کامپوننت شده استفاده کنید، یا حداقل دو google.type.PostalAddress.address_lines را مشخص کنید که در آن خط اول شامل شماره و نام خیابان و خط دوم شامل شهر، ایالت و کد پستی باشد.

LanguageOptions

اختیاری. Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

Address Validation API را فعال می کند تا اطلاعات بیشتری را در پاسخ اضافه کند.

string

اختیاری. رشته ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می کند. باید یک URL و نام فایل ایمن رشته base64 با حداکثر 36 کاراکتر اسکی باشد. در غیر این صورت یک خطای INVALID_ARGUMENT برگردانده می شود.

جلسه زمانی شروع می شود که کاربر یک پرس و جو تکمیل خودکار انجام می دهد، و زمانی که یک مکان را انتخاب می کند و تماسی با جزئیات مکان یا اعتبارسنجی آدرس برقرار می شود، به پایان می رسد. هر جلسه می‌تواند چندین پرس‌وجو تکمیل خودکار داشته باشد و به دنبال آن یک درخواست جزییات مکان یا اعتبارسنجی آدرس ارائه شود. اعتبار استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان جلسه، رمز دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر sessionToken حذف شود، یا اگر از یک نشانه جلسه استفاده مجدد کنید، هزینه جلسه به گونه ای محاسبه می شود که گویی هیچ نشانه جلسه ارائه نشده است (هر درخواست جداگانه صورتحساب می شود).

توجه: اعتبار آدرس فقط در جلسات با API تکمیل خودکار (جدید) قابل استفاده است، نه API تکمیل خودکار. برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/session-pricing مراجعه کنید.

ValidationResult

نتیجه اعتبار سنجی آدرس

string

UUID که این پاسخ را شناسایی می کند. اگر آدرس نیاز به تأیید مجدد داشته باشد، این UUID باید درخواست جدید را همراهی کند.

Verdict

پرچم های حکم کلی

Address

اطلاعات مربوط به خود آدرس بر خلاف ژئوکد.

Geocode

اطلاعات مربوط به مکان و مکانی که آدرس به آن کد جغرافیایی داده است.

AddressMetadata

سایر اطلاعات مربوط به قابلیت تحویل metadata برای هر آدرسی که به Address Validation API ارسال می شود، تضمین نمی شود.

UspsData

پرچم های تحویل اضافی ارائه شده توسط USPS. فقط در منطقه US و PR ارائه شده است.

Address

Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

آدرس به انگلیسی ترجمه شده است.

آدرس های ترجمه شده به عنوان ورودی API قابل استفاده مجدد نیستند. این سرویس آنها را فراهم می کند تا کاربر بتواند از زبان مادری خود برای تأیید یا رد اعتبار آدرس ارائه شده اصلی استفاده کند.

اگر بخشی از آدرس دارای ترجمه انگلیسی نباشد، سرویس آن قسمت را به زبان دیگری که از خط لاتین استفاده می کند، برمی گرداند. برای توضیح نحوه انتخاب زبان جایگزین اینجا را ببینید. اگر بخشی از آدرس به زبانی که از خط لاتین استفاده می‌کند ترجمه یا نویسه‌گردانی نداشته باشد، سرویس آن قسمت را به زبان محلی مرتبط با آدرس برمی‌گرداند.

این خروجی را با استفاده از پرچم google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address فعال کنید.

توجه: فیلد google.maps.addressvalidation.v1.Address.unconfirmed_component_types در english_latin_address و فیلدهای google.maps.addressvalidation.v1.AddressComponent.confirmation_level در english_latin_address.address_components پر نشده است.

Granularity

جزئیات آدرس ورودی این نتیجه تجزیه آدرس ورودی است و هیچ سیگنال اعتبار سنجی نمی دهد. برای سیگنال های اعتبارسنجی، به validation_granularity زیر مراجعه کنید.

برای مثال، اگر آدرس ورودی شامل یک شماره آپارتمان خاص باشد، input_granularity در اینجا SUB_PREMISE خواهد بود. اگر نتوانیم شماره آپارتمان را در پایگاه‌های داده مطابقت دهیم یا شماره آپارتمان نامعتبر باشد، validation_granularity احتمالا PREMISE یا پایین‌تر خواهد بود.

Granularity

سطح دانه بندی که API می تواند آدرس را به طور کامل تأیید کند . به عنوان مثال، یک validation_granularity از PREMISE نشان می دهد که تمام اجزای آدرس در سطح PREMISE یا بیشتر درشت می توانند اعتبار سنجی شوند.

نتیجه تأیید مؤلفه هر آدرس را می‌توانید در google.maps.addressvalidation.v1.Address.address_components پیدا کنید.

Granularity

اطلاعات در مورد دانه بندی geocode . این را می توان به عنوان معنای معنایی درشت یا ظریف بودن مکان جغرافیایی درک کرد.

این ممکن است با validation_granularity بالا گاهی اوقات متفاوت باشد. به عنوان مثال، پایگاه داده ما ممکن است وجود یک شماره آپارتمان را ثبت کند اما مکان دقیقی برای آپارتمان در یک مجتمع آپارتمانی بزرگ نداشته باشد. در آن صورت، validation_granularity SUB_PREMISE خواهد بود اما geocode_granularity PREMISE خواهد بود.

bool

اگر هیچ نشانه حل نشده، هیچ مؤلفه آدرس غیرمنتظره یا گم نشده ای وجود نداشته باشد، آدرس کامل در نظر گرفته می شود. اگر تنظیم نشده باشد، نشان می دهد که مقدار false است. برای جزئیات بیشتر به missing_component_types ، unresolved_tokens یا فیلدهای unexpected مراجعه کنید.

bool

حداقل یک جزء آدرس را نمی توان طبقه بندی یا تأیید کرد، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

bool

حداقل یک جزء آدرس استنباط شد (اضافه شد) که در ورودی نبود، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

bool

حداقل یک جزء آدرس جایگزین شده است، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

string

آدرس پس از پردازش، به عنوان یک آدرس تک خطی با پیروی از قوانین قالب‌بندی آدرس منطقه‌ای که آدرس در آن قرار دارد، قالب‌بندی شده است.

توجه: فرمت این آدرس ممکن است با فرمت آدرس در قسمت postal_address مطابقت نداشته باشد. برای مثال، postal_address همیشه کشور را به‌عنوان یک region_code ۲ حرفی، مانند «US» یا «NZ» نشان می‌دهد. در مقابل، این فیلد از شکل طولانی‌تری از نام کشور مانند «USA» یا «نیوزیلند» استفاده می‌کند.

PostalAddress

آدرس پس از پردازش به عنوان یک آدرس پستی نشان داده شده است.

AddressComponent

لیست نامرتب اجزای آدرس منفرد آدرس فرمت شده و تصحیح شده، همراه با اطلاعات اعتبارسنجی. این اطلاعات در مورد وضعیت اعتبار سنجی اجزای جداگانه ارائه می دهد.

اجزای آدرس به روش خاصی مرتب نمی شوند. هیچ گونه فرضی در مورد ترتیب اجزای آدرس در لیست انجام ندهید.

string

انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی با فرمت صحیح وجود داشته باشند اما در ورودی و یافت نشدند قابل استنباط نیستند. یک مثال ممکن است ['street_number', 'route'] برای ورودی مانند "Boulder, Colorado, 80301, USA" باشد. لیست انواع ممکن را می توان در اینجا یافت.

توجه: زمانی که فکر می کنید قبلاً جزء گم شده را تهیه کرده اید، ممکن است یک نوع مؤلفه گم شده را ببینید. به عنوان مثال، این ممکن است زمانی اتفاق بیفتد که آدرس ورودی حاوی نام ساختمان باشد، اما نه شماره مقدمات. در آدرس "渋谷区渋谷３丁目 Shibuya Stream"، نام ساختمان "Shibuya Stream" دارای premise نوع مؤلفه است، اما شماره فرض وجود ندارد، بنابراین missing_component_types حاوی premise خواهد بود.

string

انواع مؤلفه‌هایی که در address_components وجود دارند، اما صحت آن‌ها تأیید نشد. این فیلد به منظور راحتی ارائه شده است: محتویات آن معادل تکرار از طریق address_components برای یافتن انواع همه مؤلفه‌هایی است که در آن سطح confirmation_level CONFIRMED نشده است یا پرچم inferred روی true تنظیم نشده است. لیست انواع ممکن را می توان در اینجا یافت.

string

هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد. به عنوان مثال، برای ورودی‌هایی مانند «Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US»، نشانه‌های حل‌نشده ممکن است مانند ["Parcel", "0000123123", "&", "0000456456"] باشند.

ComponentName

نام این جزء

string

نوع جزء آدرس جدول 2 را ببینید: انواع اضافی که توسط سرویس Places برگردانده شده است برای لیستی از انواع احتمالی.

ConfirmationLevel

نشان دهنده میزان اطمینانی است که ما در مورد صحیح بودن مؤلفه داریم.

bool

نشان می دهد که مؤلفه بخشی از ورودی نبوده است، اما ما آن را برای مکان آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود.

bool

تصحیح یک غلط املایی در نام مؤلفه را نشان می دهد. API همیشه تغییرات را از یک نوع املایی به دیگری علامت گذاری نمی کند، مانند زمانی که "مرکز" به "مرکز" تغییر می کند. همچنین همیشه اشتباهات املایی رایج را علامت گذاری نمی کند، مانند زمانی که "Amphitheatre Pkwy" را به "Amphitheatre Pkwy" تغییر می دهید.

bool

نشان می دهد که نام مؤلفه با یک نام کاملاً متفاوت جایگزین شده است، به عنوان مثال یک کد پستی اشتباه با کدی که برای آدرس صحیح است جایگزین شده است. این یک تغییر زیبایی نیست، جزء ورودی به دیگری تغییر کرده است.

bool

یک جزء آدرس را نشان می دهد که انتظار نمی رود در آدرس پستی منطقه داده شده وجود داشته باشد. ما آن را فقط به این دلیل حفظ کرده ایم که بخشی از ورودی بوده است.

bool

نشان می دهد که این آدرس یک کسب و کار است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

bool

نشان می دهد که آدرس یک صندوق پستی. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

bool

نشان می دهد که این آدرس یک محل سکونت است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

string

متن نام. به عنوان مثال، "5th Avenue" برای نام یک خیابان یا "1253" برای یک شماره خیابان.

string

کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان مرتبط نباشد، این مورد وجود نخواهد داشت.

LatLng

مکان جغرافیایی کد شده ورودی.

استفاده از شناسه‌های مکان بر استفاده از آدرس‌ها، مختصات طول و عرض جغرافیایی یا کدهای بعلاوه ترجیح داده می‌شود. استفاده از مختصات هنگام مسیریابی یا محاسبه مسیرهای رانندگی همیشه باعث می شود که نقطه به نزدیکترین جاده به آن مختصات گیر کند. ممکن است این جاده ای نباشد که به سرعت یا ایمن به مقصد منتهی شود و ممکن است نزدیک یک نقطه دسترسی به ملک نباشد. علاوه بر این ، هنگامی که یک مکان معکوس Geocoded است ، هیچ تضمینی وجود ندارد که آدرس برگشتی با اصل مطابقت داشته باشد.

PlusCode

کد به علاوه مربوط به location .

Viewport

مرزهای مکان جغرافیایی.

float

اندازه مکان جغرافیایی ، در متر. این یکی دیگر از معیارهای درشت مکان جغرافیایی است ، اما در اندازه فیزیکی و نه به معنای معنایی.

string

مکانید مکانی که این ورودی جغرافیایی می کند.

برای اطلاعات بیشتر در مورد شناسه های مکان ، اینجا را ببینید.

string

نوع (های) مکانی که ورودی از آن استفاده می کند. به عنوان مثال ، ['locality', 'political'] . لیست کامل انواع را می توان در اینجا یافت.

bool

پیش نمایش: یک google.maps.addressvalidation.v1.Address را به زبان انگلیسی برگردانید. برای جزئیات بیشتر به google.maps.addressvalidation.v1.ValidationResult.english_latin_address مراجعه کنید.

string

کد جهانی (کامل) مکان ، مانند "9FWM33GV+HQ" ، نماینده 1/8000 در منطقه 1/8000 درجه (14 پوند در 14 متر).

string

کد مرکب Place مانند "33GV+HQ ، RAMBERG ، نروژ" ، حاوی پسوند کد جهانی و جایگزین کردن پیشوند با نام فرمت یک موجود مرجع.

ValidationConclusion

مورد نیاز. نتیجه توالی تلاش های اعتبار سنجی.

اگر این قسمت بر روی VALIDATION_CONCLUSION_UNSPECIFIED تنظیم شده باشد ، یک خطای INVALID_ARGUMENT بازگردانده می شود.

string

مورد نیاز. شناسه پاسخی که این بازخورد برای آن وجود دارد. این باید [پاسخ_] [google.maps.addressvalidation.v1.validateaddressrequest.response_id] از اولین پاسخ در یک سری از تلاش های اعتبار سنجی آدرس باشد.

string

خط آدرس اول.

string

نام محکم

string

خط آدرس دوم.

string

نام شهرنشینی پورتوریکو.

string

شهر + ایالت + کد پستی.

string

نام شهر.

string

2 کد دولت.

string

کد پستی به عنوان مثال 10009.

string

پسوند کد پستی 4 رقمی EG 5023.

UspsAddress

آدرس استاندارد USPS.

string

کد نقطه تحویل 2 رقمی

string

رقم بررسی نقطه تحویل. این شماره برای نامه های اسکن شده مکانیکی به انتهای تحویل_point_barcode اضافه می شود. اضافه کردن تمام رقم های تحویل_point_barcode ، تحویل_point_check_digit ، کد پستی و ZIP+4 با هم باید یک عدد قابل تقسیم تا 10 باشد.

string

مقادیر ممکن برای تأیید DPV. یک شخصیت واحد را برمی گرداند یا هیچ ارزش را برمی گرداند.

• N : اطلاعات اولیه و هر شماره ثانویه در DPV تأیید نشد.
• D : آدرس DPV فقط برای شماره اصلی تأیید شد و اطلاعات شماره ثانویه از دست رفته بود.
• S : آدرس DPV فقط برای شماره اصلی تأیید شد ، و اطلاعات شماره ثانویه موجود بود اما تأیید نشده است.
• Y : آدرس DPV برای شماره های اولیه و ثانویه تأیید شد.
• خالی: اگر پاسخ حاوی مقدار dpv_confirmation نباشد ، آدرس برای تأیید DPV ارسال نشده است.

string

پاورقی ها از اعتبارسنجی نقطه تحویل. پاورقی های چندگانه ممکن است در همان رشته با هم جمع شوند.

• AA : آدرس ورودی با پرونده ZIP+4 مطابقت دارد
• A1 : آدرس ورودی با پرونده ZIP+4 مطابقت نداشت
• BB : مطابق با DPV (همه مؤلفه ها)
• CC : تعداد ثانویه مطابقت ندارد و لازم نیست
• C1 : تعداد ثانویه مطابقت ندارد اما مورد نیاز است
• N1 : آدرس بالایی که شماره ثانویه وجود ندارد
• M1 : تعداد اولیه از دست رفته است
• M3 : شماره اولیه نامعتبر است
• P1 : آدرس ورودی PO ، RR یا شماره جعبه HC از دست رفته است
• P3 : آدرس ورودی PO ، RR یا شماره جعبه HC نامعتبر است
• F1 : آدرس ورودی با یک آدرس نظامی مطابقت دارد
• G1 : آدرس ورودی با یک آدرس تحویل عمومی مطابقت دارد
• U1 : آدرس ورودی با یک کد پستی منحصر به فرد مطابقت دارد
• PB : آدرس ورودی با رکورد PBSA مطابقت دارد
• RR : آدرس DPV با اطلاعات PMB تأیید شد
• R1 : DPV آدرس تأیید شده بدون اطلاعات PMB
• R7 : رکورد حامل مسیر R777 یا R779
• IA : آدرس آگاهانه شناسایی شده است
• TA : شماره اصلی با رها کردن یک آلفا دنباله دار مطابقت دارد

string

نشان می دهد که آیا آدرس یک CMRA است (آژانس دریافت کننده نامه تجاری)-یک مشاغل خصوصی که برای مشتری نامه دریافت می کند. یک شخصیت واحد را برمی گرداند.

• Y : آدرس CMRA است
• N : آدرس CMRA نیست

string

آیا این مکان خالی است؟ یک شخصیت واحد را برمی گرداند.

• Y : آدرس خالی است
• N : آدرس خالی نیست

string

آیا این یک آدرس stat یا آدرس فعال است؟ هیچ آدرس آماری مواردی نیست که به طور مداوم اشغال نشده باشد یا آدرس هایی را که USPS ارائه نمی دهد ، آدرس دهد. یک شخصیت واحد را برمی گرداند.

• Y : آدرس فعال نیست
• N : آدرس فعال است

int32

نوع نوستات را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند.

• 1 : IDA (آدرس افت داخلی) - آدرس هایی که مستقیماً از طریق USP ها نامه دریافت نمی کنند اما به آدرس قطره ای که به آنها خدمات می دهد تحویل داده می شوند.
• 2 : CDS - آدرس هایی که هنوز تحویل داده نشده اند. به عنوان مثال ، یک زیر مجموعه جدید که تعداد زیادی از آنها و تعداد اصلی مشخص شده است ، اما هنوز هیچ ساختاری برای اشغال وجود ندارد.
• 3 : برخورد - آدرس هایی که در واقع DPV نیستند.
• 4 : CMZ (کالج ، نظامی و انواع دیگر) - ZIP + 4 سوابق USPS در داده ها گنجانیده شده است.
• 5 : منظم - آدرس های دریافت کننده تحویل را نشان می دهد و آدرس ها به عنوان زایمان های احتمالی شمرده نمی شوند.
• 6 : مورد نیاز ثانویه - آدرس به اطلاعات ثانویه نیاز دارد.

string

پرچم نشان می دهد که نامه به یک گیرنده در یک سایت تحویل داده می شود. یک شخصیت واحد را برمی گرداند.

• Y : نامه به یک گیرنده در یک سایت تحویل داده می شود.
• N : نامه به یک گیرنده در یک سایت تحویل داده نمی شود.

string

نشان می دهد که نامه به آدرس خیابان تحویل داده نمی شود. یک شخصیت واحد را برمی گرداند.

• Y : نامه به آدرس خیابان تحویل داده نمی شود.
• N : نامه به آدرس خیابان تحویل داده می شود.

string

پرچم نشان می دهد که تحویل نامه هر روز از هفته انجام نمی شود. یک شخصیت واحد را برمی گرداند.

• Y : تحویل نامه هر روز از هفته انجام نمی شود.
• N : هیچ نشانه ای از تحویل نامه هر روز از هفته انجام نمی شود.

int32

عدد صحیح شناسایی روزهای غیر تحویل. با استفاده از پرچم های بیت می توان مورد بازجویی قرار گرفت: 0x40-یکشنبه یک روز غیر تحویل 0x20 است-دوشنبه یک روز غیر تحویل 0x10 است-سه شنبه یک روز غیر تحویل 0x08 است-چهارشنبه یک روز غیر تحویل 0x04 است-پنجشنبه یک روز غیر تحویل 0x02 است-جمعه یک روز غیر تحویل است 0x01-شنبه غیرقانونی است. روز

string

پرچم نشان می دهد که درب در دسترس است ، اما به دلیل نگرانی های امنیتی ، بسته باقی نمی ماند. یک شخصیت واحد را برمی گرداند.

• Y : بسته به دلیل نگرانی های امنیتی باقی نمی ماند.
• N : هیچ نشانه ای از بسته به دلیل نگرانی های امنیتی باقی نمی ماند.

string

نشان می دهد که آدرس با رکورد PBSA مطابقت داشت. یک شخصیت واحد را برمی گرداند.

• Y : آدرس با رکورد PBSA مطابقت داشت.
• N : آدرس با رکورد PBSA مطابقت نداشت.

string

پرچم آدرس هایی را نشان می دهد که USPS برای تحویل نامه نمی تواند در را بکشد. یک شخصیت واحد را برمی گرداند.

• Y : درب در دسترس نیست.
• N : هیچ نشانه ای در دسترس نیست.

string

نشان می دهد که بیش از یک کد بازگشت DPV برای آدرس معتبر است. یک شخصیت واحد را برمی گرداند.

• Y : آدرس DPV برای شماره های اولیه و ثانویه تأیید شد.
• N : اطلاعات اولیه و هر شماره ثانویه در DPV تأیید نشد.
• S : آدرس فقط برای شماره اصلی DPV تأیید شد ، و اطلاعات شماره ثانویه در حال حاضر وجود داشت اما تأیید نشده بود ، یا یک آلفا دنباله دار روی یک شماره اصلی کاهش یافت تا یک مسابقه DPV و اطلاعات ثانویه مورد نیاز باشد.
• D : آدرس DPV فقط برای شماره اصلی تأیید شد و اطلاعات شماره ثانویه از دست رفته بود.
• R : آدرس تأیید شده اما به مسیر فانتوم R777 و R779 و تحویل USPS اختصاص داده شده است.

string

کد مسیر حامل. یک کد چهار کاراکتر متشکل از پیشوند یک حرف و یک طراح مسیر سه رقمی.

پیشوندها:

• C : مسیر حامل (یا مسیر شهر)
• R : مسیر روستایی
• H : مسیر قرارداد بزرگراه
• B : بخش صندوق پستی
• G : واحد تحویل عمومی

string

نشانگر مرتب سازی نرخ مسیر حامل.

bool

آدرس تحویل قابل مطابقت است ، اما پرونده EWS نشان می دهد که یک مسابقه دقیق به زودی در دسترس خواهد بود.

string

اداره اصلی اداره پست.

string

ایالت اصلی اداره پست.

string

شهر مختصر.

string

کد شهرستان FIPS.

string

نام شهرستان

string

شماره پیشرفته خط سفر (ELOT).

string

پرچم صعودی/نزولی (A/D).

string

کد بازگشت LACSLINK.

string

نشانگر lacslink.

bool

فقط کد پستی جعبه PO.

string

پاورقی ها از مطابقت با یک خیابان یا رکورد Highrise تا اطلاعات مجموعه. اگر نام تجاری نام تجاری پیدا شود ، شماره ثانویه بازگردانده می شود.

• A : مسابقه ضبط SuitElink ، آدرس کسب و کار بهبود یافته است.
• 00 : بدون مطابقت ، آدرس کسب و کار بهبود نمی یابد.

string

PMB (جعبه پستی خصوصی) طراح واحد.

string

شماره PMB (جعبه پستی خصوصی) شماره ؛

string

نوع ضبط آدرس که مطابق با آدرس ورودی است.

• F : محکم. این یک مسابقه با یک رکورد محکم است که بهترین سطح مسابقه برای یک آدرس است.
• G : تحویل عمومی. این مسابقه با یک رکورد تحویل عمومی است.
• H : ساختمان / آپارتمان. این مسابقه با یک ساختمان یا رکورد آپارتمان است.
• P : صندوق پستی. این مسابقه با یک صندوق پستی است.
• R : مسیر روستایی یا قرارداد بزرگراه: این یک مسابقه برای یک مسیر روستایی یا یک رکورد قرارداد بزرگراه است که هر دو ممکن است دارای تعداد جعبه های مرتبط باشند.
• S : Street Record: این یک مسابقه با یک رکورد خیابانی است که حاوی دامنه شماره اصلی معتبر است.

bool

نشانگر مبنی بر یافتن آدرس پیش فرض ، اما آدرس های خاص تری وجود دارد.

string

پیام خطا برای بازیابی داده های USPS. این امر در شرایطی جمع می شود که پردازش USPS به دلیل تشخیص آدرس های مصنوعی ایجاد شده به حالت تعلیق در می آید.

قسمتهای داده USPS ممکن است در صورت وجود این خطا جمع نشود.

bool

نشانگر این است که درخواست CASS پردازش شده است.

PostalAddress

مورد نیاز. آدرس معتبر آدرس های بدون شکل باید از طریق address_lines ارسال شوند.

طول کل قسمت های این ورودی نباید از 280 کاراکتر تجاوز کند.

مناطق پشتیبانی شده را می توان در اینجا یافت.

مقدار language_code در آدرس ورودی برای مصارف آینده محفوظ است و امروزه نادیده گرفته می شود. نتیجه آدرس معتبر بر اساس زبان ترجیحی برای آدرس داده شده ، همانطور که توسط سیستم مشخص شده است ، جمع می شود.

API اعتبارسنجی آدرس مقادیر موجود در recipients و organization را نادیده می گیرد. هر مقداری در آن زمینه ها دور ریخته می شوند و بازگردانده نمی شوند. لطفا آنها را تنظیم نکنید.

string

این قسمت باید برای اولین درخواست اعتبارسنجی آدرس خالی باشد. اگر درخواست های بیشتری برای تأیید کامل یک آدرس واحد ضروری است (به عنوان مثال اگر تغییراتی که کاربر پس از اعتبار اولیه ایجاد می کند نیاز به اعتبار مجدد داشته باشد) ، پس هر درخواست پیگیری باید این قسمت را با response_id از اولین پاسخ در دنباله اعتبار سنجی جمع کند.

bool

حالت سازگار با CASS USPS را فعال می کند. این فقط روی google.maps.addressvalidation.v1.ValidationResult.usps_data از google.maps.addressvalidation.v1.ValidationResult تأثیر می گذارد. توجه: برای USPS CASS درخواست هایی google.type.PostalAddress.administrative_area برای آدرس در پورتوریکو address یک google.type.PostalAddress.region_code address باید به عنوان "pr" ارائه دهد.

توصیه می شود از یک address مؤلفه استفاده کنید ، یا در عوض حداقل دو google.type.PostalAddress.address_lines را مشخص کنید که در آن خط اول حاوی شماره و نام خیابان و خط دوم حاوی کد شهر ، ایالت و کد است.

LanguageOptions

اختیاری. پیش نمایش: این ویژگی در پیش نمایش (پیش GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

API اعتبارسنجی آدرس را قادر می سازد تا اطلاعات اضافی را در پاسخ درج کند.

string

اختیاری. رشته ای که یک جلسه خودکار را برای اهداف صورتحساب مشخص می کند. باید یک URL و نام پرونده FileName Safe Base64 با حداکثر 36 کاراکتر ASCII باشد. در غیر این صورت یک خطای نامعتبر_ارگنت بازگردانده می شود.

جلسه زمانی شروع می شود که کاربر یک پرس و جو خودکار را ارائه می دهد و نتیجه می گیرد که آنها یک مکان را انتخاب می کنند و یک تماس برای قرار دادن جزئیات یا اعتبارسنجی آدرس انجام می شود. هر جلسه می تواند چندین نمایش داده شده خودکار داشته باشد ، و به دنبال آن جزئیات یک مکان یا درخواست اعتبارسنجی آدرس. اعتبار مورد استفاده برای هر درخواست در یک جلسه باید متعلق به همان پروژه کنسول Google Cloud باشد. پس از پایان جلسه ، این نشانه دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک نشانه تازه ایجاد کند. اگر پارامتر sessionToken حذف شود ، یا اگر از یک جلسه جلسه استفاده مجدد می کنید ، جلسه به نظر می رسد که هیچ نشانه ای از جلسه ارائه نشده است (هر درخواست به طور جداگانه صورتحساب می شود).

توجه: اعتبارسنجی آدرس فقط در جلسات با API خودکار (جدید) قابل استفاده است ، نه API خودکار. برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/session-pricing مراجعه کنید.

ValidationResult

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

string

UUID که این پاسخ را مشخص می کند. اگر آدرس نیاز به اعتبار مجدد داشته باشد ، این UUID باید با درخواست جدید همراه باشد.

Verdict

پرچم های حکم کلی

Address

اطلاعات مربوط به خود آدرس بر خلاف GeoCode.

Geocode

اطلاعات مربوط به مکان و مکانی که آدرس به آن Geocododed می شود.

AddressMetadata

سایر اطلاعات مربوط به تحویل. metadata تضمین نمی شود که برای هر آدرس ارسال شده به API اعتبارسنجی آدرس کاملاً جمع شود.

UspsData

پرچم های تحویل اضافی ارائه شده توسط USPS. فقط در منطقه US و PR ارائه شده است.

Address

پیش نمایش: این ویژگی در پیش نمایش (پیش GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

آدرس ترجمه شده به انگلیسی.

آدرس های ترجمه شده به عنوان ورودی API قابل استفاده مجدد نیستند. این سرویس آنها را فراهم می کند تا کاربر بتواند از زبان مادری خود برای تأیید یا انکار اعتبار آدرس اصلی ارائه شده استفاده کند.

اگر بخشی از آدرس دارای ترجمه انگلیسی نباشد ، این سرویس آن قسمت را به یک زبان متناوب باز می گرداند که از یک اسکریپت لاتین استفاده می کند. برای توضیح نحوه انتخاب زبان متناوب اینجا را ببینید. اگر بخشی از آدرس هیچ ترجمه یا ترجمه ای به زبانی که از یک اسکریپت لاتین استفاده می کند ، ندارد ، این سرویس آن قسمت را به زبان محلی مرتبط با آدرس باز می گرداند.

این خروجی را با استفاده از google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address فعال کنید.

توجه: قسمت google.maps.addressvalidation.v1.Address.unconfirmed_component_types در english_latin_address و google.maps.addressvalidation.v1.AddressComponent.confirmation_level در زمینه های english_latin_address.address_components وجود ندارد.

Granularity

دانه بندی آدرس ورودی . این نتیجه تجزیه و تحلیل آدرس ورودی است و هیچ سیگنال اعتبار سنجی نمی دهد. برای سیگنال های اعتبار سنجی ، به validation_granularity در زیر مراجعه کنید.

به عنوان مثال ، اگر آدرس ورودی شامل یک شماره آپارتمان خاص باشد ، در این صورت input_granularity در اینجا SUB_PREMISE خواهد بود. اگر نتوانیم با شماره آپارتمان در پایگاه داده ها مطابقت داشته باشیم یا شماره آپارتمان نامعتبر باشد ، validation_granularity احتمالاً PREMISE یا پایین تر خواهد بود.

Granularity

سطح دانه ای که API می تواند آدرس را به طور کامل تأیید کند . به عنوان مثال ، یک validation_granularity PREMISE نشان می دهد که کلیه مؤلفه های آدرس در سطح PREMISE یا درشت تر می توانند تأیید شوند.

نتیجه اعتبار سنجی مؤلفه آدرس را می توان در google.maps.addressvalidation.v1.Address.address_components یافت.

Granularity

اطلاعات مربوط به دانه بندی geocode . این را می توان به عنوان معنای معنایی از مکان درشت یا خوب مکان جغرافیایی درک کرد.

این می تواند با validation_granularity بالا گاهی اوقات متفاوت باشد. به عنوان مثال ، پایگاه داده ما ممکن است وجود یک شماره آپارتمان را ثبت کند اما مکان دقیقی برای آپارتمان در یک مجتمع بزرگ آپارتمان ندارد. در این حالت ، validation_granularity SUB_PREMISE خواهد بود اما geocode_granularity PREMISE خواهد بود.

bool

در صورت عدم وجود نشانه های حل نشده ، هیچ مؤلفه آدرس غیر منتظره یا گمشده ، آدرس کامل در نظر گرفته می شود. در صورت عدم استفاده ، نشان می دهد که مقدار false است. برای اطلاعات بیشتر به missing_component_types ، unresolved_tokens یا زمینه های unexpected مراجعه کنید.

bool

حداقل یک مؤلفه آدرس را نمی توان طبقه بندی یا تأیید کرد ، برای جزئیات بیشتر به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

bool

حداقل یک مؤلفه آدرس استنباط شد (اضافه شده) که در ورودی نبود ، برای جزئیات بیشتر به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

bool

حداقل یک مؤلفه آدرس جایگزین شد ، برای جزئیات بیشتر به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

string

آدرس پس از پردازش ، به عنوان یک آدرس یک خط به دنبال قوانین قالب بندی آدرس منطقه که آدرس در آن قرار دارد ، قالب بندی شده است.

توجه: قالب این آدرس ممکن است با فرمت آدرس در قسمت postal_address مطابقت نداشته باشد. به عنوان مثال ، postal_address همیشه کشور را به عنوان یک region_code 2 حرفی مانند "ما" یا "NZ" نشان می دهد. در مقابل ، این زمینه از شکل طولانی تر از نام کشور مانند "ایالات متحده" یا "نیوزیلند" استفاده می کند.

PostalAddress

آدرس پس از پردازش به عنوان یک آدرس پستی ارائه شده است.

AddressComponent

لیست بدون هماهنگ. مؤلفه های آدرس فردی آدرس فرمت شده و اصلاح شده ، به همراه اطلاعات اعتبار سنجی. این اطلاعات در مورد وضعیت اعتبار سنجی مؤلفه های فردی را ارائه می دهد.

مؤلفه های آدرس به روشی خاص سفارش داده نمی شوند. هیچ فرضیه ای در مورد سفارش اجزای آدرس در لیست انجام ندهید.

string

انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی به درستی فرمت شده وجود داشته باشد اما در ورودی یافت نشد و قابل استنباط نیست. یک مثال ممکن است ['street_number', 'route'] برای ورودی مانند "بولدر ، کلرادو ، 80301 ، ایالات متحده" باشد. لیست انواع ممکن را می توان در اینجا یافت.

توجه: وقتی فکر می کنید که قبلاً مؤلفه گمشده را تهیه کرده اید ، ممکن است یک نوع مؤلفه گمشده را مشاهده کنید. به عنوان مثال ، این می تواند زمانی اتفاق بیفتد که آدرس ورودی حاوی نام ساختمان باشد ، اما شماره فرض نیست. در آدرس "渋谷区渋谷３丁目 shibuya stream" ، نام ساختمان "Shibuya Stream" دارای premise نوع مؤلفه است ، اما شماره پیش فرض از دست رفته است ، بنابراین missing_component_types حاوی premise خواهد بود.

string

انواع مؤلفه هایی که در address_components وجود دارند اما نمی توانند صحیح باشند. این زمینه به خاطر راحتی ارائه شده است: محتوای آن معادل تکرار از طریق address_components است تا انواع اجزای موجود در آن را پیدا کنید که confirmation_level CONFIRMED نشده باشد یا پرچم inferred true تنظیم نشده باشد. لیست انواع ممکن را می توان در اینجا یافت.

string

هر نشانه ای در ورودی که قابل حل نیست. این ممکن است ورودی باشد که به عنوان یک قسمت معتبر از یک آدرس شناخته نشده است. به عنوان مثال ، برای ورودی مانند "Parcel 0000123123 & 0000456456 STR # Guthrie Center IA 50115 US" ، نشانه های حل نشده ممکن است مانند ["Parcel", "0000123123", "&", "0000456456"] .

ComponentName

نام این مؤلفه.

string

نوع مؤلفه آدرس. به جدول 2 مراجعه کنید: انواع اضافی که توسط سرویس مکان ها برای لیستی از انواع ممکن برگردانده شده است .

ConfirmationLevel

نشان می دهد سطح یقین که ما در مورد این مؤلفه صحیح است.

bool

نشان می دهد که مؤلفه بخشی از ورودی نبود ، اما ما آن را برای محل آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود.

bool

نشان دهنده تصحیح اشتباه غلط در نام مؤلفه است. API همیشه تغییرات را از یک نوع املا به دیگری تغییر نمی دهد ، مانند هنگام تغییر "مرکز" به "مرکز". همچنین همیشه غلط غلط های مشترک را پرچم نمی کند ، مانند هنگام تغییر "آمفی تئاتر PKWY" به "آمفی تئاتر PKWY".

bool

نشان می دهد که نام این مؤلفه با یک مورد کاملاً متفاوت جایگزین شده است ، به عنوان مثال یک کد پستی اشتباه با یک مورد مناسب برای آدرس جایگزین می شود. این یک تغییر آرایشی نیست ، مؤلفه ورودی به بخش دیگری تغییر یافته است.

bool

یک مؤلفه آدرس را نشان می دهد که انتظار نمی رود در یک آدرس پستی برای منطقه مشخص وجود داشته باشد. ما فقط به این دلیل که بخشی از ورودی بود ، آن را حفظ کرده ایم.

bool

نشان می دهد که این آدرس یک تجارت است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است.

bool

نشان می دهد که آدرس یک جعبه PO است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است.

bool

نشان می دهد که این آدرس یک محل اقامت است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است.

string

متن نام به عنوان مثال ، "خیابان 5" برای نام خیابان یا "1253" برای شماره خیابان.

string

کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان همراه نباشد ، این امر وجود نخواهد داشت.

LatLng

محل جغرافیایی ورودی.

استفاده از شناسه های مکان بیش از استفاده از آدرس ها ، مختصات عرض جغرافیایی/طول جغرافیایی یا کدهای به علاوه ترجیح داده می شود. استفاده از مختصات هنگام مسیریابی یا محاسبه جهت های رانندگی ، همیشه منجر به این خواهد شد که به جاده نزدیکترین به آن مختصات برسد. این ممکن است جاده ای نباشد که به سرعت یا با خیال راحت به مقصد منتهی شود و ممکن است در نزدیکی نقطه دسترسی به ملک نباشد. علاوه بر این ، هنگامی که یک مکان معکوس Geocoded است ، هیچ تضمینی وجود ندارد که آدرس برگشتی با اصل مطابقت داشته باشد.

PlusCode

کد به علاوه مربوط به location .

Viewport

مرزهای مکان جغرافیایی.

float

اندازه مکان جغرافیایی ، در متر. این یکی دیگر از معیارهای درشت مکان جغرافیایی است ، اما در اندازه فیزیکی و نه به معنای معنایی.

string

مکانید مکانی که این ورودی جغرافیایی می کند.

برای اطلاعات بیشتر در مورد شناسه های مکان ، اینجا را ببینید.

string

نوع (های) مکانی که ورودی از آن استفاده می کند. به عنوان مثال ، ['locality', 'political'] . لیست کامل انواع را می توان در اینجا یافت.

bool

پیش نمایش: یک google.maps.addressvalidation.v1.Address را به زبان انگلیسی برگردانید. برای جزئیات بیشتر به google.maps.addressvalidation.v1.ValidationResult.english_latin_address مراجعه کنید.

string

کد جهانی (کامل) مکان ، مانند "9FWM33GV+HQ" ، نماینده 1/8000 در منطقه 1/8000 درجه (14 پوند در 14 متر).

string

کد مرکب Place مانند "33GV+HQ ، RAMBERG ، نروژ" ، حاوی پسوند کد جهانی و جایگزین کردن پیشوند با نام فرمت یک موجود مرجع.

ValidationConclusion

مورد نیاز. نتیجه توالی تلاش های اعتبار سنجی.

اگر این قسمت بر روی VALIDATION_CONCLUSION_UNSPECIFIED تنظیم شده باشد ، یک خطای INVALID_ARGUMENT بازگردانده می شود.

string

مورد نیاز. شناسه پاسخی که این بازخورد برای آن وجود دارد. این باید [پاسخ_] [google.maps.addressvalidation.v1.validateaddressrequest.response_id] از اولین پاسخ در یک سری از تلاش های اعتبار سنجی آدرس باشد.

string

خط آدرس اول.

string

نام محکم

string

خط آدرس دوم.

string

نام شهرنشینی پورتوریکو.

string

شهر + ایالت + کد پستی.

string

نام شهر.

string

2 کد دولت.

string

کد پستی به عنوان مثال 10009.

string

پسوند کد پستی 4 رقمی EG 5023.

UspsAddress

آدرس استاندارد USPS.

string

کد نقطه تحویل 2 رقمی

string

رقم بررسی نقطه تحویل. این شماره برای نامه های اسکن شده مکانیکی به انتهای تحویل_point_barcode اضافه می شود. اضافه کردن تمام رقم های تحویل_point_barcode ، تحویل_point_check_digit ، کد پستی و ZIP+4 با هم باید یک عدد قابل تقسیم تا 10 باشد.

string

مقادیر ممکن برای تأیید DPV. یک شخصیت واحد را برمی گرداند یا هیچ ارزش را برمی گرداند.

• N : اطلاعات اولیه و هر شماره ثانویه در DPV تأیید نشد.
• D : آدرس DPV فقط برای شماره اصلی تأیید شد و اطلاعات شماره ثانویه از دست رفته بود.
• S : آدرس DPV فقط برای شماره اصلی تأیید شد ، و اطلاعات شماره ثانویه موجود بود اما تأیید نشده است.
• Y : آدرس DPV برای شماره های اولیه و ثانویه تأیید شد.
• خالی: اگر پاسخ حاوی مقدار dpv_confirmation نباشد ، آدرس برای تأیید DPV ارسال نشده است.

string

پاورقی ها از اعتبارسنجی نقطه تحویل. پاورقی های چندگانه ممکن است در همان رشته با هم جمع شوند.

• AA : آدرس ورودی با پرونده ZIP+4 مطابقت دارد
• A1 : آدرس ورودی با پرونده ZIP+4 مطابقت نداشت
• BB : مطابق با DPV (همه مؤلفه ها)
• CC : تعداد ثانویه مطابقت ندارد و لازم نیست
• C1 : تعداد ثانویه مطابقت ندارد اما مورد نیاز است
• N1 : آدرس بالایی که شماره ثانویه وجود ندارد
• M1 : تعداد اولیه از دست رفته است
• M3 : شماره اولیه نامعتبر است
• P1 : آدرس ورودی PO ، RR یا شماره جعبه HC از دست رفته است
• P3 : آدرس ورودی PO ، RR یا شماره جعبه HC نامعتبر است
• F1 : آدرس ورودی با یک آدرس نظامی مطابقت دارد
• G1 : آدرس ورودی با یک آدرس تحویل عمومی مطابقت دارد
• U1 : آدرس ورودی با یک کد پستی منحصر به فرد مطابقت دارد
• PB : آدرس ورودی با رکورد PBSA مطابقت دارد
• RR : آدرس DPV با اطلاعات PMB تأیید شد
• R1 : DPV آدرس تأیید شده بدون اطلاعات PMB
• R7 : رکورد حامل مسیر R777 یا R779
• IA : آدرس آگاهانه شناسایی شده است
• TA : شماره اصلی با رها کردن یک آلفا دنباله دار مطابقت دارد

string

نشان می دهد که آیا آدرس یک CMRA است (آژانس دریافت کننده نامه تجاری)-یک مشاغل خصوصی که برای مشتری نامه دریافت می کند. یک شخصیت واحد را برمی گرداند.

• Y : آدرس CMRA است
• N : آدرس CMRA نیست

string

آیا این مکان خالی است؟ یک شخصیت واحد را برمی گرداند.

• Y : آدرس خالی است
• N : آدرس خالی نیست

string

آیا این یک آدرس stat یا آدرس فعال است؟ هیچ آدرس آماری مواردی نیست که به طور مداوم اشغال نشده باشد یا آدرس هایی را که USPS ارائه نمی دهد ، آدرس دهد. یک شخصیت واحد را برمی گرداند.

• Y : آدرس فعال نیست
• N : آدرس فعال است

int32

نوع نوستات را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند.

• 1 : IDA (آدرس افت داخلی) - آدرس هایی که مستقیماً از طریق USP ها نامه دریافت نمی کنند اما به آدرس قطره ای که به آنها خدمات می دهد تحویل داده می شوند.
• 2 : CDS - آدرس هایی که هنوز تحویل داده نشده اند. به عنوان مثال ، یک زیر مجموعه جدید که تعداد زیادی از آنها و تعداد اصلی مشخص شده است ، اما هنوز هیچ ساختاری برای اشغال وجود ندارد.
• 3 : برخورد - آدرس هایی که در واقع DPV نیستند.
• 4 : CMZ (کالج ، نظامی و انواع دیگر) - ZIP + 4 سوابق USPS در داده ها گنجانیده شده است.
• 5 : منظم - آدرس های دریافت کننده تحویل را نشان می دهد و آدرس ها به عنوان زایمان های احتمالی شمرده نمی شوند.
• 6 : مورد نیاز ثانویه - آدرس به اطلاعات ثانویه نیاز دارد.

string

پرچم نشان می دهد که نامه به یک گیرنده در یک سایت تحویل داده می شود. Returns a single character.

• Y : The mail is delivered to a single receptable at a site.
• N : The mail is not delivered to a single receptable at a site.

string

Indicates that mail is not delivered to the street address. Returns a single character.

• Y : The mail is not delivered to the street address.
• N : The mail is delivered to the street address.

string

Flag indicates mail delivery is not performed every day of the week. Returns a single character.

• Y : The mail delivery is not performed every day of the week.
• N : No indication the mail delivery is not performed every day of the week.

int32

Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery روز

string

Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.

• Y : The package will not be left due to security concerns.
• N : No indication the package will not be left due to security concerns.

string

Indicates the address was matched to PBSA record. Returns a single character.

• Y : The address was matched to PBSA record.
• N : The address was not matched to PBSA record.

string

Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.

• Y : The door is not accessible.
• N : No indication the door is not accessible.

string

Indicates that more than one DPV return code is valid for the address. Returns a single character.

• Y : Address was DPV confirmed for primary and any secondary numbers.
• N : Primary and any secondary number information failed to DPV confirm.
• S : Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required.
• D : Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• R : Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.

string

The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.

پیشوندها:

• C : Carrier route (or city route)
• R : Rural route
• H : Highway Contract Route
• B : Post Office Box Section
• G : General delivery unit

string

Carrier route rate sort indicator.

bool

The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.

string

Main post office city.

string

Main post office state.

string

Abbreviated city.

string

FIPS county code.

string

County name.

string

Enhanced Line of Travel (eLOT) number.

string

eLOT Ascending/Descending Flag (A/D).

string

LACSLink return code.

string

LACSLink indicator.

bool

PO Box only postal code.

string

Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

• A : SuiteLink record match, business address improved.
• 00 : No match, business address is not improved.

string

PMB (Private Mail Box) unit designator.

string

PMB (Private Mail Box) number;

string

Type of the address record that matches the input address.

• F : FIRM. This is a match to a Firm Record, which is the finest level of match available for an address.
• G : GENERAL DELIVERY. This is a match to a General Delivery record.
• H : BUILDING / APARTMENT. This is a match to a Building or Apartment record.
• P : POST OFFICE BOX. This is a match to a Post Office Box.
• R : RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges.
• S : STREET RECORD: This is a match to a Street record containing a valid primary number range.

bool

Indicator that a default address was found, but more specific addresses exists.

string

Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.

The USPS data fields might not be populated when this error is present.

bool

Indicator that the request has been CASS processed.

PostalAddress

مورد نیاز. The address being validated. Unformatted addresses should be submitted via address_lines .

The total length of the fields in this input must not exceed 280 characters.

Supported regions can be found here .

The language_code value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system.

The Address Validation API ignores the values in recipients and organization . Any values in those fields will be discarded and not returned. Please do not set them.

string

This field must be empty for the first address validation request. If more requests are necessary to fully validate a single address (for example if the changes the user makes after the initial validation need to be re-validated), then each followup request must populate this field with the response_id from the very first response in the validation sequence.

bool

Enables USPS CASS compatible mode. This affects only the google.maps.addressvalidation.v1.ValidationResult.usps_data field of google.maps.addressvalidation.v1.ValidationResult . Note: for USPS CASS enabled requests for addresses in Puerto Rico, a google.type.PostalAddress.region_code of the address must be provided as "PR", or an google.type.PostalAddress.administrative_area of the address must be provided as "Puerto Rico" (case-insensitive) or "PR".

It's recommended to use a componentized address , or alternatively specify at least two google.type.PostalAddress.address_lines where the first line contains the street number and name and the second line contains the city, state, and zip code.

LanguageOptions

اختیاری. Preview: This feature is in Preview (pre-GA). محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

Enables the Address Validation API to include additional information in the response.

string

اختیاری. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user makes an Autocomplete query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple Autocomplete queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the sessionToken parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

Note: Address Validation can only be used in sessions with the Autocomplete (New) API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details.

ValidationResult

The result of the address validation.

string

The UUID that identifies this response. If the address needs to be re-validated, this UUID must accompany the new request.

Verdict

Overall verdict flags

Address

Information about the address itself as opposed to the geocode.

Geocode

Information about the location and place that the address geocoded to.

AddressMetadata

Other information relevant to deliverability. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

UspsData

Extra deliverability flags provided by USPS. Only provided in region US and PR .

Address

Preview: This feature is in Preview (pre-GA). محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

The address translated to English.

Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address.

If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See here for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address.

Enable this output by using the google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address flag.

Note: the google.maps.addressvalidation.v1.Address.unconfirmed_component_types field in the english_latin_address and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in english_latin_address.address_components are not populated.

Granularity

The granularity of the input address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to validation_granularity below.

For example, if the input address includes a specific apartment number, then the input_granularity here will be SUB_PREMISE . If we cannot match the apartment number in the databases or the apartment number is invalid, the validation_granularity will likely be PREMISE or below.

Granularity

The granularity level that the API can fully validate the address to. For example, an validation_granularity of PREMISE indicates all address components at the level of PREMISE or more coarse can be validated.

Per address component validation result can be found in google.maps.addressvalidation.v1.Address.address_components .

Granularity

Information about the granularity of the geocode . This can be understood as the semantic meaning of how coarse or fine the geocoded location is.

This can differ from the validation_granularity above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the validation_granularity will be SUB_PREMISE but the geocode_granularity will be PREMISE .

bool

The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is false . See missing_component_types , unresolved_tokens or unexpected fields for more details.

bool

At least one address component cannot be categorized or validated, see google.maps.addressvalidation.v1.Address.address_components for details.

bool

At least one address component was inferred (added) that wasn't in the input, see google.maps.addressvalidation.v1.Address.address_components for details.

bool

At least one address component was replaced, see google.maps.addressvalidation.v1.Address.address_components for details.

string

The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.

Note: the format of this address may not match the format of the address in the postal_address field. For example, the postal_address always represents the country as a 2 letter region_code , such as "US" or "NZ". By contrast, this field uses a longer form of the country name, such as "USA" or "New Zealand".

PostalAddress

The post-processed address represented as a postal address.

AddressComponent

Unordered list. The individual address components of the formatted and corrected address, along with validation information. This provides information on the validation status of the individual components.

Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list.

string

The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here .

Note: you might see a missing component type when you think you've already supplied the missing component. For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷３丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type premise , but the premise number is missing, so missing_component_types will contain premise .

string

The types of the components that are present in the address_components but could not be confirmed to be correct. This field is provided for the sake of convenience: its contents are equivalent to iterating through the address_components to find the types of all the components where the confirmation_level is not CONFIRMED or the inferred flag is not set to true . The list of possible types can be found here .

string

Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address. For example, for an input such as "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", the unresolved tokens might look like ["Parcel", "0000123123", "&", "0000456456"] .

ComponentName

The name for this component.

string

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

ConfirmationLevel

Indicates the level of certainty that we have that the component is correct.

bool

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

bool

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing "centre" to "center". It also does not always flag common misspellings, such as when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy".

bool

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

bool

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

bool

Indicates that this is the address of a business. If unset, indicates that the value is unknown.

bool

Indicates that the address of a PO box. If unset, indicates that the value is unknown.

bool

Indicates that this is the address of a residence. If unset, indicates that the value is unknown.

string

The name text. For example, "5th Avenue" for a street name or "1253" for a street number.

string

The BCP-47 language code. This will not be present if the component name is not associated with a language, such as a street number.

LatLng

The geocoded location of the input.

Using place IDs is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates when routing or calculating driving directions will always result in the point being snapped to the road nearest to those coordinates. This may not be a road that will quickly or safely lead to the destination and may not be near an access point to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original.

PlusCode

The plus code corresponding to the location .

Viewport

The bounds of the geocoded place.

float

The size of the geocoded place, in meters. This is another measure of the coarseness of the geocoded location, but in physical size rather than in semantic meaning.

string

The PlaceID of the place this input geocodes to.

For more information about Place IDs see here .

string

The type(s) of place that the input geocoded to. For example, ['locality', 'political'] . The full list of types can be found here .

bool

Preview: Return a google.maps.addressvalidation.v1.Address in English. See google.maps.addressvalidation.v1.ValidationResult.english_latin_address for details.

string

Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).

string

Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.

ValidationConclusion

مورد نیاز. The outcome of the sequence of validation attempts.

If this field is set to VALIDATION_CONCLUSION_UNSPECIFIED , an INVALID_ARGUMENT error will be returned.

string

مورد نیاز. The ID of the response that this feedback is for. This should be the [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] from the first response in a series of address validation attempts.

string

First address line.

string

Firm name.

string

Second address line.

string

Puerto Rican urbanization name.

string

City + state + postal code.

string

نام شهر.

string

2 letter state code.

string

Postal code eg 10009.

string

4-digit postal code extension eg 5023.

UspsAddress

USPS standardized address.

string

2 digit delivery point code

string

The delivery point check digit. This number is added to the end of the delivery_point_barcode for mechanically scanned mail. Adding all the digits of the delivery_point_barcode, delivery_point_check_digit, postal code, and ZIP+4 together should yield a number divisible by 10.

string

The possible values for DPV confirmation. Returns a single character or returns no value.

• N : Primary and any secondary number information failed to DPV confirm.
• D : Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• S : Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed.
• Y : Address was DPV confirmed for primary and any secondary numbers.
• Empty: If the response does not contain a dpv_confirmation value, the address was not submitted for DPV confirmation.

string

The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string.

• AA : Input address matched to the ZIP+4 file
• A1 : Input address was not matched to the ZIP+4 file
• BB : Matched to DPV (all components)
• CC : Secondary number not matched and not required
• C1 : Secondary number not matched but required
• N1 : High-rise address missing secondary number
• M1 : Primary number missing
• M3 : Primary number invalid
• P1 : Input address PO, RR or HC box number missing
• P3 : Input address PO, RR, or HC Box number invalid
• F1 : Input address matched to a military address
• G1 : Input address matched to a general delivery address
• U1 : Input address matched to a unique ZIP code
• PB : Input address matched to PBSA record
• RR : DPV confirmed address with PMB information
• R1 : DPV confirmed address without PMB information
• R7 : Carrier Route R777 or R779 record
• IA : Informed Address identified
• TA : Primary number matched by dropping a trailing alpha

string

Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients. Returns a single character.

• Y : The address is a CMRA
• N : The address is not a CMRA

string

Is this place vacant? Returns a single character.

• Y : The address is vacant
• N : The address is not vacant

string

Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service. Returns a single character.

• Y : The address is not active
• N : The address is active

int32

Indicates the NoStat type. Returns a reason code as int.

• 1 : IDA (Internal Drop Address) – Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them.
• 2 : CDS - Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy.
• 3 : Collision - Addresses that do not actually DPV confirm.
• 4 : CMZ (College, Military and Other Types) - ZIP + 4 records USPS has incorporated into the data.
• 5 : Regular - Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries.
• 6 : Secondary Required - The address requires secondary information.

string

Flag indicates mail is delivered to a single receptable at a site. Returns a single character.

• Y : The mail is delivered to a single receptable at a site.
• N : The mail is not delivered to a single receptable at a site.

string

Indicates that mail is not delivered to the street address. Returns a single character.

• Y : The mail is not delivered to the street address.
• N : The mail is delivered to the street address.

string

Flag indicates mail delivery is not performed every day of the week. Returns a single character.

• Y : The mail delivery is not performed every day of the week.
• N : No indication the mail delivery is not performed every day of the week.

int32

Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery روز

string

Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.

• Y : The package will not be left due to security concerns.
• N : No indication the package will not be left due to security concerns.

string

Indicates the address was matched to PBSA record. Returns a single character.

• Y : The address was matched to PBSA record.
• N : The address was not matched to PBSA record.

string

Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.

• Y : The door is not accessible.
• N : No indication the door is not accessible.

string

Indicates that more than one DPV return code is valid for the address. Returns a single character.

• Y : Address was DPV confirmed for primary and any secondary numbers.
• N : Primary and any secondary number information failed to DPV confirm.
• S : Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required.
• D : Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• R : Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.

string

The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.

پیشوندها:

• C : Carrier route (or city route)
• R : Rural route
• H : Highway Contract Route
• B : Post Office Box Section
• G : General delivery unit

string

Carrier route rate sort indicator.

bool

The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.

string

Main post office city.

string

Main post office state.

string

Abbreviated city.

string

FIPS county code.

string

County name.

string

Enhanced Line of Travel (eLOT) number.

string

eLOT Ascending/Descending Flag (A/D).

string

LACSLink return code.

string

LACSLink indicator.

bool

PO Box only postal code.

string

Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

• A : SuiteLink record match, business address improved.
• 00 : No match, business address is not improved.

string

PMB (Private Mail Box) unit designator.

string

PMB (Private Mail Box) number;

string

Type of the address record that matches the input address.

• F : FIRM. This is a match to a Firm Record, which is the finest level of match available for an address.
• G : GENERAL DELIVERY. This is a match to a General Delivery record.
• H : BUILDING / APARTMENT. This is a match to a Building or Apartment record.
• P : POST OFFICE BOX. This is a match to a Post Office Box.
• R : RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges.
• S : STREET RECORD: This is a match to a Street record containing a valid primary number range.

bool

Indicator that a default address was found, but more specific addresses exists.

string

Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.

The USPS data fields might not be populated when this error is present.

bool

Indicator that the request has been CASS processed.

PostalAddress

مورد نیاز. The address being validated. Unformatted addresses should be submitted via address_lines .

The total length of the fields in this input must not exceed 280 characters.

Supported regions can be found here .

The language_code value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system.

The Address Validation API ignores the values in recipients and organization . Any values in those fields will be discarded and not returned. Please do not set them.

string

This field must be empty for the first address validation request. If more requests are necessary to fully validate a single address (for example if the changes the user makes after the initial validation need to be re-validated), then each followup request must populate this field with the response_id from the very first response in the validation sequence.

bool

Enables USPS CASS compatible mode. This affects only the google.maps.addressvalidation.v1.ValidationResult.usps_data field of google.maps.addressvalidation.v1.ValidationResult . Note: for USPS CASS enabled requests for addresses in Puerto Rico, a google.type.PostalAddress.region_code of the address must be provided as "PR", or an google.type.PostalAddress.administrative_area of the address must be provided as "Puerto Rico" (case-insensitive) or "PR".

It's recommended to use a componentized address , or alternatively specify at least two google.type.PostalAddress.address_lines where the first line contains the street number and name and the second line contains the city, state, and zip code.

LanguageOptions

اختیاری. Preview: This feature is in Preview (pre-GA). محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

Enables the Address Validation API to include additional information in the response.

string

اختیاری. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user makes an Autocomplete query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple Autocomplete queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the sessionToken parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

Note: Address Validation can only be used in sessions with the Autocomplete (New) API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details.

ValidationResult

The result of the address validation.

string

The UUID that identifies this response. If the address needs to be re-validated, this UUID must accompany the new request.

Verdict

Overall verdict flags

Address

Information about the address itself as opposed to the geocode.

Geocode

Information about the location and place that the address geocoded to.

AddressMetadata

Other information relevant to deliverability. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

UspsData

Extra deliverability flags provided by USPS. Only provided in region US and PR .

Address

Preview: This feature is in Preview (pre-GA). محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.

The address translated to English.

Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address.

If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See here for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address.

Enable this output by using the google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address flag.

Note: the google.maps.addressvalidation.v1.Address.unconfirmed_component_types field in the english_latin_address and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in english_latin_address.address_components are not populated.

Granularity

The granularity of the input address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to validation_granularity below.

For example, if the input address includes a specific apartment number, then the input_granularity here will be SUB_PREMISE . If we cannot match the apartment number in the databases or the apartment number is invalid, the validation_granularity will likely be PREMISE or below.

Granularity

The granularity level that the API can fully validate the address to. For example, an validation_granularity of PREMISE indicates all address components at the level of PREMISE or more coarse can be validated.

Per address component validation result can be found in google.maps.addressvalidation.v1.Address.address_components .

Granularity

Information about the granularity of the geocode . This can be understood as the semantic meaning of how coarse or fine the geocoded location is.

This can differ from the validation_granularity above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the validation_granularity will be SUB_PREMISE but the geocode_granularity will be PREMISE .

bool

The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is false . See missing_component_types , unresolved_tokens or unexpected fields for more details.

bool

At least one address component cannot be categorized or validated, see google.maps.addressvalidation.v1.Address.address_components for details.

bool

At least one address component was inferred (added) that wasn't in the input, see google.maps.addressvalidation.v1.Address.address_components for details.

bool

At least one address component was replaced, see google.maps.addressvalidation.v1.Address.address_components for details.