- طلب HTTP
- نص الطلب
- نص الاستجابة
- PostalAddress
- LanguageOptions
- ValidationResult
- Verdict
- الدقة
- العنوان
- AddressComponent
- ComponentName
- ConfirmationLevel
- الرمز الجغرافي
- LatLng
- PlusCode
- مساحة العرض
- AddressMetadata
- UspsData
- UspsAddress
للتحقّق من صحة عنوان
طلب HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "address": { object ( |
الحقول | |
---|---|
address |
مطلوب. يتم التحقّق من العنوان. يجب إرسال العناوين غير المنسَّقة عبر يجب ألا يتجاوز إجمالي طول الحقول في هذا الإدخال 280 حرفًا. يمكنك الاطّلاع على المناطق التي تتوفّر فيها الخدمة هنا. تم حجز القيمة تتجاهل واجهة برمجة التطبيقات Address Validation API القيم في |
previousResponseId |
يجب أن يكون هذا الحقل فارغًا لطلب التحقّق من العنوان الأول. إذا كانت هناك حاجة إلى المزيد من الطلبات للتحقّق بالكامل من عنوان واحد (على سبيل المثال، إذا كان يجب إعادة التحقّق من التغييرات التي يجريها المستخدم بعد عملية التحقّق الأولية)، يجب أن يملؤ كل طلب متابعة هذا الحقل بالقيمة |
enableUspsCass |
تفعيل الوضع المتوافق مع USPS CASS لا يؤثر ذلك إلا في حقل ننصحك باستخدام |
languageOptions |
اختياريّ. الإصدار التجريبي: تتوفّر هذه الميزة في إصدار تجريبي (قبل طرحها للجميع). قد يكون الدعم المقدَّم للمنتجات والميزات في مرحلة ما قبل الإصدار العلني محدودًا، وقد لا تكون التغييرات التي يتم إجراؤها على المنتجات والميزات في مرحلة ما قبل الإصدار العلني متوافقة مع الإصدارات الأخرى من مرحلة ما قبل الإصدار العلني. تخضع "عروض مرحلة ما قبل الإطلاق" للأحكام المحدّدة لخدمة Google Maps Platform. لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق. يتيح هذا الخيار لواجهة برمجة التطبيقات Address Validation API تضمين معلومات إضافية في الردّ. |
sessionToken |
اختياريّ. سلسلة تحدِّد جلسة الإكمال التلقائي لأغراض الفوترة يجب أن تكون سلسلة base64 آمنة لعنوان URL واسم الملف، ويجب ألا يزيد طولها عن 36 حرفًا ASCII. بخلاف ذلك، يتم عرض الخطأ INVALID_ARGUMENT. تبدأ الجلسة عندما يُجري المستخدم طلب بحث في ميزة "الإكمال التلقائي"، وتنتهي عندما يختار مكانًا ويتم إجراء طلب إلى "تفاصيل المكان" أو "إثبات صحة العنوان". يمكن أن تحتوي كل جلسة على طلبات بحث متعددة من خلال ميزة "الإكمال التلقائي"، متبوعة بطلب واحد من طلبات "تفاصيل المكان" أو "التحقّق من العنوان". يجب أن تنتمي بيانات الاعتماد المستخدَمة لكل طلب ضمن جلسة إلى مشروع Google Cloud Console نفسه. بعد انتهاء الجلسة، لن يعود الرمز المميّز صالحًا، ويجب أن ينشئ تطبيقك رمزًا مميّزًا جديدًا لكل جلسة. في حال حذف المَعلمة ملاحظة: لا يمكن استخدام ميزة "التحقّق من العنوان" إلا في الجلسات التي تستخدم واجهة برمجة التطبيقات الخاصة بميزة "الإكمال التلقائي (الإصدار الجديد)"، وليس واجهة برمجة التطبيقات الخاصة بميزة "الإكمال التلقائي". اطّلِع على https://developers.google.com/maps/documentation/places/web-service/session-pricing لمزيد من التفاصيل. |
نص الاستجابة
ردّ على طلب التحقّق من عنوان
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"result": {
object ( |
الحقول | |
---|---|
result |
نتيجة عملية إثبات صحة العنوان |
responseId |
معرّف UUID الذي يحدّد هذه الاستجابة. إذا كان يجب إعادة التحقّق من صحة العنوان، يجب إرفاق معرّف UUID هذا بالطلب الجديد. |
PostalAddress
يمثّل عنوانًا بريديًا (مثلاً، لتسليم البريد أو عناوين الدفعات). استنادًا إلى عنوان بريدي، يمكن لخدمة بريدية تسليم السلع إلى مبنى أو صندوق بريد أو ما شابه ذلك. ولا يهدف إلى وضع نماذج للمواقع الجغرافية (الطرق والبلدات والجبال).
في الاستخدام العادي، يتم إنشاء عنوان من خلال إدخال المستخدم أو من خلال استيراد البيانات الحالية، وذلك حسب نوع العملية.
نصائح حول إدخال العناوين أو تعديلها: - استخدِم تطبيق مصغّر للعناوين متوافقًا مع الترجمة والنشر في لغات متعددة، مثل 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 |
إنّ رمز اللغة في عنوان الإدخال محجوز للاستخدامات المستقبلية ويتم تجاهله حاليًا. تعرض واجهة برمجة التطبيقات العنوان باللغة المناسبة للموقع الجغرافي للعنوان. |
postalCode |
اختياريّ. الرمز البريدي للعنوان لا تستخدم بعض البلدان الرموز البريدية أو تطلب إدخالها، ولكن في البلدان التي يتم استخدامها فيها، قد تؤدي إلى إجراء عمليات تحقّق إضافية مع أجزاء أخرى من العنوان (على سبيل المثال، التحقّق من الرمز البريدي أو الرمز الجغرافي في الولايات المتحدة). |
sortingCode |
اختياريّ. رمز ترتيب إضافي خاص بكل بلد ولا يتم استخدام هذا الإجراء في معظم المناطق. في البلدان التي يتم فيها استخدام هذه السمة، تكون القيمة إما سلسلة مثل CEDEX، متبوعة اختياريًا برقم (على سبيل المثال، CEDEX 7)، أو رقمًا فقط يمثّل "رمز القطاع" (جامايكا) أو "مؤشر منطقة التسليم" (ملاوي) أو "مؤشر مكتب البريد" (ساحل العاج). |
administrativeArea |
اختياريّ. أعلى تقسيم فرعي إداري يُستخدَم للعناوين البريدية لبلد أو منطقة. على سبيل المثال، يمكن أن يكون ذلك ولاية أو مقاطعة أو إقليمًا أو محافظة. في إسبانيا، يشير هذا الحقل إلى المقاطعة وليس إلى المنطقة الذاتية الحكم (على سبيل المثال، "برشلونة" وليس "كتالونيا"). لا تستخدم العديد من البلدان منطقة إدارية في العناوين البريدية. على سبيل المثال، في سويسرا، يجب عدم ملء هذا الحقل. |
locality |
اختياريّ. يشير هذا الحقل بشكل عام إلى جزء المدينة أو البلدة من العنوان. أمثلة: مدينة أمريكية، بلدية إيطالية، مدينة بريدية في المملكة المتحدة في المناطق التي لم يتم فيها تحديد المواقع الجغرافية بشكل جيد أو لا تتناسب مع هذه البنية، اترك الحقل |
sublocality |
اختياريّ. البلدة الفرعية للعنوان على سبيل المثال، يمكن أن يكون حيًا أو منطقة إدارية أو دائرة. |
addressLines[] |
مطلوب. سطور عناوين غير منظَّمة تصف المستويات الدنيا للعنوان |
recipients[] |
يُرجى تجنُّب ضبط هذا الحقل. ولا تستخدِم واجهة برمجة التطبيقات Address Validation API هذا الإجراء حاليًا. على الرغم من أنّ واجهة برمجة التطبيقات لن ترفض في الوقت الحالي الطلبات التي تم ضبط هذا الحقل فيها، سيتم تجاهل المعلومات ولن يتم عرضها في الاستجابة. |
organization |
يُرجى تجنُّب ضبط هذا الحقل. ولا تستخدِم واجهة برمجة التطبيقات Address Validation API هذا الإجراء حاليًا. على الرغم من أنّ واجهة برمجة التطبيقات لن ترفض في الوقت الحالي الطلبات التي تم ضبط هذا الحقل فيها، سيتم تجاهل المعلومات ولن يتم عرضها في الاستجابة. |
LanguageOptions
معاينة: هذه الميزة متوفّرة في مرحلة المعاينة (قبل طرحها للجميع). قد يكون الدعم المقدَّم للمنتجات والميزات في مرحلة ما قبل الإصدار العلني محدودًا، وقد لا تكون التغييرات التي يتم إجراؤها على المنتجات والميزات في مرحلة ما قبل الإصدار العلني متوافقة مع الإصدارات الأخرى من مرحلة ما قبل الإصدار العلني. تخضع "عروض مرحلة ما قبل الإطلاق" للأحكام المحدّدة لخدمة Google Maps Platform. لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق.
يتيح هذا الخيار لواجهة برمجة التطبيقات Address Validation API تضمين معلومات إضافية في الردّ.
تمثيل JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
الحقول | |
---|---|
returnEnglishLatinAddress |
المعاينة: عرض |
ValidationResult
نتيجة التحقّق من عنوان
الحقول | |
---|---|
verdict |
علامات البيان العام |
address |
معلومات عن العنوان نفسه بدلاً من الترميز الجغرافي |
geocode |
معلومات عن الموقع الجغرافي والمكان الذي تم ترميز العنوان جغرافيًا به |
metadata |
معلومات أخرى ذات صلة بإمكانية التسليم لا يمكن ضمان تعبئة الحقل |
uspsData |
علامات إضافية لإمكانية التسليم تقدّمها USPS لا يتوفّر إلا في المنطقة |
englishLatinAddress |
الإصدار التجريبي: تتوفّر هذه الميزة في إصدار تجريبي (قبل طرحها للجميع). قد يكون الدعم المقدَّم للمنتجات والميزات في مرحلة ما قبل الإصدار العلني محدودًا، وقد لا تكون التغييرات التي يتم إجراؤها على المنتجات والميزات في مرحلة ما قبل الإصدار العلني متوافقة مع الإصدارات الأخرى من مرحلة ما قبل الإصدار العلني. تخضع "عروض مرحلة ما قبل الإطلاق" للأحكام المحدّدة لخدمة Google Maps Platform. لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق. العنوان المترجَم إلى الإنجليزية لا يمكن إعادة استخدام العناوين المترجَمة كمدخلات لواجهة برمجة التطبيقات. تقدّم الخدمة هذه الرسائل كي يتمكّن المستخدم من استخدام لغته الأم لتأكيد صحة العنوان المقدَّم في الأصل أو رفضه. إذا لم يكن هناك ترجمة باللغة الإنجليزية لأحد أجزاء العنوان، تعرض الخدمة هذا الجزء بلغة بديلة تستخدم نصًا لاتينيًا. يمكنك الاطّلاع هنا على شرح لكيفية اختيار اللغة البديلة. إذا لم يتضمّن جزء من العنوان أي ترجمات أو تحويلات إلى الأبجدية اللاتينية بلغة تستخدم الأبجدية اللاتينية، تعرض الخدمة هذا الجزء باللغة المحلية المرتبطة بالعنوان. يمكنك تفعيل هذا الإخراج باستخدام العلامة ملاحظة: لم تتم تعبئة حقل |
النتيجة
نظرة عامة على مستوى عالٍ حول نتيجة التحقّق من العنوان والرقم الجغرافي
تمثيل JSON |
---|
{ "inputGranularity": enum ( |
الحقول | |
---|---|
inputGranularity |
دقة عنوان الإدخال هذه هي نتيجة تحليل عنوان الإدخال ولا تعطي أي إشارات للتحقّق من الصحة. بالنسبة إلى إشارات التحقّق، يُرجى الرجوع إلى على سبيل المثال، إذا كان عنوان الإدخال يتضمّن رقم شقة محدّدًا، سيكون |
validationGranularity |
مستوى الدقة الذي يمكن لواجهة برمجة التطبيقات التحقّق من العنوان بالكامل. على سبيل المثال، يشير يمكن العثور على نتيجة التحقّق من كلّ مكوّن من مكوّنات العنوان في |
geocodeGranularity |
معلومات عن درجة دقة وقد يختلف هذا الرقم عن |
addressComplete |
يُعتبر العنوان مكتملاً إذا لم تكن هناك رموز غير محدّدة أو عناصر عنوان غير متوقّعة أو غير متوفّرة. إذا لم يتم ضبطها، تشير إلى أنّ القيمة هي |
hasUnconfirmedComponents |
لا يمكن تصنيف مكوّن عنوان واحد على الأقل أو التحقّق منه، يُرجى الاطّلاع على |
hasInferredComponents |
تم استنتاج (إضافة) مكوّن عنوان واحد على الأقل لم يكن مضمّنًا في الإدخال، يُرجى الاطّلاع على |
hasReplacedComponents |
تم استبدال مكوّن عنوان واحد على الأقل، يُرجى الاطّلاع على |
الدقة
المستويات المختلفة من الدقة التي يمكن أن يمتلكها العنوان أو الرمز الجغرافي عند استخدامها للإشارة إلى درجة دقة عنوان، تشير هذه القيم إلى درجة الدقة التي يحدّد بها العنوان وجهة إرسال البريد. على سبيل المثال، يحدِّد عنوان مثل "123 Main Street, Redwood City, CA, 94061" PREMISE
، في حين يحدِّد عنوان مثل "Redwood City, CA, 94061" LOCALITY
. ومع ذلك، إذا تعذّر علينا العثور على رمز جغرافي لـ "123 Main Street" في Redwood City، قد يكون الرمز الجغرافي الذي يتم عرضه بدقة LOCALITY
على الرغم من أنّ العنوان أكثر دقة.
عمليات التعداد | |
---|---|
GRANULARITY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
SUB_PREMISE |
نتيجة على مستوى أقل من مستوى المبنى، مثل شقة |
PREMISE |
نتيجة على مستوى المبنى |
PREMISE_PROXIMITY |
ترميز جغرافي يقترب من الموقع الجغرافي للعنوان على مستوى المبنى |
BLOCK |
يشير العنوان أو الرمز الجغرافي إلى مجموعة. لا يتم استخدامها إلا في المناطق التي تستخدم العناوين على مستوى الكتل، مثل اليابان. |
ROUTE |
يكون الرمز الجغرافي أو العنوان دقيقًا للمسار، مثل شارع أو طريق أو طريق سريع. |
OTHER |
جميع الدقائق الأخرى التي يتم تجميعها معًا لأنّها غير قابلة للعرض |
العنوان
تفاصيل العنوان بعد معالجته تشمل مرحلة ما بعد المعالجة تصحيح الأجزاء التي تحتوي على أخطاء إملائية في العنوان واستبدال الأجزاء غير الصحيحة واستنتاج الأجزاء المفقودة.
تمثيل JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
الحقول | |
---|---|
formattedAddress |
العنوان الذي تمّت معالجته، وهو بتنسيق عنوان سطر واحد وفقًا لقواعد تنسيق العناوين في المنطقة التي يقع فيها العنوان ملاحظة: قد لا يتطابق تنسيق هذا العنوان مع تنسيق العنوان في الحقل |
postalAddress |
العنوان الذي تمّت معالجته بعد ذلك والممثّل كعنوان بريدي |
addressComponents[] |
قائمة بدون ترتيب مكونات العنوان الفردية للعنوان المنسَّق والمصحَّح، بالإضافة إلى معلومات التحقّق من الصحة تقدّم هذه الصفحة معلومات عن حالة التحقّق من المكونات الفردية. لا يتم ترتيب مكوّنات العنوان بطريقة معيّنة. لا تفترض أي ترتيب لعناصر العنوان في القائمة. |
missingComponentTypes[] |
أنواع المكوّنات التي كان من المتوقّع أن تكون متوفّرة في عنوان بريدي منسّق بشكل صحيح ولكن لم يتم العثور عليها في الإدخال ولم يكن من الممكن استنتاجها. على سبيل المثال، ملاحظة: قد يظهر لك نوع مكوّن غير متوفّر عندما تعتقد أنّك قد قدّمت المكوّن غير المتوفّر. على سبيل المثال، يمكن أن يحدث ذلك عندما يحتوي عنوان الإدخال على اسم المبنى، ولكن ليس رقم المبنى. في العنوان "渋谷区渋谷3丁目 Shibuya Stream"، يحتوي اسم المبنى "Shibuya Stream" على نوع المكوّن |
unconfirmedComponentTypes[] |
أنواع المكوّنات المتوفّرة في |
unresolvedTokens[] |
أي رموز مميّزة في الإدخال تعذّر حلّها قد يكون هذا إدخالًا لم يتم التعرّف عليه كجزء صالح من عنوان. على سبيل المثال، بالنسبة إلى إدخال مثل "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US"، قد تبدو الرموز المميّزة غير المحسَّنة على النحو التالي |
AddressComponent
يمثّل مكوّن عنوان، مثل شارع أو مدينة أو ولاية.
تمثيل JSON |
---|
{ "componentName": { object ( |
الحقول | |
---|---|
componentName |
اسم هذا المكوّن. |
componentType |
نوع مكوّن العنوان اطّلِع على الجدول 2: الأنواع الإضافية التي تعرضها خدمة "الأماكن" للحصول على قائمة بالأنواع المحتملة. |
confirmationLevel |
يشير إلى مستوى التأكّد من صحة المكوّن. |
inferred |
يشير ذلك إلى أنّ المكوّن لم يكن جزءًا من الإدخال، ولكننا استنتجناه من موقع العنوان ونعتقد أنّه يجب تقديمه لعنوان كامل. |
spellCorrected |
يشير إلى تصحيح خطأ إملائي في اسم المكوّن. لا تُبلغ واجهة برمجة التطبيقات دائمًا عن التغييرات من صيغة إملائية إلى أخرى، مثل تغيير "centre" إلى "center". ولا تشير الأداة أيضًا دائمًا إلى الأخطاء الإملائية الشائعة، مثل تغيير "Amphitheater Pkwy" إلى "Amphitheatre Pkwy". |
replaced |
يشير ذلك إلى أنّه تم استبدال اسم المكوّن باسم مختلف تمامًا، على سبيل المثال، استبدال رمز بريدي غير صحيح برمز صحيح للعنوان. هذا ليس تغييرًا جماليًا، بل تم تغيير مكوّن الإدخال إلى مكوّن مختلف. |
unexpected |
يشير إلى مكوّن عنوان غير متوقّع أن يكون متوفّرًا في عنوان بريدي للمنطقة المحدّدة. ولم نحتفظ به إلا لأنّه كان جزءًا من الإدخال. |
ComponentName
عنصر ملفوف لاسم المكوّن
تمثيل JSON |
---|
{ "text": string, "languageCode": string } |
الحقول | |
---|---|
text |
نص الاسم. على سبيل المثال، "الشارع الخامس" لاسم شارع أو "1253" لرقم شارع. |
languageCode |
رمز اللغة وفقًا لمعيار BCP-47 لن يظهر هذا الحقل إذا لم يكن اسم المكوّن مرتبطًا بلغة، مثل رقم شارع. |
ConfirmationLevel
القيم المختلفة المحتمَلة لمستويات التأكيد
عمليات التعداد | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
CONFIRMED |
لقد تمكّنا من التحقّق من توفّر هذا المكوّن ومن أنّه منطقي في سياق بقية العنوان. |
UNCONFIRMED_BUT_PLAUSIBLE |
تعذّر تأكيد هذا المكوّن، ولكن من المرجّح أن يكون متوفّرًا. على سبيل المثال، رقم شارع ضمن نطاق صالح معروف من الأرقام في شارع لا يُعرف فيه أرقام منازل معيّنة. |
UNCONFIRMED_AND_SUSPICIOUS |
لم يتم تأكيد هذا المكوّن ومن المرجّح أن يكون غير صحيح. على سبيل المثال، حي لا يناسب بقية العنوان |
الرمز الجغرافي
يحتوي على معلومات عن المكان الذي تمّ ترميزه جغرافيًا.
الحقول | |
---|---|
location |
الموقع الجغرافي المشفَّر جغرافيًا للبيانات المُدخلة. يُفضّل استخدام معرّفات الأماكن بدلاً من استخدام العناوين أو إحداثيات خطوط الطول والعرض أو رموز Plus Codes. سيؤدي استخدام الإحداثيات عند تحديد المسار أو احتساب اتجاهات القيادة إلى ربط النقطة دائمًا بالطريق الأقرب إلى تلك الإحداثيات. قد لا تكون هذه الطريق تؤدي إلى الوجهة بسرعة أو بأمان، وقد لا تكون قريبة من نقطة وصول إلى الموقع. بالإضافة إلى ذلك، عند ترميز موقع جغرافي عكسيًا، لا يمكن ضمان أن يتطابق العنوان المعروض مع العنوان الأصلي. |
plusCode |
رمز Plus Codes المقابل للموقع الجغرافي |
bounds |
حدود المكان الذي تم ترميزه جغرافيًا |
featureSizeMeters |
حجم المكان الذي تم ترميزه جغرافيًا، بالمتر هذا مقياس آخر لخشونة الموقع الجغرافي المُشفَّر جغرافيًا، ولكن من حيث الحجم المادي وليس المعنى الدلالي. |
placeId |
رقم تعريف المكان الذي يتم ترميزه جغرافيًا باستخدام هذا الإدخال. لمزيد من المعلومات عن أرقام تعريف الأماكن، يُرجى الاطّلاع على هذا الرابط. |
placeTypes[] |
أنواع الأماكن التي تم ترميزها جغرافيًا باستخدام الإدخال مثلاً: |
LatLng
عنصر يمثّل زوجًا من خطوط العرض/خطوط الطول ويتم التعبير عن ذلك كزوج من الأعداد المزدوجة لتمثيل درجات خط العرض ودرجات خط الطول. يجب أن يكون هذا العنصر متوافقًا مع معيار WGS84 ما لم يتم تحديد خلاف ذلك. يجب أن تكون القيم ضمن النطاقات العادية.
تمثيل JSON |
---|
{ "latitude": number, "longitude": number } |
الحقول | |
---|---|
latitude |
خط العرض بالدرجات يجب أن يكون ضمن النطاق [-90.0, +90.0]. |
longitude |
خط الطول بالدرجات يجب أن تكون ضمن النطاق [-180.0, +180.0]. |
PlusCode
رمز Plus Codes (http://plus.codes) هو مرجع موقع جغرافي يتضمّن تنسيقَين: رمز عالمي يحدّد مستطيلاً أصغر أو أكبر بقياس 14 مترًا في 14 مترًا (1/8000 من الدرجة)، ورمز مركب يستبدل البادئة بموقع جغرافي مرجعي.
تمثيل JSON |
---|
{ "globalCode": string, "compoundCode": string } |
الحقول | |
---|---|
globalCode |
الرمز العالمي (الكامل) للمكان، مثل "9FWM33GV+HQ"، الذي يمثّل منطقة بدرجة 1/8000 و1/8000 (حوالي 14 مترًا في 14 مترًا) |
compoundCode |
الرمز المركب للمكان، مثل "33GV+HQ، رامبرغ، النرويج"، الذي يحتوي على اللاحقة للرمز الشامل ويستبدل البادئة باسم منسَّق لكيان مرجعي |
إطار العرض
إطار عرض لخطوط الطول والعرض، يتم تمثيله بنقطة 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
، ولا يمكن أن يكون المربّع المعروض فارغًا (على النحو المحدّد في التعريفات أعلاه). سيؤدي استخدام مساحة عرض فارغة إلى حدوث خطأ.
على سبيل المثال، تحيط إطار العرض هذا بمدينة نيويورك بالكامل:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
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 |
رمز نقطة التسليم المكوّن من رقمَين |
deliveryPointCheckDigit |
رقم التحقّق لنقطة التسليم تتم إضافة هذا الرقم إلى نهاية delivery_point_barcode للبريد الذي يتم فحصه آليًا. من المفترض أن تؤدي إضافة جميع أرقام delivery_point_barcode وdeliveryPointCheckDigit وpostal code وZIP+4 معًا إلى الحصول على رقم قابل للقسمة على 10. |
dpvConfirmation |
القيم المحتملة لتأكيد DPV لعرض حرف واحد أو عدم عرض أي قيمة.
|
dpvFootnote |
الهوامش من عملية التحقّق من نقطة التسليم يمكن ربط عدة حواشي سفلية معًا في السلسلة نفسها.
|
dpvCmra |
يشير إلى ما إذا كان العنوان تابعًا لوكالة CMRA (وكالة استلام البريد التجاري)، وهي وكالة خاصة تتلقّى البريد للعملاء. لعرض حرف واحد.
|
dpvVacant |
هل هذا المكان شاغر؟ لعرض حرف واحد.
|
dpvNoStat |
هل هذا عنوان لا يتضمّن إحصاءات أم عنوان نشط؟ إنّ العناوين غير المُسجَّلة هي العناوين التي لا يتمّ استخدامها بشكلٍ مستمر أو العناوين التي لا تخدمها خدمة USPS. لعرض حرف واحد.
|
dpvNoStatReasonCode |
يشير إلى نوع NoStat. لعرض رمز سبب كعدد صحيح.
|
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 |
مؤشر LACSLink |
poBoxOnlyPostalCode |
الرمز البريدي لصندوق البريد فقط |
suitelinkFootnote |
حواشي سفلية من مطابقة سجلّ شارع أو مبنى شاهق مع معلومات الجناح إذا تم العثور على تطابق في اسم النشاط التجاري، يتم عرض الرقم الثانوي.
|
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 |
رمز الولاية المكوّن من حرفَين |
zipCode |
الرمز البريدي، مثل 10009 |
zipCodeExtension |
إضافة الرمز البريدي المكوّن من 4 أرقام، مثل 5023 |