- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- آدرس پستی
- گزینه های زبان
- نتیجه اعتبارسنجی
- حکم
- دانه دانه بودن
- نشانی
- Address Component
- نام قطعه
- سطح تایید
- ژئوکد
- LatLng
- پلاس کد
- درگاه دید
- AddressMetadata
- UspsData
- آدرس Usps
یک آدرس را تأیید می کند.
درخواست HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "address": { object ( |
زمینه های | |
---|---|
address | ضروری. آدرس در حال تایید است. آدرسهای بدون قالب باید از طریق طول کل فیلدهای این ورودی نباید از 280 کاراکتر تجاوز کند. مناطق پشتیبانی شده را می توانید در اینجا پیدا کنید. مقدار Address Validation API مقادیر موجود در |
previousResponseId | این فیلد باید برای اولین درخواست اعتبارسنجی آدرس خالی باشد. اگر درخواستهای بیشتری برای اعتبارسنجی کامل یک آدرس ضروری باشد (مثلاً اگر تغییراتی که کاربر پس از تأیید اولیه انجام میدهد نیاز به تأیید مجدد داشته باشد)، هر درخواست پیگیری باید از همان اولین پاسخ در این قسمت با |
enableUspsCass | حالت سازگار با USPS CASS را فعال می کند. این فقط فیلد توصیه می شود از یک |
languageOptions | اختیاری. Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. Address Validation API را فعال می کند تا اطلاعات بیشتری را در پاسخ اضافه کند. |
sessionToken | اختیاری. رشته ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می کند. باید یک URL و نام فایل ایمن رشته base64 با حداکثر 36 کاراکتر اسکی باشد. در غیر این صورت یک خطای INVALID_ARGUMENT برگردانده می شود. جلسه زمانی شروع می شود که کاربر یک پرس و جو تکمیل خودکار انجام می دهد، و زمانی که یک مکان را انتخاب می کند و تماسی با جزئیات مکان یا اعتبارسنجی آدرس برقرار می شود، به پایان می رسد. هر جلسه میتواند چندین پرسوجو تکمیل خودکار داشته باشد و به دنبال آن یک درخواست جزییات مکان یا اعتبارسنجی آدرس ارائه شود. اعتبار استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان جلسه، رمز دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر توجه: اعتبار آدرس فقط در جلسات با API تکمیل خودکار (جدید) قابل استفاده است، نه API تکمیل خودکار. برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/session-pricing مراجعه کنید. |
بدن پاسخگو
پاسخ به یک درخواست اعتبار سنجی آدرس.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"result": {
object ( |
زمینه های | |
---|---|
result | نتیجه اعتبار سنجی آدرس |
responseId | UUID که این پاسخ را شناسایی می کند. اگر آدرس نیاز به تأیید مجدد داشته باشد، این UUID باید درخواست جدید را همراهی کند. |
آدرس پستی
نشان دهنده یک آدرس پستی است، به عنوان مثال برای آدرس های تحویل پستی یا پرداخت. با توجه به آدرس پستی، یک سرویس پستی می تواند اقلام را به محل، صندوق پستی یا موارد مشابه تحویل دهد. مدل سازی مکان های جغرافیایی (جاده ها، شهرها، کوه ها) در نظر گرفته نشده است.
در استفاده معمولی، بسته به نوع فرآیند، یک آدرس از طریق ورودی کاربر یا از وارد کردن دادههای موجود ایجاد میشود.
توصیههایی در مورد ورودی/ویرایش آدرس: - از ویجت آدرس آماده بینالمللیسازی مانند https://github.com/google/libaddressinput استفاده کنید - به کاربران نباید عناصر رابط کاربری برای ورودی یا ویرایش فیلدها در خارج از کشورهایی که آن فیلد وجود دارد ارائه شود. استفاده شده.
برای راهنمایی بیشتر در مورد نحوه استفاده از این طرح، لطفاً به این آدرس مراجعه کنید: https://support.google.com/business/answer/6397478
نمایندگی JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
زمینه های | |
---|---|
revision | بازبینی طرحواره |
regionCode | اختیاری. کد منطقه CLDR کشور/منطقه آدرس. برای جزئیات به https://cldr.unicode.org/ و https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html مراجعه کنید. مثال: "CH" برای سوئیس. اگر کد منطقه ارائه نشده باشد، از آدرس استنباط می شود. برای بهترین عملکرد، توصیه میشود در صورت اطلاع، کد منطقه را نیز وارد کنید. داشتن مناطق ناسازگار یا تکراری میتواند منجر به عملکرد ضعیف شود، برای مثال، اگر |
languageCode | کد زبان در آدرس ورودی برای استفاده های بعدی رزرو شده است و امروز نادیده گرفته می شود. API آدرس را به زبان مناسبی که آدرس در آن قرار دارد برمی گرداند. |
postalCode | اختیاری. کد پستی آدرس همه کشورها از وجود کدهای پستی استفاده نمیکنند یا نیاز به وجود کد پستی ندارند، اما در جایی که از آنها استفاده میشود، ممکن است اعتبار سنجی اضافی را با سایر قسمتهای آدرس (مثلاً اعتبارسنجی ایالت/زیپ در ایالات متحده آمریکا) ایجاد کنند. |
sortingCode | اختیاری. کد مرتبسازی اضافی، خاص کشور. این در اکثر مناطق استفاده نمی شود. در جایی که از آن استفاده میشود، مقدار یا رشتهای مانند «CEDEX» است، که به صورت اختیاری با یک عدد دنبال میشود (مثلاً «CEDEX 7»)، یا فقط یک عدد به تنهایی، نشاندهنده «کد بخش» (جامائیکا)، «نشانگر ناحیه تحویل» است. (مالاوی) یا «نشانگر اداره پست» (مثلاً ساحل عاج). |
administrativeArea | اختیاری. بالاترین بخش اداری که برای آدرس های پستی یک کشور یا منطقه استفاده می شود. به عنوان مثال، این می تواند یک ایالت، یک استان، یک استان یا یک استان باشد. به طور خاص، برای اسپانیا این استان است و نه جامعه خودمختار (مثلاً "بارسلونا" و نه "کاتالونیا"). بسیاری از کشورها از یک منطقه اداری در آدرس های پستی استفاده نمی کنند. به عنوان مثال در سوئیس این باید خالی از سکنه بماند. |
locality | اختیاری. عموماً به بخش شهر/شهرک آدرس اشاره دارد. مثال: شهر ایالات متحده، کمون فناوری اطلاعات، شهر پست بریتانیا. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند، محلی را خالی بگذارید و از خطوط آدرس استفاده کنید. |
sublocality | اختیاری. موقعیت فرعی آدرس به عنوان مثال، این می تواند محله، محله، منطقه باشد. |
addressLines[] | ضروری. خطوط آدرس بدون ساختار که سطوح پایین یک آدرس را توصیف می کند. |
recipients[] | لطفا از تنظیم این فیلد خودداری کنید. Address Validation API در حال حاضر از آن استفاده نمی کند. اگرچه در این زمان API درخواستهای دارای مجموعه فیلد را رد نمیکند، اطلاعات دور ریخته میشوند و در پاسخ بازگردانده نمیشوند. |
organization | لطفا از تنظیم این فیلد خودداری کنید. Address Validation API در حال حاضر از آن استفاده نمی کند. اگرچه در این زمان API درخواستهای دارای مجموعه فیلد را رد نمیکند، اطلاعات دور ریخته میشوند و در پاسخ بازگردانده نمیشوند. |
گزینه های زبان
Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.
Address Validation API را فعال می کند تا اطلاعات بیشتری را در پاسخ اضافه کند.
نمایندگی JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
زمینه های | |
---|---|
returnEnglishLatinAddress | پیش نمایش: یک |
نتیجه اعتبارسنجی
نتیجه اعتبارسنجی یک آدرس
نمایندگی JSON |
---|
{ "verdict": { object ( |
زمینه های | |
---|---|
verdict | پرچم های حکم کلی |
address | اطلاعات مربوط به خود آدرس بر خلاف ژئوکد. |
geocode | اطلاعات مربوط به مکان و مکانی که آدرس به آن کد جغرافیایی داده است. |
metadata | سایر اطلاعات مربوط به قابلیت تحویل |
uspsData | پرچم های تحویل اضافی ارائه شده توسط USPS. فقط در منطقه |
englishLatinAddress | Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. آدرس به انگلیسی ترجمه شده است. آدرس های ترجمه شده به عنوان ورودی API قابل استفاده مجدد نیستند. این سرویس آنها را فراهم می کند تا کاربر بتواند از زبان مادری خود برای تأیید یا رد اعتبار آدرس ارائه شده اصلی استفاده کند. اگر بخشی از آدرس دارای ترجمه انگلیسی نباشد، سرویس آن قسمت را به زبان دیگری که از خط لاتین استفاده می کند، برمی گرداند. برای توضیح نحوه انتخاب زبان جایگزین اینجا را ببینید. اگر بخشی از آدرس به زبانی که از خط لاتین استفاده میکند ترجمه یا نویسهگردانی نداشته باشد، سرویس آن قسمت را به زبان محلی مرتبط با آدرس برمیگرداند. این خروجی را با استفاده از پرچم توجه: فیلد |
حکم
نمای کلی سطح بالا از نتیجه اعتبارسنجی آدرس و کد جغرافیایی.
نمایندگی JSON |
---|
{ "inputGranularity": enum ( |
زمینه های | |
---|---|
inputGranularity | جزئیات آدرس ورودی این نتیجه تجزیه آدرس ورودی است و هیچ سیگنال اعتبار سنجی نمی دهد. برای سیگنالهای اعتبارسنجی، به به عنوان مثال، اگر آدرس ورودی شامل یک شماره آپارتمان خاص باشد، در اینجا |
validationGranularity | سطح دانه بندی که API می تواند آدرس را به طور کامل تأیید کند . به عنوان مثال، نتیجه تأیید مؤلفه هر آدرس را میتوانید در |
geocodeGranularity | اطلاعات در مورد دانه بندی این ممکن است با |
addressComplete | اگر هیچ نشانه حل نشده، هیچ مؤلفه آدرس غیرمنتظره یا گم نشده ای وجود نداشته باشد، آدرس کامل در نظر گرفته می شود. اگر تنظیم نشده باشد، نشان می دهد که مقدار |
hasUnconfirmedComponents | حداقل یک جزء آدرس را نمی توان طبقه بندی یا تأیید کرد، برای جزئیات به |
hasInferredComponents | حداقل یک جزء آدرس استنباط شد (اضافه شد) که در ورودی نبود، برای جزئیات به |
hasReplacedComponents | حداقل یک جزء آدرس جایگزین شده است، برای جزئیات به |
دانه دانه بودن
دانه بندی های مختلفی که یک آدرس یا یک ژئوکد می تواند داشته باشد. هنگامی که برای نشان دادن جزئیات برای یک آدرس استفاده میشود، این مقادیر نشان میدهند که آدرس تا چه اندازه یک مقصد پستی را مشخص میکند. به عنوان مثال، آدرسی مانند "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 | همه دانهبندیهای دیگر، که در کنار هم قرار میگیرند، زیرا قابل تحویل نیستند. |
نشانی
جزئیات آدرس پس از پردازش. پس پردازش شامل تصحیح قسمت های آدرس اشتباه املایی، جایگزینی قسمت های نادرست و استنباط قسمت های گم شده است.
نمایندگی JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
زمینه های | |
---|---|
formattedAddress | آدرس پس از پردازش، به عنوان یک آدرس تک خطی با پیروی از قوانین قالببندی آدرس منطقهای که آدرس در آن قرار دارد، قالببندی شده است. |
postalAddress | آدرس پس از پردازش به عنوان یک آدرس پستی نشان داده شده است. |
addressComponents[] | لیست نامرتب. اجزای آدرس منفرد آدرس فرمت شده و تصحیح شده، همراه با اطلاعات اعتبارسنجی. این اطلاعات در مورد وضعیت اعتبار سنجی اجزای جداگانه ارائه می دهد. اجزای آدرس به روش خاصی مرتب نمی شوند. هیچ گونه فرضی در مورد ترتیب اجزای آدرس در لیست انجام ندهید. |
missingComponentTypes[] | انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی با فرمت صحیح وجود داشته باشند اما در ورودی و یافت نشدند قابل استنباط نیستند. مؤلفههای این نوع در |
unconfirmedComponentTypes[] | انواع مؤلفههایی که در |
unresolvedTokens[] | هر نشانه ای در ورودی که قابل حل نیست. ممکن است این ورودی باشد که به عنوان بخشی معتبر از یک آدرس شناسایی نشده باشد (برای مثال در ورودی مانند "123235253253 Main St, San Francisco, CA, 94105"، نشانه های حل نشده ممکن است مانند |
Address Component
نشان دهنده یک جزء آدرس، مانند یک خیابان، شهر یا ایالت است.
نمایندگی JSON |
---|
{ "componentName": { object ( |
زمینه های | |
---|---|
componentName | نام این جزء |
componentType | نوع جزء آدرس جدول 2 را ببینید: انواع اضافی که توسط سرویس Places برگردانده شده است برای لیستی از انواع احتمالی. |
confirmationLevel | نشان دهنده میزان اطمینانی است که ما در مورد صحیح بودن مؤلفه داریم. |
inferred | نشان می دهد که مؤلفه بخشی از ورودی نبوده است، اما ما آن را برای مکان آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود. |
spellCorrected | تصحیح یک غلط املایی در نام مؤلفه را نشان می دهد. API همیشه تغییرات را از یک نوع املایی به دیگری علامت گذاری نمی کند، مانند زمانی که "مرکز" به "مرکز" تغییر می کند. همچنین همیشه اشتباهات املایی رایج را علامت گذاری نمی کند، مانند زمانی که "Amphitheatre Pkwy" را به "Amphitheatre Pkwy" تغییر می دهید. |
replaced | نشان می دهد که نام مؤلفه با یک نام کاملاً متفاوت جایگزین شده است، به عنوان مثال یک کد پستی اشتباه با کدی که برای آدرس صحیح است جایگزین شده است. این یک تغییر زیبایی نیست، جزء ورودی به دیگری تغییر کرده است. |
unexpected | یک جزء آدرس را نشان می دهد که انتظار نمی رود در آدرس پستی منطقه داده شده وجود داشته باشد. ما آن را فقط به این دلیل حفظ کرده ایم که بخشی از ورودی بوده است. |
نام قطعه
یک لفاف برای نام جزء.
نمایندگی JSON |
---|
{ "text": string, "languageCode": string } |
زمینه های | |
---|---|
text | متن نام. به عنوان مثال، "5th Avenue" برای نام یک خیابان یا "1253" برای یک شماره خیابان. |
languageCode | کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان مرتبط نباشد، این مورد وجود نخواهد داشت. |
سطح تایید
مقادیر مختلف ممکن برای سطوح تایید.
Enums | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED | مقدار پیش فرض. این مقدار استفاده نشده است. |
CONFIRMED | ما توانستیم تأیید کنیم که این مؤلفه در زمینه بقیه آدرس وجود دارد و منطقی است. |
UNCONFIRMED_BUT_PLAUSIBLE | این مؤلفه قابل تأیید نیست، اما وجود آن قابل قبول است. به عنوان مثال، یک شماره خیابان در محدوده معتبر شناخته شده اعداد در خیابانی که شماره خانه های خاصی در آن مشخص نیست. |
UNCONFIRMED_AND_SUSPICIOUS | این مؤلفه تأیید نشد و احتمالاً اشتباه است. مثلا محله ای که به بقیه آدرس نمی خورد. |
ژئوکد
حاوی اطلاعاتی درباره مکانی است که ورودی در آن کدگذاری شده است.
نمایندگی JSON |
---|
{ "location": { object ( |
زمینه های | |
---|---|
location | مکان جغرافیایی کد شده ورودی. استفاده از شناسههای مکان بر استفاده از آدرسها، مختصات طول و عرض جغرافیایی یا کدهای بعلاوه ترجیح داده میشود. استفاده از مختصات هنگام مسیریابی یا محاسبه مسیرهای رانندگی همیشه باعث می شود که نقطه به نزدیکترین جاده به آن مختصات گیر کند. ممکن است این جاده ای نباشد که به سرعت یا ایمن به مقصد منتهی شود و ممکن است نزدیک یک نقطه دسترسی به ملک نباشد. علاوه بر این، هنگامی که یک مکان معکوس جغرافیایی کدگذاری می شود، هیچ تضمینی وجود ندارد که آدرس برگشتی با آدرس اصلی مطابقت داشته باشد. |
plusCode | کد مثبت مربوط به |
bounds | محدوده مکان ژئوکد شده. |
featureSizeMeters | اندازه مکان ژئوکد شده، بر حسب متر. این یکی دیگر از معیارهای درشت بودن مکان جغرافیایی کد شده است، اما در اندازه فیزیکی به جای معنای معنایی. |
placeId | شناسه مکان مکانی که این ورودی به آن کد جغرافیایی میدهد. برای اطلاعات بیشتر درباره شناسههای مکان اینجا را ببینید. |
placeTypes[] | نوع(های) مکانی که ورودی به آن کدگذاری شده است. برای مثال، |
LatLng
شیئی که نشان دهنده یک جفت طول و عرض جغرافیایی است. این به صورت یک جفت دوتایی برای نشان دادن درجه عرض جغرافیایی و درجه طول جغرافیایی بیان می شود. مگر اینکه طور دیگری مشخص شده باشد، این شی باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال شده باشند.
نمایندگی JSON |
---|
{ "latitude": number, "longitude": number } |
زمینه های | |
---|---|
latitude | عرض جغرافیایی بر حسب درجه باید در محدوده [-90.0، +90.0] باشد. |
longitude | طول جغرافیایی بر حسب درجه باید در محدوده [-180.0، +180.0] باشد. |
پلاس کد
کد پلاس ( http://plus.codes ) یک مرجع مکان با دو قالب است: کد جهانی که مستطیل 14mx14m (1/8000 درجه) یا کوچکتر را تعریف می کند و کد ترکیبی که پیشوند را با یک مکان مرجع جایگزین می کند.
نمایندگی JSON |
---|
{ "globalCode": string, "compoundCode": string } |
زمینه های | |
---|---|
globalCode | کد جهانی (کامل) مکان، مانند "9FWM33GV+HQ"، که یک منطقه 1/8000 در 1/8000 درجه (~14 در 14 متر) را نشان می دهد. |
compoundCode | کد ترکیبی Place، مانند "33GV+HQ، Ramberg، Norway"، حاوی پسوند کد جهانی و جایگزینی پیشوند با نام قالب بندی شده یک نهاد مرجع. |
درگاه دید
یک نمای طول و عرض جغرافیایی که به صورت دو نقطه low
و high
به صورت مورب در مقابل هم نمایش داده می شود. یک viewport یک منطقه بسته در نظر گرفته می شود، یعنی شامل مرز آن می شود. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. موارد مختلف عبارتند از:
اگر
low
=high
، نمای از همان نقطه واحد تشکیل شده است.اگر
low.longitude
>high.longitude
, محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).اگر
low.longitude
= -180 درجه وhigh.longitude
= 180 درجه باشد، درگاه دید شامل تمام طولهای جغرافیایی میشود.اگر
low.longitude
= 180 درجه وhigh.longitude
= -180 درجه باشد، محدوده طول جغرافیایی خالی است.اگر
low.latitude
>high.latitude
، محدوده عرض جغرافیایی خالی است.
هر دو low
و high
باید پر شوند و کادر نمایش داده شده نمی تواند خالی باشد (همانطور که در تعاریف بالا مشخص شده است). یک نمای خالی منجر به خطا می شود.
به عنوان مثال، این نما به طور کامل شهر نیویورک را در بر می گیرد:
{ "low": { "Latitude": 40.477398, "Litude": -74.259087 }, "high": { "Latitude": 40.91618, "Latitude": -73.70018 } }
نمایندگی JSON |
---|
{ "low": { object ( |
زمینه های | |
---|---|
low | ضروری. نقطه پایین دید. |
high | ضروری. نقطه اوج دید. |
AddressMetadata
فراداده برای آدرس. metadata
برای هر آدرسی که به Address Validation API ارسال می شود، تضمین نمی شود.
نمایندگی JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
زمینه های | |
---|---|
business | نشان می دهد که این آدرس یک کسب و کار است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است. |
poBox | نشان می دهد که آدرس یک صندوق پستی. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است. |
residential | نشان می دهد که این آدرس یک محل سکونت است. اگر تنظیم نشده باشد، نشان دهنده ناشناخته بودن مقدار است. |
UspsData
داده های USPS برای آدرس. uspsData
برای هر آدرس ایالات متحده یا روابط عمومی ارسال شده به Address Validation API تضمین نمی شود که به طور کامل پر شود. اگر از uspsData به عنوان بخش اصلی پاسخ استفاده می کنید، توصیه می شود که فیلدهای آدرس پشتیبان را در پاسخ ادغام کنید.
نمایندگی JSON |
---|
{
"standardizedAddress": {
object ( |
زمینه های | |
---|---|
standardizedAddress | آدرس استاندارد USPS |
deliveryPointCode | کد نقطه تحویل 2 رقمی |
deliveryPointCheckDigit | رقم بررسی نقطه تحویل این شماره برای نامه های اسکن شده مکانیکی به انتهای بارکد_point_delivery اضافه می شود. با جمع کردن تمام ارقام delivery_point_barcode، deliveryPointCheckDigit، کد پستی و ZIP+4 باید عددی قابل بخش بر 10 به دست آید. |
dpvConfirmation | مقادیر ممکن برای تایید DPV. یک کاراکتر را برمیگرداند یا هیچ مقداری را برمیگرداند.
|
dpvFootnote | پاورقی از اعتبار سنجی نقطه تحویل. ممکن است چندین پاورقی در یک رشته به هم متصل شوند.
|
dpvCmra | نشان می دهد که آیا آدرس یک CMRA (آژانس دریافت نامه های تجاری) است - یک کسب و کار خصوصی که نامه دریافت می کند برای مشتریان. یک کاراکتر را برمیگرداند.
|
dpvVacant | آیا این مکان خالی است؟ یک کاراکتر را برمیگرداند.
|
dpvNoStat | آیا این یک آدرس بدون آمار است یا یک آدرس فعال؟ هیچ آدرس آماری، آدرس هایی نیستند که به طور مداوم اشغال نمی شوند یا آدرس هایی که USPS سرویس نمی دهد. یک کاراکتر را برمیگرداند.
|
dpvNoStatReasonCode | نوع NoStat را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند.
|
dpvDrop | پرچم نشان میدهد که نامهها به یک مورد در یک سایت تحویل داده میشود. یک کاراکتر را برمیگرداند.
|
dpvThrowback | نشان می دهد که نامه به آدرس خیابان تحویل داده نمی شود. یک کاراکتر را برمیگرداند.
|
dpvNonDeliveryDays | پرچم نشان می دهد که تحویل نامه در هر روز هفته انجام نمی شود. یک کاراکتر را برمیگرداند.
|
dpvNonDeliveryDaysValues | تعداد صحیح شناسایی روزهای بدون تحویل می توان آن را با استفاده از پرچم های بیت بازجویی کرد: 0x40 - یکشنبه یک روز بدون تحویل است 0x20 - دوشنبه یک روز بدون تحویل است 0x10 - سه شنبه یک روز بدون تحویل است 0x08 - چهارشنبه یک روز بدون تحویل است 0x04 - پنجشنبه یک روز غیر تحویل است -روز تحویل 0x02 - جمعه یک روز بدون تحویل است 0x01 - شنبه یک روز بدون تحویل است |
dpvNoSecureLocation | پرچم نشان می دهد که درب قابل دسترسی است، اما بسته به دلیل نگرانی های امنیتی باقی نخواهد ماند. یک کاراکتر را برمیگرداند.
|
dpvPbsa | نشان می دهد که آدرس با رکورد PBSA مطابقت داده شده است. یک کاراکتر را برمیگرداند.
|
dpvDoorNotAccessible | پرچم نشاندهنده آدرسهایی است که USPS نمیتواند برای تحویل نامه به درب بزند. یک کاراکتر را برمیگرداند.
|
dpvEnhancedDeliveryCode | نشان می دهد که بیش از یک کد بازگشتی DPV برای آدرس معتبر است. یک کاراکتر را برمیگرداند.
|
carrierRoute | کد مسیر حامل یک کد چهار کاراکتری متشکل از یک پیشوند یک حرفی و یک نشانگر مسیر سه رقمی. پیشوندها:
|
carrierRouteIndicator | نشانگر مرتبسازی نرخ مسیر حامل. |
ewsNoMatch | آدرس تحویل قابل تطبیق است، اما فایل EWS نشان می دهد که به زودی یک تطابق دقیق در دسترس خواهد بود. |
postOfficeCity | شهر پست اصلی |
postOfficeState | ایالت اداره پست اصلی |
abbreviatedCity | شهر به اختصار. |
fipsCountyCode | کد شهرستان FIPS. |
county | نام شهرستان. |
elotNumber | شماره خط سفر پیشرفته (eLOT). |
elotFlag | پرچم صعودی/نزولی eLOT (A/D). |
lacsLinkReturnCode | کد بازگشت LACSlink. |
lacsLinkIndicator | نشانگر LACSLlink. |
poBoxOnlyPostalCode | کد پستی فقط صندوق پستی |
suitelinkFootnote | پاورقی از تطبیق یک خیابان یا رکورد بلند با اطلاعات مجموعه. اگر نام تجاری مطابقت پیدا شود، شماره ثانویه برگردانده می شود.
|
pmbDesignator | تعیین کننده واحد PMB (جعبه پست خصوصی). |
pmbNumber | شماره PMB (صندوق پست خصوصی)؛ |
addressRecordType | نوع رکورد آدرسی که با آدرس ورودی مطابقت دارد.
|
defaultAddress | نشان می دهد که یک آدرس پیش فرض پیدا شده است، اما آدرس های خاص تری وجود دارد. |
errorMessage | پیام خطا برای بازیابی اطلاعات USPS. زمانی که پردازش USPS به دلیل شناسایی آدرسهای ایجاد شده مصنوعی به حالت تعلیق در میآید، پر میشود. فیلدهای داده USPS ممکن است در صورت وجود این خطا پر نشوند. |
cassProcessed | نشانگر این است که درخواست CASS پردازش شده است. |
آدرس Usps
نمایندگی USPS از یک آدرس ایالات متحده.
نمایندگی JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
زمینه های | |
---|---|
firstAddressLine | خط اول آدرس |
firm | نام شرکت. |
secondAddressLine | خط آدرس دوم |
urbanization | نام شهرنشینی پورتوریکویی |
cityStateZipAddressLine | شهر + ایالت + کد پستی. |
city | نام شهر. |
state | کد دولتی 2 حرفی |
zipCode | کد پستی به عنوان مثال 10009. |
zipCodeExtension | پسوند کد پستی 4 رقمی به عنوان مثال 5023. |
- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- آدرس پستی
- گزینه های زبان
- نتیجه اعتبارسنجی
- حکم
- دانه دانه بودن
- نشانی
- Address Component
- نام قطعه
- سطح تایید
- ژئوکد
- LatLng
- پلاس کد
- درگاه دید
- AddressMetadata
- UspsData
- آدرس Usps
یک آدرس را تأیید می کند.
درخواست HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "address": { object ( |
زمینه های | |
---|---|
address | ضروری. آدرس در حال تایید است. آدرسهای بدون قالب باید از طریق طول کل فیلدهای این ورودی نباید از 280 کاراکتر تجاوز کند. مناطق پشتیبانی شده را می توانید در اینجا پیدا کنید. مقدار Address Validation API مقادیر موجود در |
previousResponseId | این فیلد باید برای اولین درخواست اعتبارسنجی آدرس خالی باشد. اگر درخواستهای بیشتری برای اعتبارسنجی کامل یک آدرس ضروری باشد (مثلاً اگر تغییراتی که کاربر پس از تأیید اولیه انجام میدهد نیاز به تأیید مجدد داشته باشد)، هر درخواست پیگیری باید از همان اولین پاسخ در این قسمت با |
enableUspsCass | حالت سازگار با USPS CASS را فعال می کند. این فقط فیلد توصیه می شود از یک |
languageOptions | اختیاری. Preview: این ویژگی در Preview (pre-GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. Address Validation API را فعال می کند تا اطلاعات بیشتری را در پاسخ اضافه کند. |
sessionToken | اختیاری. رشته ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می کند. باید یک URL و نام فایل ایمن رشته base64 با حداکثر 36 کاراکتر اسکی باشد. در غیر این صورت یک خطای INVALID_ARGUMENT برگردانده می شود. جلسه زمانی شروع می شود که کاربر یک پرس و جو تکمیل خودکار انجام می دهد، و زمانی که یک مکان را انتخاب می کند و تماسی با جزئیات مکان یا اعتبارسنجی آدرس برقرار می شود، به پایان می رسد. هر جلسه میتواند چندین پرسوجو تکمیل خودکار داشته باشد و به دنبال آن یک درخواست جزییات مکان یا اعتبارسنجی آدرس ارائه شود. اعتبار استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان جلسه، رمز دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر توجه: اعتبارسنجی آدرس فقط در جلسات با API خودکار (جدید) قابل استفاده است ، نه API خودکار. برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/session-pricing مراجعه کنید. |
بدن پاسخ
پاسخ به درخواست اعتبارسنجی آدرس.
در صورت موفقیت ، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"result": {
object ( |
زمینه های | |
---|---|
result | نتیجه اعتبارسنجی آدرس. |
responseId | UUID که این پاسخ را مشخص می کند. اگر آدرس نیاز به اعتبار مجدد داشته باشد ، این UUID باید با درخواست جدید همراه باشد. |
آدرس پستی
یک آدرس پستی را نشان می دهد ، به عنوان مثال برای تحویل پستی یا آدرس های پرداخت. با توجه به آدرس پستی ، یک سرویس پستی می تواند مواردی را به یک فرضیه ، جعبه PO یا مشابه ارائه دهد. این برنامه برای مدل سازی مکانهای جغرافیایی (جاده ها ، شهرها ، کوه ها) در نظر گرفته نشده است.
در استفاده معمولی ، بسته به نوع فرآیند ، آدرس از طریق ورودی کاربر یا از وارد کردن داده های موجود ایجاد می شود.
مشاوره در مورد ورودی/ویرایش آدرس: - از ویجت آدرس آدرس بین المللی مانند https://github.com/google/libaddressinput استفاده کنید) - کاربران نباید برای ورودی یا ویرایش زمینه های خارج از کشورها که در آن قسمت قرار دارند ، با عناصر UI ارائه شوند استفاده شده.
برای راهنمایی بیشتر در مورد نحوه استفاده از این طرح ، لطفاً به آدرس زیر مراجعه کنید: https://support.google.com/business/answer/6397478
نمایندگی JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
زمینه های | |
---|---|
revision | تجدید نظر طرحواره از |
regionCode | اختیاری. کد منطقه CLDR از کشور/منطقه آدرس. برای جزئیات بیشتر به https://cldr.unicode.org/ و https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html مراجعه کنید. مثال: "Ch" برای سوئیس. اگر کد منطقه ارائه نشده باشد ، از آدرس استنباط می شود. برای بهترین عملکرد ، توصیه می شود اگر آن را می دانید کد منطقه را درج کنید. داشتن مناطق متناقض یا مکرر می تواند منجر به عملکرد ضعیف شود ، به عنوان مثال ، اگر |
languageCode | کد زبان در آدرس ورودی برای مصارف آینده محفوظ است و امروز نادیده گرفته می شود. API آدرس را به زبان مناسب برای محل قرار دادن آدرس برمی گرداند. |
postalCode | اختیاری. کد پستی آدرس. همه کشورها از کدهای پستی استفاده نمی کنند و یا نیاز به حضور ندارند ، اما در جایی که از آنها استفاده می شود ، ممکن است اعتبار بیشتری را با سایر قسمت های آدرس ایجاد کند (به عنوان مثال اعتبار سنجی حالت/ZIP در ایالات متحده). |
sortingCode | اختیاری. کد مرتب سازی اضافی ، خاص کشور. این در بیشتر مناطق استفاده نمی شود. در جایی که از آن استفاده می شود ، مقدار یا رشته ای مانند "Cedex" است ، به صورت اختیاری به دنبال یک شماره (به عنوان مثال "Cedex 7") یا فقط یک شماره ، نمایانگر "کد بخش" (جامائیکا) ، "نشانگر منطقه تحویل" است. (مالاوی) یا "نشانگر اداره پست" (به عنوان مثال Côte d'Ivoire). |
administrativeArea | اختیاری. بالاترین زیرمجموعه اداری که برای آدرسهای پستی یک کشور یا منطقه استفاده می شود. به عنوان مثال ، این می تواند یک کشور ، یک استان ، یک منطقه یا یک بخشدار باشد. به طور خاص ، برای اسپانیا این استان است و نه جامعه خودمختار (به عنوان مثال "بارسلونا" و نه "کاتالونیا"). بسیاری از کشورها در آدرسهای پستی از یک منطقه اداری استفاده نمی کنند. به عنوان مثال در سوئیس این باید بدون جمعیت باقی بماند. |
locality | اختیاری. به طور کلی به بخش شهر/شهر آدرس اشاره دارد. نمونه ها: شهر ایالات متحده ، IT Comune ، UK Post Town. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند ، محل را خالی بگذارید و از خطوط آدرس استفاده کنید. |
sublocality | اختیاری. زیرمجموعه آدرس. به عنوان مثال ، این می تواند محله ها ، ولسوالی ها ، ولسوالی ها باشد. |
addressLines[] | ضروری. خطوط آدرس بدون ساختار که سطح پایین یک آدرس را توصیف می کنند. |
recipients[] | لطفاً از تنظیم این قسمت خودداری کنید. API اعتبارسنجی آدرس در حال حاضر از آن استفاده نمی کند. اگرچه در این زمان API درخواست های این مجموعه را رد نمی کند ، اما اطلاعات دور ریخته می شوند و در پاسخ بازگردانده نمی شوند. |
organization | لطفاً از تنظیم این قسمت خودداری کنید. API اعتبارسنجی آدرس در حال حاضر از آن استفاده نمی کند. اگرچه در این زمان API درخواست های این مجموعه را رد نمی کند ، اما اطلاعات دور ریخته می شوند و در پاسخ بازگردانده نمی شوند. |
زبان زبانی
پیش نمایش: این ویژگی در پیش نمایش (پیش GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید.
API اعتبارسنجی آدرس را قادر می سازد تا اطلاعات اضافی را در پاسخ درج کند.
نمایندگی JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
زمینه های | |
---|---|
returnEnglishLatinAddress | پیش نمایش: یک |
اعتبار سنجی
نتیجه اعتبارسنجی یک آدرس.
نمایندگی JSON |
---|
{ "verdict": { object ( |
زمینه های | |
---|---|
verdict | پرچم های حکم کلی |
address | اطلاعات مربوط به خود آدرس بر خلاف GeoCode. |
geocode | اطلاعات مربوط به مکان و مکانی که آدرس به آن Geocododed می شود. |
metadata | سایر اطلاعات مربوط به تحویل. |
uspsData | پرچم های تحویل اضافی ارائه شده توسط USPS. فقط در منطقه |
englishLatinAddress | پیش نمایش: این ویژگی در پیش نمایش (پیش GA) است. محصولات و ویژگیهای Pre-GA ممکن است پشتیبانی محدودی داشته باشند، و تغییرات در محصولات و ویژگیهای pre-GA ممکن است با سایر نسخههای pre-GA سازگار نباشد. پیشنهادات قبل از GA تحت پوشش شرایط خاص سرویس پلتفرم Google Maps هستند. برای اطلاعات بیشتر، به توضیحات مرحله راه اندازی مراجعه کنید. آدرس ترجمه شده به انگلیسی. آدرس های ترجمه شده به عنوان ورودی API قابل استفاده مجدد نیستند. این سرویس آنها را فراهم می کند تا کاربر بتواند از زبان مادری خود برای تأیید یا انکار اعتبار آدرس اصلی ارائه شده استفاده کند. اگر بخشی از آدرس دارای ترجمه انگلیسی نباشد ، این سرویس آن قسمت را به یک زبان متناوب باز می گرداند که از یک اسکریپت لاتین استفاده می کند. برای توضیح نحوه انتخاب زبان متناوب اینجا را ببینید. اگر بخشی از آدرس هیچ ترجمه یا ترجمه ای به زبانی که از یک اسکریپت لاتین استفاده می کند ، ندارد ، این سرویس آن قسمت را به زبان محلی مرتبط با آدرس باز می گرداند. این خروجی را با استفاده از توجه: قسمت |
حکم
نمای کلی سطح بالا از نتیجه اعتبارسنجی آدرس و GeoCode.
نمایندگی JSON |
---|
{ "inputGranularity": enum ( |
زمینه های | |
---|---|
inputGranularity | دانه بندی آدرس ورودی . این نتیجه تجزیه و تحلیل آدرس ورودی است و هیچ سیگنال اعتبار سنجی نمی دهد. برای سیگنال های اعتبار سنجی ، به به عنوان مثال ، اگر آدرس ورودی شامل یک شماره آپارتمان خاص باشد ، در این صورت |
validationGranularity | سطح دانه ای که API می تواند آدرس را به طور کامل تأیید کند . به عنوان مثال ، نتیجه اعتبار سنجی مؤلفه آدرس را می توان در |
geocodeGranularity | اطلاعات مربوط به دانه بندی این می تواند متفاوت از |
addressComplete | در صورت عدم وجود نشانه های حل نشده ، هیچ مؤلفه آدرس غیر منتظره یا گمشده ، آدرس کامل در نظر گرفته می شود. در صورت عدم استفاده ، نشان می دهد که مقدار |
hasUnconfirmedComponents | حداقل یک مؤلفه آدرس را نمی توان طبقه بندی یا تأیید کرد ، برای جزئیات بیشتر به |
hasInferredComponents | حداقل یک مؤلفه آدرس استنباط شد (اضافه شده) که در ورودی نبود ، برای جزئیات بیشتر به |
hasReplacedComponents | حداقل یک مؤلفه آدرس جایگزین شد ، برای جزئیات بیشتر به |
دانه دانه بودن
دانه های مختلفی که یک آدرس یا یک ژئوکد می تواند داشته باشد. هنگامی که برای نشان دادن دانه بندی برای یک آدرس استفاده می شود ، این مقادیر نشان می دهد که چگونه یک دانه بندی خوب آدرس یک مقصد پستی را مشخص می کند. به عنوان مثال ، آدرس مانند "خیابان 123 اصلی ، شهر ردوود ، کالیفرنیا ، 94061" PREMISE
را مشخص می کند در حالی که چیزی مانند "Redwood City ، CA ، 94061" یک LOCALITY
مشخص می کند. با این حال ، اگر ما نتوانیم یک جغرافیایی را برای "خیابان 123 اصلی" در شهر ردوود پیدا کنیم ، Geocode برگشت یافته ممکن است از گرانول بودن LOCALITY
باشد ، حتی اگر این آدرس گرانول تر باشد.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED | مقدار پیش فرض. این مقدار بلااستفاده است. |
SUB_PREMISE | نتیجه سطح زیر ساخت ، مانند آپارتمان. |
PREMISE | نتیجه سطح ساختمان. |
PREMISE_PROXIMITY | ژئوکد که مکان سطح ساختمان آدرس را تقریبی می کند. |
BLOCK | آدرس یا geocode یک بلوک را نشان می دهد. فقط در مناطقی که دارای سطح بلوک هستند ، مانند ژاپن استفاده می شود. |
ROUTE | Geocode یا آدرس برای مسیر ، مانند خیابان ، جاده یا بزرگراه گرانول است. |
OTHER | تمام دانه های دیگر ، که از آنجا که قابل تحویل نیستند با هم جمع می شوند. |
نشانی
جزئیات آدرس پس از پردازش. پردازش پس از آن شامل تصحیح قسمت های غلط املایی ، جایگزینی قطعات نادرست و استنباط قطعات مفقود شده است.
نمایندگی JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
زمینه های | |
---|---|
formattedAddress | آدرس پس از پردازش ، به عنوان یک آدرس یک خط به دنبال قوانین قالب بندی آدرس منطقه که آدرس در آن قرار دارد ، قالب بندی شده است. |
postalAddress | آدرس پس از پردازش به عنوان یک آدرس پستی ارائه شده است. |
addressComponents[] | لیست نامرتب. مؤلفه های آدرس فردی آدرس فرمت شده و اصلاح شده ، به همراه اطلاعات اعتبار سنجی. این اطلاعات در مورد وضعیت اعتبار سنجی مؤلفه های فردی را ارائه می دهد. مؤلفه های آدرس به روشی خاص سفارش داده نمی شوند. هیچ فرضیه ای در مورد سفارش اجزای آدرس در لیست انجام ندهید. |
missingComponentTypes[] | انواع مؤلفه هایی که انتظار می رفت در یک آدرس پستی به درستی فرمت شده وجود داشته باشد اما در ورودی یافت نشد و قابل استنباط نیست. مؤلفه های این نوع در |
unconfirmedComponentTypes[] | انواع مؤلفه هایی که در |
unresolvedTokens[] | هر نشانه ای در ورودی که قابل حل نیست. این ممکن است ورودی باشد که به عنوان یک قسمت معتبر از یک آدرس شناخته نشده باشد (به عنوان مثال در ورودی مانند "123235253253 Main ST ، سان فرانسیسکو ، کالیفرنیا ، 94105" ، نشانه های حل نشده ممکن است مانند |
مؤلفه
نمایانگر یک مؤلفه آدرس مانند خیابان ، شهر یا ایالت است.
نمایندگی JSON |
---|
{ "componentName": { object ( |
زمینه های | |
---|---|
componentName | نام این مؤلفه. |
componentType | نوع مؤلفه آدرس. به جدول 2 مراجعه کنید: انواع اضافی که توسط سرویس مکان ها برای لیستی از انواع ممکن برگردانده شده است . |
confirmationLevel | نشان می دهد سطح یقین که ما در مورد این مؤلفه صحیح است. |
inferred | نشان می دهد که مؤلفه بخشی از ورودی نبود ، اما ما آن را برای محل آدرس استنباط کردیم و معتقدیم که باید برای یک آدرس کامل ارائه شود. |
spellCorrected | نشان دهنده تصحیح اشتباه غلط در نام مؤلفه است. API همیشه تغییرات را از یک نوع املا به دیگری تغییر نمی دهد ، مانند هنگام تغییر "مرکز" به "مرکز". همچنین همیشه غلط غلط های مشترک را پرچم نمی کند ، مانند هنگام تغییر "آمفی تئاتر PKWY" به "آمفی تئاتر PKWY". |
replaced | نشان می دهد که نام این مؤلفه با یک مورد کاملاً متفاوت جایگزین شده است ، به عنوان مثال یک کد پستی اشتباه با یک مورد مناسب برای آدرس جایگزین می شود. این یک تغییر آرایشی نیست ، مؤلفه ورودی به بخش دیگری تغییر یافته است. |
unexpected | یک مؤلفه آدرس را نشان می دهد که انتظار نمی رود در یک آدرس پستی برای منطقه مشخص وجود داشته باشد. ما فقط به این دلیل که بخشی از ورودی بود ، آن را حفظ کرده ایم. |
نام قطعه
بسته بندی برای نام مؤلفه.
نمایندگی JSON |
---|
{ "text": string, "languageCode": string } |
زمینه های | |
---|---|
text | متن نام به عنوان مثال ، "خیابان 5" برای نام خیابان یا "1253" برای شماره خیابان. |
languageCode | کد زبان BCP-47. اگر نام مؤلفه با زبانی مانند شماره خیابان همراه نباشد ، این امر وجود نخواهد داشت. |
سطح تأیید
مقادیر مختلف ممکن برای سطح تأیید.
Enums | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED | مقدار پیش فرض. این مقدار بلااستفاده است. |
CONFIRMED | ما توانستیم تأیید کنیم که این مؤلفه در زمینه بقیه آدرس وجود دارد. |
UNCONFIRMED_BUT_PLAUSIBLE | این مؤلفه قابل تأیید نیست ، اما قابل قبول است که وجود دارد. به عنوان مثال ، یک شماره خیابانی در یک محدوده معتبر شناخته شده در خیابان در خیابان که شماره های خاص خانه مشخص نیست. |
UNCONFIRMED_AND_SUSPICIOUS | این مؤلفه تأیید نشده و احتمالاً اشتباه خواهد بود. به عنوان مثال ، محله ای که متناسب با بقیه آدرس نیست. |
ژئوکد
حاوی اطلاعاتی در مورد مکانی است که ورودی به آن GeoCoded شده است.
نمایندگی JSON |
---|
{ "location": { object ( |
زمینه های | |
---|---|
location | محل جغرافیایی ورودی. استفاده از شناسه های مکان بیش از استفاده از آدرس ها ، مختصات عرض جغرافیایی/طول جغرافیایی یا کدهای به علاوه ترجیح داده می شود. استفاده از مختصات هنگام مسیریابی یا محاسبه جهت های رانندگی ، همیشه منجر به این خواهد شد که به جاده نزدیکترین به آن مختصات برسد. این ممکن است جاده ای نباشد که به سرعت یا با خیال راحت به مقصد منتهی شود و ممکن است در نزدیکی نقطه دسترسی به ملک نباشد. علاوه بر این ، هنگامی که یک مکان معکوس Geocoded است ، هیچ تضمینی وجود ندارد که آدرس برگشتی با اصل مطابقت داشته باشد. |
plusCode | کد به علاوه مربوط به |
bounds | مرزهای مکان جغرافیایی. |
featureSizeMeters | اندازه مکان جغرافیایی ، در متر. این یکی دیگر از معیارهای درشت مکان جغرافیایی است ، اما در اندازه فیزیکی و نه به معنای معنایی. |
placeId | مکانید مکانی که این ورودی جغرافیایی می کند. برای اطلاعات بیشتر در مورد شناسه های مکان ، اینجا را ببینید. |
placeTypes[] | نوع (های) مکانی که ورودی از آن استفاده می کند. به عنوان مثال ، |
لنگه
یک شیء که یک جفت عرض جغرافیایی/طول جغرافیایی را نشان می دهد. این به عنوان یک جفت دونفره برای نشان دادن طول و عرض جغرافیایی درجه و درجه ای بیان شده است. مگر اینکه در غیر این صورت مشخص شود ، این شیء باید مطابق با استاندارد WGS84 باشد. مقادیر باید در محدوده عادی باشند.
نمایندگی JSON |
---|
{ "latitude": number, "longitude": number } |
زمینه های | |
---|---|
latitude | عرض جغرافیایی در درجه. این باید در محدوده باشد [-90.0 ، +90.0]. |
longitude | طول جغرافیایی در درجه. این باید در محدوده باشد [-180.0 ، +180.0]. |
کد
کد به علاوه ( http://plus.codes ) یک مرجع مکان با دو قالب است: کد جهانی تعریف یک 14MX14M (1/8000 درجه درجه) یا مستطیل کوچکتر و کد مرکب ، جایگزین پیشوند با یک مکان مرجع.
نمایندگی JSON |
---|
{ "globalCode": string, "compoundCode": string } |
زمینه های | |
---|---|
globalCode | کد جهانی (کامل) مکان ، مانند "9FWM33GV+HQ" ، نماینده 1/8000 در منطقه 1/8000 درجه (14 پوند در 14 متر). |
compoundCode | کد مرکب Place مانند "33GV+HQ ، RAMBERG ، نروژ" ، حاوی پسوند کد جهانی و جایگزین کردن پیشوند با نام فرمت یک موجود مرجع. |
درگاه دید
نمای عرضه طول و عرض جغرافیایی ، که به عنوان دو مورب مخالف نقاط low
و high
نشان داده شده است. منظره یک منطقه بسته در نظر گرفته می شود ، یعنی مرز آن را شامل می شود. مرزهای عرض جغرافیایی باید بین -90 تا 90 درجه فراگیر باشد و مرزهای طول جغرافیایی باید بین -180 تا 180 درجه فراگیر باشد. موارد مختلف شامل:
اگر
low
=high
، نمای از همان نقطه واحد تشکیل شده است.اگر
low.longitude
>high.longitude
, محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).اگر
low.longitude
= -180 درجه وhigh.longitude
= 180 درجه باشد، درگاه دید شامل تمام طولهای جغرافیایی میشود.اگر
low.longitude
= 180 درجه وhigh.longitude
= -180 درجه باشد، محدوده طول جغرافیایی خالی است.اگر
low.latitude
>high.latitude
، محدوده عرض جغرافیایی خالی است.
هر دو low
و high
باید جمع شوند ، و جعبه نماینده نمی تواند خالی باشد (همانطور که توسط تعاریف فوق مشخص شده است). نمای خالی منجر به خطایی خواهد شد.
به عنوان مثال، این نما به طور کامل شهر نیویورک را در بر می گیرد:
{"کم": {"عرض جغرافیایی": 40.477398 ، "طول جغرافیایی": -74.259087} ، "بالا": {"عرض جغرافیایی": 40.91618 ، "طول": -73.70018}}}
نمایندگی JSON |
---|
{ "low": { object ( |
زمینه های | |
---|---|
low | ضروری. نقطه پایین منظره. |
high | ضروری. نقطه مرتفع منظره. |
سخنرانی
ابرداده برای آدرس. metadata
تضمین نمی شود که برای هر آدرس ارسال شده به API اعتبارسنجی آدرس کاملاً جمع شود.
نمایندگی JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
زمینه های | |
---|---|
business | نشان می دهد که این آدرس یک تجارت است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است. |
poBox | نشان می دهد که آدرس یک جعبه PO است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است. |
residential | نشان می دهد که این آدرس یک محل اقامت است. در صورت عدم استفاده ، نشان می دهد که مقدار ناشناخته است. |
uspsdata
داده های USPS برای آدرس. uspsData
تضمین نمی شود که برای همه ایالات متحده یا آدرس روابط عمومی ارسال شده به API اعتبارسنجی آدرس کاملاً جمع شود. در صورت استفاده از USPSDATA به عنوان قسمت اصلی پاسخ ، توصیه می شود زمینه های آدرس پشتیبان را در پاسخ ادغام کنید.
نمایندگی JSON |
---|
{
"standardizedAddress": {
object ( |
زمینه های | |
---|---|
standardizedAddress | آدرس استاندارد USPS. |
deliveryPointCode | کد نقطه تحویل 2 رقمی |
deliveryPointCheckDigit | رقم بررسی نقطه تحویل. این شماره برای نامه های اسکن شده مکانیکی به انتهای تحویل_point_barcode اضافه می شود. اضافه کردن تمام رقم های تحویل_point_barcode ، تحویل pointCheckDigit ، کد پستی و ZIP+4 با هم باید یک عدد قابل تقسیم تا 10 باشد. |
dpvConfirmation | مقادیر ممکن برای تأیید DPV. یک شخصیت واحد را برمی گرداند یا هیچ ارزش را برمی گرداند.
|
dpvFootnote | پاورقی ها از اعتبارسنجی نقطه تحویل. پاورقی های چندگانه ممکن است در همان رشته با هم جمع شوند.
|
dpvCmra | نشان می دهد که آیا آدرس یک CMRA است (آژانس دریافت کننده نامه تجاری)-یک مشاغل خصوصی که برای مشتری نامه دریافت می کند. یک شخصیت واحد را برمی گرداند.
|
dpvVacant | آیا این مکان خالی است؟ یک شخصیت واحد را برمی گرداند.
|
dpvNoStat | آیا این یک آدرس stat یا آدرس فعال است؟ هیچ آدرس آماری مواردی نیست که به طور مداوم اشغال نشده باشد یا آدرس هایی را که USPS ارائه نمی دهد ، آدرس دهد. یک شخصیت واحد را برمی گرداند.
|
dpvNoStatReasonCode | نوع نوستات را نشان می دهد. یک کد دلیل را به عنوان int برمی گرداند.
|
dpvDrop | پرچم نشان می دهد که نامه به یک گیرنده در یک سایت تحویل داده می شود. یک شخصیت واحد را برمی گرداند.
|
dpvThrowback | نشان می دهد که نامه به آدرس خیابان تحویل داده نمی شود. یک شخصیت واحد را برمی گرداند.
|
dpvNonDeliveryDays | پرچم نشان می دهد که تحویل نامه هر روز از هفته انجام نمی شود. یک شخصیت واحد را برمی گرداند.
|
dpvNonDeliveryDaysValues | عدد صحیح شناسایی روزهای غیر تحویل. با استفاده از پرچم های بیت قابل بازجویی است: 0x40-یکشنبه یک روز غیر تحویل 0x20 است-دوشنبه یک روز غیر تحویل 0x10 است-سه شنبه یک روز غیر تحویل 0x08 است-چهارشنبه یک روز غیر تحویل 0x04 است-پنجشنبه غیر است -روز تحویل 0x02-جمعه یک روز غیر تحویل 0x01 است-شنبه یک روز غیر تحویل است |
dpvNoSecureLocation | پرچم نشان می دهد که درب در دسترس است ، اما به دلیل نگرانی های امنیتی ، بسته باقی نمی ماند. یک شخصیت واحد را برمی گرداند.
|
dpvPbsa | نشان می دهد که آدرس با رکورد PBSA مطابقت داشت. یک شخصیت واحد را برمی گرداند.
|
dpvDoorNotAccessible | پرچم آدرس هایی را نشان می دهد که USPS برای تحویل نامه نمی تواند در را بکشد. یک شخصیت واحد را برمی گرداند.
|
dpvEnhancedDeliveryCode | نشان می دهد که بیش از یک کد بازگشت DPV برای آدرس معتبر است. یک شخصیت واحد را برمی گرداند.
|
carrierRoute | کد مسیر حامل. یک کد چهار کاراکتر متشکل از پیشوند یک حرف و یک طراح مسیر سه رقمی. پیشوندها:
|
carrierRouteIndicator | نشانگر مرتب سازی نرخ مسیر حامل. |
ewsNoMatch | آدرس تحویل قابل مطابقت است ، اما پرونده EWS نشان می دهد که یک مسابقه دقیق به زودی در دسترس خواهد بود. |
postOfficeCity | اداره اصلی اداره پست. |
postOfficeState | ایالت اصلی اداره پست. |
abbreviatedCity | شهر مختصر. |
fipsCountyCode | کد شهرستان FIPS. |
county | نام شهرستان |
elotNumber | شماره پیشرفته خط سفر (ELOT). |
elotFlag | پرچم صعودی/نزولی (A/D). |
lacsLinkReturnCode | کد بازگشت LACSLINK. |
lacsLinkIndicator | نشانگر lacslink. |
poBoxOnlyPostalCode | فقط کد پستی جعبه PO. |
suitelinkFootnote | پاورقی ها از مطابقت با یک خیابان یا رکورد Highrise تا اطلاعات مجموعه. اگر نام تجاری نام تجاری پیدا شود ، شماره ثانویه بازگردانده می شود.
|
pmbDesignator | PMB (جعبه پستی خصوصی) طراح واحد. |
pmbNumber | شماره PMB (جعبه پستی خصوصی) شماره ؛ |
addressRecordType | نوع ضبط آدرس که مطابق با آدرس ورودی است.
|
defaultAddress | نشانگر مبنی بر یافتن آدرس پیش فرض ، اما آدرس های خاص تری وجود دارد. |
errorMessage | پیام خطا برای بازیابی داده های USPS. این امر در شرایطی جمع می شود که پردازش USPS به دلیل تشخیص آدرس های مصنوعی ایجاد شده به حالت تعلیق در می آید. قسمتهای داده USPS ممکن است در صورت وجود این خطا جمع نشود. |
cassProcessed | نشانگر این است که درخواست CASS پردازش شده است. |
uspsaddress
نمایندگی USPS از یک آدرس ایالات متحده.
نمایندگی JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
زمینه های | |
---|---|
firstAddressLine | خط آدرس اول. |
firm | نام شرکت. |
secondAddressLine | خط آدرس دوم. |
urbanization | نام شهرنشینی پورتوریکو. |
cityStateZipAddressLine | شهر + ایالت + کد پستی. |
city | نام شهر. |
state | 2 کد دولت. |
zipCode | کد پستی به عنوان مثال 10009. |
zipCodeExtension | پسوند کد پستی 4 رقمی EG 5023. |