Package google.maps.addressvalidation.v1

فهرست مطالب

Address Validation

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

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

rpc ProvideValidationFeedback( ProvideValidationFeedbackRequest ) returns ( ProvideValidationFeedbackResponse )

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

ValidateAddress

rpc ValidateAddress( ValidateAddressRequest ) returns ( ValidateAddressResponse )

یک آدرس را تأیید می کند.

نشانی

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

زمینه های
formatted_address

string

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

postal_address

PostalAddress

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

address_components[]

AddressComponent

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

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

missing_component_types[]

string

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

unconfirmed_component_types[]

string

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

unresolved_tokens[]

string

هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد (برای مثال در ورودی مانند "123235253253 Main St, San Francisco, CA, 94105"، نشانه های حل نشده ممکن است مانند ["123235253253"] به نظر برسند. شبیه یک شماره خیابان معتبر نیست.

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 - جمعه یک روز بدون تحویل است 0x01 - شنبه یک روز بدون تحویل است

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).

po_box_only_postal_code

bool

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

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" ارائه شود، یا یک address google.type.PostalAddress.administrative_area باید به عنوان "Puerto" ارائه شود. ریکو" (بدون حساسیت به حروف بزرگ) یا "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 مراجعه کنید.

دانه دانه بودن

دانه بندی های مختلفی که یک آدرس یا یک ژئوکد می تواند داشته باشد. هنگامی که برای نشان دادن جزئیات برای یک آدرس استفاده می‌شود، این مقادیر نشان می‌دهند که آدرس تا چه اندازه یک مقصد پستی را مشخص می‌کند. به عنوان مثال، آدرسی مانند "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 همه دانه‌بندی‌های دیگر، که در کنار هم قرار می‌گیرند، زیرا قابل تحویل نیستند.
،

فهرست مطالب

Address Validation

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

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

rpc ProvideValidationFeedback( ProvideValidationFeedbackRequest ) returns ( ProvideValidationFeedbackResponse )

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

ValidateAddress

rpc ValidateAddress( ValidateAddressRequest ) returns ( ValidateAddressResponse )

یک آدرس را تأیید می کند.

نشانی

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

زمینه های
formatted_address

string

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

postal_address

PostalAddress

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

address_components[]

AddressComponent

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

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

missing_component_types[]

string

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

unconfirmed_component_types[]

string

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

unresolved_tokens[]

string

هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد (برای مثال در ورودی مانند "123235253253 Main St, San Francisco, CA, 94105"، نشانه های حل نشده ممکن است مانند ["123235253253"] به نظر برسند. شبیه یک شماره خیابان معتبر نیست.

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

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

ConfirmationLevel

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

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 ، نروژ" ، حاوی پسوند کد جهانی و جایگزین کردن پیشوند با نام فرمت یک موجود مرجع.

ارائه ValidationFeedbackRequest

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

زمینه های
conclusion

ValidationConclusion

ضروری. نتیجه توالی تلاش های اعتبار سنجی.

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

response_id

string

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

اعتبار سنجی

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

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

ارائه ValidationFeedbackResponse

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

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

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

uspsaddress

نمایندگی 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 رقمی EG 5023.

uspsdata

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

زمینه های
standardized_address

UspsAddress

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

delivery_point_code

string

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

delivery_point_check_digit

string

رقم بررسی نقطه تحویل. این شماره برای نامه های اسکن شده مکانیکی به انتهای تحویل_point_barcode اضافه می شود. اضافه کردن تمام رقم های تحویل_point_barcode ، تحویل_point_check_digit ، کد پستی و 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

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

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

int32

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

  • 1 : IDA (آدرس افت داخلی) - آدرس هایی که مستقیماً از طریق USP ها نامه دریافت نمی کنند اما به آدرس قطره ای که به آنها خدمات می دهد تحویل داده می شوند.
  • 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-جمعه یک روز غیر تحویل 0x01 است-شنبه یک روز غیر تحویل است

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

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

po_box_only_postal_code

bool

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

pmb_designator

string

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

pmb_number

string

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

address_record_type

string

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

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

bool

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

error_message

string

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

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

cass_processed

bool

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

valiteateaddressrequest

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

زمینه های
address

PostalAddress

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

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

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

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

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

previous_response_id

string

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

enable_usps_cass

bool

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

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

language_options

LanguageOptions

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

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

session_token

string

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

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

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

stalentateaddressresponse

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

زمینه های
result

ValidationResult

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

response_id

string

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

اعتبار سنجی

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

زمینه های
verdict

Verdict

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

address

Address

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

geocode

Geocode

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

metadata

AddressMetadata

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

usps_data

UspsData

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

english_latin_address

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 وجود ندارد.

حکم

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

زمینه های
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 مراجعه کنید.

دانه دانه بودن

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

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