Package google.maps.addressvalidation.v1

شاخص

• AddressValidation (رابط)
• Address (پیام)
• AddressComponent (پیام)
• AddressComponent.ConfirmationLevel (enum)
• AddressMetadata (پیام)
• ComponentName (پیام)
• Geocode (پیام)
• LanguageOptions (پیام)
• PlusCode (پیام)
• ProvideValidationFeedbackRequest (پیام)
• ProvideValidationFeedbackRequest.ValidationConclusion (enum)
• ProvideValidationFeedbackResponse (پیام)
• UspsAddress (پیام)
• UspsData (پیام)
• ValidateAddressRequest (پیام)
• ValidateAddressResponse (پیام)
• ValidationResult (پیام)
• Verdict (پیام)
• Verdict.Granularity (enum)
• Verdict.PossibleNextAction (enum)

Address Validation

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

ارائه بازخورد اعتبارسنجی

rpc ProvideValidationFeedback( ProvideValidationFeedbackRequest ) returns ( ProvideValidationFeedbackResponse ) بازخورد در مورد نتیجه توالی تلاش‌های اعتبارسنجی. این باید آخرین تماسی باشد که پس از یک سری تماس های اعتبارسنجی برای همان آدرس انجام می شود و باید پس از پایان تراکنش فراخوانی شود. این فقط یک بار باید برای دنباله درخواست های ValidateAddress که برای اعتبارسنجی کامل یک آدرس لازم است ارسال شود.

ValidateAddress
rpc ValidateAddress( ValidateAddressRequest ) returns ( ValidateAddressResponse ) یک آدرس را تأیید می کند.

آدرس

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

فیلدها
formatted_address	string آدرس پس از پردازش، به عنوان یک آدرس تک خطی با پیروی از قوانین قالب‌بندی آدرس منطقه‌ای که آدرس در آن قرار دارد، قالب‌بندی شده است. توجه: فرمت این آدرس ممکن است با فرمت آدرس در قسمت postal_address مطابقت نداشته باشد. برای مثال، postal_address همیشه کشور را به‌عنوان یک region_code ۲ حرفی، مانند «US» یا «NZ» نشان می‌دهد. در مقابل، این فیلد از شکل طولانی‌تری از نام کشور مانند «USA» یا «نیوزیلند» استفاده می‌کند.
postal_address	PostalAddress آدرس پس از پردازش به عنوان یک آدرس پستی نشان داده شده است.
address_components[]	AddressComponent لیست نامرتب اجزای آدرس منفرد آدرس فرمت شده و تصحیح شده، همراه با اطلاعات اعتبارسنجی. این اطلاعات در مورد وضعیت اعتبار سنجی اجزای جداگانه ارائه می دهد. اجزای آدرس به روش خاصی مرتب نمی شوند. هیچ گونه فرضی در مورد ترتیب اجزای آدرس در لیست انجام ندهید.
missing_component_types[]	string انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی با فرمت صحیح وجود داشته باشند اما در ورودی و یافت نشدند قابل استنباط نیستند. یک مثال ممکن است ['street_number', 'route'] برای ورودی مانند "Boulder, Colorado, 80301, USA" باشد. لیست انواع ممکن را می توان در اینجا یافت. توجه: زمانی که فکر می کنید قبلاً جزء گم شده را تهیه کرده اید، ممکن است یک نوع مؤلفه گم شده را ببینید. به عنوان مثال، این ممکن است زمانی اتفاق بیفتد که آدرس ورودی حاوی نام ساختمان باشد، اما نه شماره مقدمات. در آدرس "渋谷区渋谷３丁目 Shibuya Stream"، نام ساختمان "Shibuya Stream" دارای premise نوع مؤلفه است، اما شماره فرض وجود ندارد، بنابراین missing_component_types حاوی premise خواهد بود.
unconfirmed_component_types[]	string انواع مؤلفه‌هایی که در address_components وجود دارند، اما صحت آن‌ها تأیید نشد. این فیلد به منظور راحتی ارائه شده است: محتویات آن معادل تکرار از طریق address_components برای یافتن انواع همه مؤلفه‌هایی است که در آن سطح confirmation_level CONFIRMED نشده است یا پرچم inferred روی true تنظیم نشده است. لیست انواع ممکن را می توان در اینجا یافت.
unresolved_tokens[]	string هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد. به عنوان مثال، برای ورودی‌هایی مانند «Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US»، نشانه‌های حل‌نشده ممکن است مانند ["Parcel", "0000123123", "&", "0000456456"] باشند.

Address Component

نشان دهنده یک جزء آدرس، مانند یک خیابان، شهر یا ایالت است.

فیلدها
component_name	ComponentName نام این جزء
component_type	string نوع جزء آدرس جدول 2 را ببینید: انواع اضافی که توسط سرویس Places برگردانده شده است برای لیستی از انواع احتمالی.
confirmation_level	ConfirmationLevel نشان دهنده میزان اطمینانی است که ما در مورد صحیح بودن مؤلفه داریم.
inferred	bool نشان می دهد که مؤلفه بخشی از ورودی نبوده است، اما ما آن را برای مکان آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود.
spell_corrected	bool تصحیح یک غلط املایی در نام مؤلفه را نشان می دهد. API همیشه تغییرات را از یک نوع املایی به دیگری علامت گذاری نمی کند، مانند زمانی که "مرکز" به "مرکز" تغییر می کند. همچنین همیشه اشتباهات املایی رایج را علامت گذاری نمی کند، مانند زمانی که "Amphitheatre Pkwy" را به "Amphitheatre Pkwy" تغییر می دهید.
replaced	bool نشان می دهد که نام مؤلفه با یک نام کاملاً متفاوت جایگزین شده است، به عنوان مثال یک کد پستی اشتباه با کدی که برای آدرس صحیح است جایگزین شده است. این یک تغییر زیبایی نیست، جزء ورودی به دیگری تغییر کرده است.
unexpected	bool یک جزء آدرس را نشان می دهد که انتظار نمی رود در آدرس پستی منطقه داده شده وجود داشته باشد. ما آن را فقط به این دلیل حفظ کرده ایم که بخشی از ورودی بوده است.

سطح تایید

مقادیر مختلف ممکن برای سطوح تایید.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED	مقدار پیش فرض این مقدار استفاده نشده است.
CONFIRMED	ما توانستیم تأیید کنیم که این مؤلفه در زمینه بقیه آدرس وجود دارد و منطقی است.
UNCONFIRMED_BUT_PLAUSIBLE	این مؤلفه قابل تأیید نیست، اما وجود آن قابل قبول است. به عنوان مثال، یک شماره خیابان در محدوده معتبر شناخته شده اعداد در خیابانی که شماره خانه های خاصی در آن مشخص نیست.
UNCONFIRMED_AND_SUSPICIOUS	این مؤلفه تأیید نشد و احتمالاً اشتباه است. مثلا محله ای که به بقیه آدرس نمی خورد.

AddressMetadata

فراداده برای آدرس پس از پردازش. metadata برای هر آدرسی که به Address Validation API ارسال می شود، تضمین نمی شود.

فیلدها
business	bool نشان می دهد که این آدرس یک کسب و کار است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.
po_box	bool نشان می دهد که آدرس یک صندوق پستی. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.
residential	bool نشان می دهد که این آدرس یک محل سکونت است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است.

نام مؤلفه

یک لفاف برای نام جزء.

فیلدها
text	string متن نام. به عنوان مثال، "5th Avenue" برای نام یک خیابان یا "1253" برای یک شماره خیابان.
language_code	string کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان مرتبط نباشد، این مورد وجود نخواهد داشت.

ژئوکد

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

فیلدها
location	LatLng مکان جغرافیایی کد شده ورودی. استفاده از شناسه‌های مکان بر استفاده از آدرس‌ها، مختصات طول و عرض جغرافیایی یا کدهای بعلاوه ترجیح داده می‌شود. استفاده از مختصات هنگام مسیریابی یا محاسبه مسیرهای رانندگی همیشه باعث می شود که نقطه به نزدیکترین جاده به آن مختصات گیر کند. ممکن است این جاده ای نباشد که به سرعت یا ایمن به مقصد منتهی شود و ممکن است نزدیک یک نقطه دسترسی به ملک نباشد. علاوه بر این، هنگامی که یک مکان معکوس جغرافیایی کدگذاری می شود، هیچ تضمینی وجود ندارد که آدرس برگشتی با آدرس اصلی مطابقت داشته باشد.
plus_code	PlusCode کد مثبت مربوط به location .
bounds	Viewport محدوده مکان ژئوکد شده.
feature_size_meters	float اندازه مکان ژئوکد شده، بر حسب متر. این یکی دیگر از معیارهای درشت بودن مکان جغرافیایی کد شده است، اما در اندازه فیزیکی به جای معنای معنایی.
place_id	string شناسه مکان مکانی که این ورودی به آن کد جغرافیایی می‌دهد. برای اطلاعات بیشتر درباره شناسه‌های مکان اینجا را ببینید.
place_types[]	string نوع(های) مکانی که ورودی به آن کدگذاری شده است. برای مثال، ['locality', 'political'] . لیست کامل انواع را می توان در اینجا یافت.

گزینه های زبان

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

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

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

پلاس کد

کد پلاس ( http://plus.codes ) یک مرجع مکان با دو قالب است: کد جهانی که مستطیل 14mx14m (1/8000 درجه) یا کوچکتر را تعریف می کند و کد ترکیبی که پیشوند را با یک مکان مرجع جایگزین می کند.

فیلدها
global_code	string کد جهانی (کامل) مکان، مانند "9FWM33GV+HQ"، که یک منطقه 1/8000 در 1/8000 درجه (~14 در 14 متر) را نشان می دهد.
compound_code	string کد ترکیبی Place، مانند "33GV+HQ، Ramberg، Norway"، حاوی پسوند کد جهانی و جایگزینی پیشوند با نام قالب بندی شده یک نهاد مرجع.

ProvideValidationFeedback Request را ارائه دهید

درخواست ارسال بازخورد تأیید اعتبار.

فیلدها
conclusion	ValidationConclusion مورد نیاز. نتیجه توالی تلاش‌های اعتبارسنجی اگر این فیلد روی VALIDATION_CONCLUSION_UNSPECIFIED تنظیم شود، یک خطای INVALID_ARGUMENT برگردانده خواهد شد.
response_id	string مورد نیاز. شناسه پاسخی که این بازخورد برای آن است. این باید [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] از اولین پاسخ در یک سری تلاش‌های اعتبارسنجی آدرس باشد.

نتیجه گیری اعتبار سنجی

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

Enums
VALIDATION_CONCLUSION_UNSPECIFIED	این مقدار استفاده نشده است. اگر قسمت ProvideValidationFeedbackRequest.conclusion روی VALIDATION_CONCLUSION_UNSPECIFIED تنظیم شود، یک خطای INVALID_ARGUMENT برگردانده می شود.
VALIDATED_VERSION_USED	نسخه آدرس برگشتی توسط Address Validation API برای تراکنش استفاده شد.
USER_VERSION_USED	از نسخه آدرس ارائه شده توسط کاربر برای تراکنش استفاده شد
UNVALIDATED_VERSION_USED	نسخه‌ای از آدرسی که پس از آخرین تلاش برای اعتبارسنجی وارد شده بود، اما دوباره تأیید نشد، برای تراکنش استفاده شد.
UNUSED	معامله لغو شد و از آدرس استفاده نشد.

ProvideValidationFeedback Response

این نوع هیچ فیلدی ندارد.

پاسخ برای بازخورد اعتبار سنجی

اگر بازخورد با موفقیت ارسال شود، پاسخ خالی است.

آدرس Usps

نمایندگی USPS از یک آدرس ایالات متحده.

فیلدها
first_address_line	string خط اول آدرس
firm	string نام شرکت
second_address_line	string خط آدرس دوم
urbanization	string نام شهرنشینی پورتوریکویی
city_state_zip_address_line	string شهر + ایالت + کد پستی.
city	string نام شهر.
state	string کد دولتی 2 حرفی
zip_code	string کد پستی به عنوان مثال 10009.
zip_code_extension	string پسوند کد پستی 4 رقمی به عنوان مثال 5023.

UspsData

داده های USPS برای آدرس. uspsData برای هر آدرس ایالات متحده یا روابط عمومی ارسال شده به Address Validation API تضمین نمی شود که به طور کامل پر شود. اگر از uspsData به عنوان بخش اصلی پاسخ استفاده می کنید، توصیه می شود که فیلدهای آدرس پشتیبان را در پاسخ ادغام کنید.

فیلدها
standardized_address	UspsAddress آدرس استاندارد USPS
delivery_point_code	string کد نقطه تحویل 2 رقمی
delivery_point_check_digit	string رقم بررسی نقطه تحویل این شماره برای نامه های اسکن شده مکانیکی به انتهای بارکد_point_delivery اضافه می شود. با جمع کردن تمام ارقام بارکد_نقطه_تحویل، رقم_بررسی_نقطه_تحویل، کد پستی و ZIP+4 عددی قابل تقسیم بر 10 به دست می‌آید.
dpv_confirmation	string مقادیر ممکن برای تایید DPV. یک کاراکتر را برمی‌گرداند یا هیچ مقداری را برمی‌گرداند. N : اطلاعات اعداد اولیه و ثانویه تأیید DPV نشد. D : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه وجود نداشت. S : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه موجود بود اما تأیید نشد. Y : آدرس DPV برای شماره های اولیه و ثانویه تایید شد. خالی: اگر پاسخ حاوی مقدار dpv_confirmation نباشد، آدرس برای تایید DPV ارسال نشده است.
dpv_footnote	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 : عدد اولیه با حذف یک آلفای انتهایی مطابقت دارد
dpv_cmra	string نشان می دهد که آیا آدرس یک CMRA (آژانس دریافت نامه های تجاری) است - یک کسب و کار خصوصی که نامه دریافت می کند برای مشتریان. یک کاراکتر را برمی‌گرداند. Y : آدرس یک CMRA است N : آدرس یک CMRA نیست
dpv_vacant	string آیا این مکان خالی است؟ یک کاراکتر را برمی‌گرداند. Y : آدرس خالی است N : آدرس خالی نیست
dpv_no_stat	string آیا این یک آدرس بدون آمار است یا یک آدرس فعال؟ هیچ آدرس آماری، آدرس هایی نیستند که به طور مداوم اشغال نمی شوند یا آدرس هایی که USPS سرویس نمی دهد. یک کاراکتر را برمی‌گرداند. Y : آدرس فعال نیست N : آدرس فعال است
dpv_no_stat_reason_code	int32 نوع NoStat را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند. 1 : IDA (Internal Drop Address) - آدرس هایی که ایمیل را مستقیماً از USPS دریافت نمی کنند اما به آدرس drop تحویل داده می شوند که به آنها خدمات ارائه می دهد. 2 : CDS - آدرس هایی که هنوز قابل تحویل نیستند. به عنوان مثال، یک بخش فرعی جدید که در آن قطعات و اعداد اولیه تعیین شده است، اما هنوز ساختاری برای اشغال وجود ندارد. 3 : برخورد - آدرس هایی که در واقع DPV را تأیید نمی کنند. 4 : CMZ (کالج، نظامی و انواع دیگر) - ZIP + 4 رکورد USPS در داده ها گنجانده شده است. 5 : معمولی - نشان دهنده آدرس هایی است که تحویل دریافت نمی کنند و آدرس ها به عنوان تحویل های احتمالی محاسبه نمی شوند. 6 : ثانویه مورد نیاز - آدرس به اطلاعات ثانویه نیاز دارد.
dpv_drop	string پرچم نشان می‌دهد که نامه‌ها به یک مورد در یک سایت تحویل داده می‌شود. یک کاراکتر را برمی‌گرداند. Y : نامه به یک نفر در یک سایت تحویل داده می شود. N : نامه به یک فرد قابل دریافت در یک سایت تحویل داده نمی شود.
dpv_throwback	string نشان می دهد که نامه به آدرس خیابان تحویل داده نمی شود. یک کاراکتر را برمی‌گرداند. Y : نامه به آدرس خیابان تحویل داده نمی شود. N : نامه به آدرس خیابان تحویل داده می شود.
dpv_non_delivery_days	string پرچم نشان می دهد که تحویل نامه در هر روز هفته انجام نمی شود. یک کاراکتر را برمی‌گرداند. Y : تحویل پست هر روز هفته انجام نمی شود. N : هیچ نشانه ای وجود ندارد که تحویل نامه در هر روز هفته انجام نمی شود.
dpv_non_delivery_days_values	int32 تعداد صحیح شناسایی روزهای بدون تحویل با استفاده از پرچم‌های بیت قابل بازجویی است: 0x40 - یکشنبه یک روز بدون تحویل است 0x20 - دوشنبه یک روز بدون تحویل است 0x10 - سه‌شنبه یک روز بدون تحویل است 0x08 - چهارشنبه یک روز بدون تحویل است 0x04 - پنج‌شنبه یک روز بدون تحویل است 0x02 روز شنبه است - جمعه یک روز بدون تحویل است 0x02 - جمعه یک روز بدون تحویل است روز
dpv_no_secure_location	string پرچم نشان می دهد که درب قابل دسترسی است، اما بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند. یک کاراکتر را برمی‌گرداند. Y : بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند. N : هیچ نشانه ای وجود ندارد که بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند.
dpv_pbsa	string نشان می دهد که آدرس با رکورد PBSA مطابقت داده شده است. یک کاراکتر را برمی‌گرداند. Y : آدرس با رکورد PBSA مطابقت داشت. N : آدرس با رکورد PBSA مطابقت نداشت.
dpv_door_not_accessible	string پرچم نشان‌دهنده آدرس‌هایی است که USPS نمی‌تواند برای تحویل نامه به درب بزند. یک کاراکتر را برمی‌گرداند. Y : در قابل دسترس نیست. N : هیچ نشانه ای وجود ندارد که درب قابل دسترسی نیست.
dpv_enhanced_delivery_code	string نشان می دهد که بیش از یک کد بازگشتی DPV برای آدرس معتبر است. یک کاراکتر را برمی‌گرداند. Y : آدرس DPV برای شماره های اولیه و ثانویه تایید شد. N : اطلاعات اعداد اولیه و ثانویه تأیید DPV نشد. S : آدرس فقط برای شماره اولیه DPV تأیید شد، و اطلاعات شماره ثانویه موجود بود اما تأیید نشد، یا یک آلفای انتهایی روی یک شماره اولیه حذف شد تا مطابقت DPV و اطلاعات ثانویه مورد نیاز باشد. D : آدرس فقط برای شماره اولیه DPV تأیید شد و اطلاعات شماره ثانویه وجود نداشت. R : آدرس تأیید شده است اما به مسیر فانتوم R777 و R779 اختصاص داده شده است و تحویل USPS ارائه نشده است.
carrier_route	string کد مسیر حامل یک کد چهار کاراکتری متشکل از یک پیشوند یک حرفی و یک نشانگر مسیر سه رقمی. پیشوندها: C : مسیر حامل (یا مسیر شهری) R : مسیر روستایی H : مسیر قرارداد بزرگراه B : بخش صندوق پست G : واحد تحویل عمومی
carrier_route_indicator	string نشانگر مرتب‌سازی نرخ مسیر حامل.
ews_no_match	bool آدرس تحویل قابل تطبیق است، اما فایل EWS نشان می دهد که به زودی یک تطابق دقیق در دسترس خواهد بود.
post_office_city	string شهر پست اصلی
post_office_state	string ایالت اداره پست اصلی
abbreviated_city	string شهر به اختصار.
fips_county_code	string کد شهرستان FIPS.
county	string نام شهرستان.
elot_number	string شماره خط سفر پیشرفته (eLOT).
elot_flag	string پرچم صعودی/نزولی eLOT (A/D).
lacs_link_return_code	string کد بازگشت LACSlink.
lacs_link_indicator	string نشانگر LACSLlink.
po_box_only_postal_code	bool کد پستی فقط صندوق پستی
suitelink_footnote	string پاورقی از تطبیق یک خیابان یا رکورد بلند با اطلاعات مجموعه. اگر نام تجاری مطابقت پیدا شود، شماره ثانویه برگردانده می شود. A : مطابقت رکورد SuiteLink، آدرس کسب و کار بهبود یافته است. 00 : مطابقت ندارد، آدرس کسب و کار بهبود نیافته است.
pmb_designator	string تعیین کننده واحد PMB (جعبه پست خصوصی).
pmb_number	string شماره PMB (صندوق پست خصوصی)؛
address_record_type	string نوع رکورد آدرسی که با آدرس ورودی مطابقت دارد. F : شرکت. این تطبیق با یک سابقه شرکت است، که بهترین سطح تطابق موجود برای یک آدرس است. G : تحویل عمومی. این یک مسابقه با رکورد تحویل عمومی است. H : ساختمان / آپارتمان. این یک تطابق با رکورد ساختمان یا آپارتمان است. P : صندوق پستی. این مطابق با صندوق پستی است. R : قرارداد مسیر روستایی یا بزرگراه: این مطابق با رکورد یک مسیر روستایی یا یک قرارداد بزرگراه است، که هر دو ممکن است محدوده‌های Box Number مرتبط داشته باشند. S : STREET RECORD: این تطبیق با یک رکورد خیابانی است که دارای محدوده اعداد اولیه معتبر است.
default_address	bool نشان می دهد که یک آدرس پیش فرض پیدا شده است، اما آدرس های خاص تری وجود دارد.
error_message	string پیام خطا برای بازیابی اطلاعات USPS. زمانی که پردازش USPS به دلیل شناسایی آدرس‌های ایجاد شده مصنوعی به حالت تعلیق در می‌آید، پر می‌شود. فیلدهای داده USPS ممکن است در صورت وجود این خطا پر نشوند.
cass_processed	bool نشانگر این است که درخواست CASS پردازش شده است.

ValidateAddressRequest

درخواست برای تأیید اعتبار یک آدرس.

فیلدها
address	PostalAddress مورد نیاز. آدرس در حال تایید است. آدرس های بدون قالب باید از طریق address_lines ارسال شوند. طول کل فیلدهای این ورودی نباید از 280 کاراکتر تجاوز کند. مناطق پشتیبانی شده را می توانید در اینجا پیدا کنید. مقدار language_code در آدرس ورودی برای استفاده های بعدی محفوظ است و امروز نادیده گرفته می شود. نتیجه آدرس تأیید شده بر اساس زبان ترجیحی برای آدرس داده شده، همانطور که توسط سیستم شناسایی شده است، پر می شود. Address Validation API مقادیر موجود در recipients و organization را نادیده می گیرد. هر مقدار در آن فیلدها کنار گذاشته می شود و برگردانده نمی شود. لطفا آنها را تنظیم نکنید.
previous_response_id	string این فیلد باید برای اولین درخواست اعتبارسنجی آدرس خالی باشد. اگر درخواست‌های بیشتری برای اعتبارسنجی کامل یک آدرس ضروری باشد (مثلاً اگر تغییراتی که کاربر پس از اعتبارسنجی اولیه ایجاد می‌کند نیاز به تأیید مجدد داشته باشد)، آن‌وقت هر درخواست پیگیری باید از همان اولین پاسخ در دنباله اعتبارسنجی، این فیلد را با response_id پر کند.
enable_usps_cass	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 را مشخص کنید که در آن خط اول شامل شماره و نام خیابان و خط دوم شامل شهر، ایالت و کد پستی باشد.
language_options	LanguageOptions اختیاری. Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. Address Validation API را فعال می کند تا اطلاعات بیشتری را در پاسخ اضافه کند.
session_token	string اختیاری. رشته ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می کند. باید یک URL و نام فایل ایمن رشته base64 با حداکثر 36 کاراکتر اسکی باشد. در غیر این صورت یک خطای INVALID_ARGUMENT برگردانده می شود. جلسه زمانی شروع می شود که کاربر یک پرس و جو تکمیل خودکار انجام می دهد، و زمانی که یک مکان را انتخاب می کند و تماسی با جزئیات مکان یا اعتبارسنجی آدرس برقرار می شود، به پایان می رسد. هر جلسه می‌تواند چندین پرس‌وجو تکمیل خودکار داشته باشد و به دنبال آن یک درخواست جزییات مکان یا اعتبارسنجی آدرس ارائه شود. اعتبار استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان جلسه، رمز دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر sessionToken حذف شود، یا اگر از یک نشانه جلسه استفاده مجدد کنید، هزینه جلسه به گونه ای محاسبه می شود که گویی هیچ نشانه جلسه ارائه نشده است (هر درخواست جداگانه صورتحساب می شود). توجه: اعتبار آدرس فقط در جلسات با API تکمیل خودکار (جدید) قابل استفاده است، نه API تکمیل خودکار. برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/session-pricing مراجعه کنید.

ValidateAddressResponse

پاسخ به یک درخواست اعتبار سنجی آدرس.

فیلدها
result	ValidationResult نتیجه اعتبار سنجی آدرس
response_id	string UUID که این پاسخ را شناسایی می کند. اگر آدرس نیاز به تأیید مجدد داشته باشد، این UUID باید درخواست جدید را همراهی کند.

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

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

فیلدها
verdict	Verdict پرچم های حکم کلی
address	Address اطلاعات مربوط به خود آدرس بر خلاف ژئوکد.
geocode	Geocode اطلاعات مربوط به مکان و مکانی که آدرس به آن کد جغرافیایی داده است.
metadata	AddressMetadata سایر اطلاعات مربوط به قابلیت تحویل metadata برای هر آدرسی که به Address Validation API ارسال می شود، تضمین نمی شود.
usps_data	UspsData پرچم های تحویل اضافی ارائه شده توسط USPS. فقط در منطقه US و PR ارائه شده است.
english_latin_address	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 پر نشده است.

حکم

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

فیلدها
input_granularity	Granularity جزئیات آدرس ورودی این نتیجه تجزیه آدرس ورودی است و هیچ سیگنال اعتبار سنجی نمی دهد. برای سیگنال های اعتبارسنجی، به validation_granularity زیر مراجعه کنید. برای مثال، اگر آدرس ورودی شامل یک شماره آپارتمان خاص باشد، input_granularity در اینجا SUB_PREMISE خواهد بود. اگر سرویس اعتبارسنجی آدرس نتواند با شماره آپارتمان در پایگاه داده مطابقت داشته باشد یا شماره آپارتمان نامعتبر باشد، validation_granularity احتمالا PREMISE یا بیشتر درشت خواهد بود.
validation_granularity	Granularity سطح جزئیات برای آدرس پس از پردازش که API می تواند به طور کامل تأیید کند. به عنوان مثال، یک validation_granularity از PREMISE نشان می دهد که تمام اجزای آدرس در سطح PREMISE یا بیشتر درشت می توانند اعتبار سنجی شوند. نتیجه تأیید مؤلفه هر آدرس را می‌توانید در google.maps.addressvalidation.v1.Address.address_components پیدا کنید.
geocode_granularity	Granularity اطلاعات در مورد دانه بندی geocode . این را می توان به عنوان معنای معنایی درشت یا ظریف بودن مکان جغرافیایی درک کرد. این ممکن است با validation_granularity بالا گاهی اوقات متفاوت باشد. به عنوان مثال، پایگاه داده ما ممکن است وجود یک شماره آپارتمان را ثبت کند اما مکان دقیقی برای آپارتمان در یک مجتمع آپارتمانی بزرگ نداشته باشد. در آن صورت، validation_granularity SUB_PREMISE خواهد بود اما geocode_granularity PREMISE خواهد بود.
address_complete	bool اگر نشانه‌های حل‌نشده، اجزای آدرس غیرمنتظره یا مفقودی وجود نداشته باشد، آدرس پس از پردازش کامل در نظر گرفته می‌شود. اگر تنظیم نشده باشد، نشان می دهد که مقدار false است. برای جزئیات بیشتر به missing_component_types ، unresolved_tokens یا فیلدهای unexpected مراجعه کنید.
has_unconfirmed_components	bool حداقل یک جزء آدرس را نمی توان طبقه بندی یا تأیید کرد، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.
has_inferred_components	bool حداقل یک جزء آدرس استنباط شد (اضافه شد) که در ورودی نبود، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.
has_replaced_components	bool حداقل یک جزء آدرس جایگزین شده است، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.
possible_next_action	PossibleNextAction Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگی‌های Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگی‌های pre-GA ممکن است با سایر نسخه‌های pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. خلاصه ای تفسیری از پاسخ API را ارائه می دهد که به منظور کمک به تعیین یک اقدام احتمالی بعدی انجام می شود. این فیلد از فیلدهای دیگر در پاسخ API مشتق شده است و نباید به عنوان تضمینی برای صحت آدرس یا تحویل پذیری در نظر گرفته شود. برای جزئیات بیشتر به ایجاد منطق اعتبارسنجی خود مراجعه کنید.
has_spell_corrected_components	bool حداقل یکی از مؤلفه‌های آدرس تصحیح شده است، برای جزئیات به google.maps.addressvalidation.v1.Address.address_components مراجعه کنید.

دانه بندی

دانه بندی های مختلفی که یک آدرس یا یک ژئوکد می تواند داشته باشد. هنگامی که برای نشان دادن جزئیات برای یک آدرس استفاده می‌شود، این مقادیر نشان می‌دهند که آدرس تا چه اندازه یک مقصد پستی را مشخص می‌کند. به عنوان مثال، آدرسی مانند "123 Main Street, Redwood City, CA, 94061" یک PREMISE را مشخص می کند در حالی که چیزی مانند "Redwood City, CA, 94061" یک LOCALITY را مشخص می کند. با این حال، اگر نتوانیم یک ژئوکد برای "خیابان اصلی 123" در شهر ردوود پیدا کنیم، ممکن است ژئوکد ارسالی از LOCALITY دانه بندی باشد، حتی اگر آدرس دقیق تر باشد.

Enums
GRANULARITY_UNSPECIFIED	مقدار پیش فرض این مقدار استفاده نشده است.
SUB_PREMISE	نتیجه زیر سطح ساختمان، مانند یک آپارتمان.
PREMISE	نتیجه در سطح ساختمان
PREMISE_PROXIMITY	یک ژئوکد که موقعیت مکانی آدرس را در سطح ساختمان تقریبی می کند.
BLOCK	آدرس یا ژئوکد یک بلوک را نشان می دهد. فقط در مناطقی استفاده می شود که آدرس دهی در سطح بلوک دارند، مانند ژاپن.
ROUTE	ژئوکد یا آدرس برای مسیر، مانند خیابان، جاده یا بزرگراه، دانه‌بندی است.
OTHER	همه دانه‌بندی‌های دیگر، که در کنار هم قرار می‌گیرند، زیرا قابل تحویل نیستند.

PossibleNextAction

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

اقدامات احتمالی بعدی که می‌توان بر اساس پاسخ API انجام داد.

Enums
POSSIBLE_NEXT_ACTION_UNSPECIFIED	مقدار پیش فرض این مقدار استفاده نشده است.
FIX	یک یا چند فیلد از پاسخ API نشان دهنده یک مشکل بالقوه در آدرس پس از پردازش است، برای مثال verdict.validation_granularity OTHER است. ترغیب مشتری به ویرایش آدرس می تواند به بهبود کیفیت آدرس کمک کند.
CONFIRM_ADD_SUBPREMISES	پاسخ API نشان می دهد که آدرس پس از پردازش ممکن است یک زیرمجموعه نداشته باشد. ترغیب مشتری به بررسی آدرس و در نظر گرفتن اضافه کردن شماره واحد می تواند به بهبود کیفیت آدرس کمک کند. آدرس پس از پردازش ممکن است مشکلات جزئی دیگری نیز داشته باشد. توجه: این مقدار enum فقط برای آدرس های ایالات متحده قابل بازگشت است.
CONFIRM	یک یا چند فیلد از پاسخ API نشان دهنده مشکلات جزئی بالقوه با آدرس پس از پردازش است، به عنوان مثال جزء آدرس postal_code replaced شد. ترغیب مشتری به بازبینی آدرس می تواند به بهبود کیفیت آدرس کمک کند.
ACCEPT	پاسخ API حاوی سیگنال هایی نیست که یکی از مقادیر دیگر PossibleNextAction را تضمین کند. ممکن است بدون درخواست بیشتر از مشتری خود از آدرس پس از پردازش استفاده کنید، اگرچه این تضمینی برای معتبر بودن آدرس نیست و ممکن است آدرس همچنان حاوی اصلاحاتی باشد. این مسئولیت شماست که بسته به ارزیابی ریسک خود، تعیین کنید که آیا و چگونه مشتری خود را تشویق کنید.