- طلب HTTP
- نص الطلب
- نص الاستجابة
- PostalAddress
- LanguageOptions
- ValidationResult
- الحكم
- درجة الدقة
- العنوان
- AddressComponent
- ComponentName
- ConfirmationLevel
- الترميز الجغرافي
- LatLng
- PlusCode
- إطار العرض
- AddressMetadata
- UspsData
- UspsAddress
للتحقق من صحة العنوان
طلب HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "address": { object ( |
الحقول | |
---|---|
address |
مطلوبة. العنوان الذي يتم التحقق منه. يجب إرسال العناوين غير المنسَّقة عبر يجب ألا يتجاوز إجمالي طول الحقول في هذا الإدخال 280 حرفًا. يمكن العثور على المناطق التي يتوفّر فيها التطبيق هنا. إنّ القيمة تتجاهل واجهة برمجة تطبيقات التحقق من صحة العنوان القيم في |
previousResponseId |
يجب أن يكون هذا الحقل فارغًا لطلب التحقق الأول من صحة العنوان. إذا كان من الضروري إجراء المزيد من الطلبات للتحقّق من صحة عنوان واحد بشكل كامل (على سبيل المثال، إذا كانت هناك حاجة إلى إعادة التحقّق من التغييرات التي يجريها المستخدم بعد عملية التحقّق الأولية)، يجب أن تتم تعبئة هذا الحقل بكل طلب متابعة بالرمز |
enableUspsCass |
تفعِّل هذه السياسة وضع التوافق مع خدمة USPS CASS. ويؤثر هذا فقط في الحقل ننصحك باستخدام سمة |
languageOptions |
اختياريّ. المعاينة: تتوفّر هذه الميزة ضمن المعاينة (مرحلة ما قبل التوفّر للجمهور العام). قد تحظى منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام بدعم محدود، وقد لا تتوافق التغييرات التي يتم إجراؤها على منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تخضع "عروض مرحلة ما قبل التوفّر للجمهور العام" للأحكام الخاصة بخدمة "منصة خرائط Google". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مرحلة الإطلاق. تتيح هذه السياسة واجهة برمجة تطبيقات التحقّق من صحة العنوان لتضمين معلومات إضافية في الرد. |
نص الاستجابة
الرد على طلب التحقق من العنوان.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل 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")، أو رقم فقط يمثّل "رمز القطاع" (Jamaica) أو "مؤشر منطقة التسليم" (مالاوي) أو "مؤشر مكتب البريد" (مثل ساحل العاج). |
administrativeArea |
اختياريّ. أعلى تقسيم فرعي إداري يُستخدم للعناوين البريدية لبلد أو منطقة. على سبيل المثال، يمكن أن تكون ولاية أو مقاطعة أو مقاطعة أو محافظة. وعلى وجه التحديد، بالنسبة إلى إسبانيا، تكون هذه المقاطعة وليست المجتمع المستقل (مثل "برشلونة" وليس "كاتالونيا"). لا يستخدم العديد من البلدان منطقة إدارية في العناوين البريدية. في سويسرا مثلاً، يجب ترك هذا الحقل فارغًا. |
locality |
اختياريّ. يشير بوجه عام إلى جزء المدينة/البلدة من العنوان. أمثلة: مدينة في الولايات المتحدة، بلدية تكنولوجيا المعلومات، مدينة البريد في المملكة المتحدة. في مناطق العالم حيث لم يتم تعريف المناطق المحلية بشكل جيد أو لا تتناسب مع هذا الهيكل بشكل جيد، اترك المنطقة المحلية فارغة واستخدم addressLines. |
sublocality |
اختياريّ. المنطقة المحلية الفرعية للعنوان. على سبيل المثال، يمكن أن يشمل ذلك الأحياء والأحياء والأحياء. |
addressLines[] |
مطلوبة. أسطر عناوين غير مهيكلة تصف المستويات الأدنى من العنوان. |
recipients[] |
يُرجى تجنُّب ضبط هذا الحقل. واجهة برمجة تطبيقات التحقق من صحة العنوان لا تستخدمها حاليًا. وعلى الرغم من أنّ واجهة برمجة التطبيقات لن ترفض في الوقت الحالي الطلبات التي تم تحديد مجموعة الحقول هذه فيها، سيتم تجاهل المعلومات ولن يتم عرضها في الاستجابة. |
organization |
يُرجى تجنُّب ضبط هذا الحقل. واجهة برمجة تطبيقات التحقق من صحة العنوان لا تستخدمها حاليًا. وعلى الرغم من أنّ واجهة برمجة التطبيقات لن ترفض في الوقت الحالي الطلبات التي تم تحديد مجموعة الحقول هذه فيها، سيتم تجاهل المعلومات ولن يتم عرضها في الاستجابة. |
LanguageOptions
المعاينة: تتوفّر هذه الميزة ضمن المعاينة (مرحلة ما قبل التوفّر للجمهور العام). قد تحظى منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام بدعم محدود، وقد لا تتوافق التغييرات التي يتم إجراؤها على منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تخضع "عروض مرحلة ما قبل التوفّر للجمهور العام" للأحكام الخاصة بخدمة "منصة خرائط Google". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مرحلة الإطلاق.
تتيح هذه السياسة واجهة برمجة تطبيقات التحقّق من صحة العنوان لتضمين معلومات إضافية في الرد.
تمثيل JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
الحقول | |
---|---|
returnEnglishLatinAddress |
معاينة: عرض |
ValidationResult
نتيجة التحقق من صحة العنوان.
تمثيل JSON |
---|
{ "verdict": { object ( |
الحقول | |
---|---|
verdict |
علامات القرار العامة |
address |
معلومات حول العنوان نفسه بخلاف الرمز الجغرافي. |
geocode |
معلومات عن الموقع الجغرافي والمكان الذي تم ترميز العنوان الجغرافي إليه. |
metadata |
معلومات أخرى ذات صلة بالتسليم. لا نضمن لك تعبئة |
uspsData |
علامات إضافية للتسليم مقدَّمة من USPS. يتوفّر هذا الخيار فقط في المنطقتَين |
englishLatinAddress |
المعاينة: تتوفّر هذه الميزة ضمن المعاينة (مرحلة ما قبل التوفّر للجمهور العام). قد تحظى منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام بدعم محدود، وقد لا تتوافق التغييرات التي يتم إجراؤها على منتجات وميزات مرحلة ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تخضع "عروض مرحلة ما قبل التوفّر للجمهور العام" للأحكام الخاصة بخدمة "منصة خرائط Google". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مرحلة الإطلاق. تمت ترجمة العنوان إلى اللغة الإنجليزية. إذا لم تتم ترجمة جزء من العنوان باللغة الإنجليزية، ستعرض الخدمة هذا الجزء بلغة بديلة تستخدم نصًا لاتينيًا. يمكنك الانتقال إلى هذه الصفحة للحصول على شرح عن كيفية اختيار اللغة البديلة. إذا لم تتوفر أي ترجمات أو عمليات تحويل صوتي لجزء من العنوان بلغة تستخدم نصًا لاتينيًا، ستعرض الخدمة هذا الجزء باللغة المحلية المرتبطة بالعنوان. لقد فعّلت هذه النتيجة باستخدام العلامة ملاحظة: لا تتم تعبئة الحقل |
النتيجة
نظرة عامة عالية المستوى على نتيجة التحقق من العنوان والرمز الجغرافي.
تمثيل JSON |
---|
{ "inputGranularity": enum ( |
الحقول | |
---|---|
inputGranularity |
دقة عنوان الإدخال. وينتج ذلك عن تحليل عنوان الإدخال ولا يعطي أيّ إشارات للتحقّق من الصحة. للاطّلاع على إشارات التحقق من الصحة، يُرجى الرجوع إلى على سبيل المثال، إذا كان العنوان الذي تم إدخاله يتضمّن رقم شقة معيّنًا، ستكون قيمة |
validationGranularity |
مستوى الدقة الذي يمكن لواجهة برمجة التطبيقات validate منه بشكل كامل في العنوان. على سبيل المثال، تشير السمة يمكن العثور على نتيجة التحقق من صحة مكوّن العنوان في |
geocodeGranularity |
تمثّل هذه السمة معلومات عن مستوى دقة يمكن أن يختلف هذا الخيار عن |
addressComplete |
يُعتبر العنوان كاملاً في حال عدم وجود رموز مميزة لم يتم حلها أو عدم وجود مكونات عنوان غير متوقعة أو مفقودة. يمكنك الاطّلاع على حقول |
hasUnconfirmedComponents |
لا يمكن تصنيف أو التحقّق من مكوّن عنوان واحد على الأقل. لمزيد من التفاصيل، يُرجى الاطّلاع على |
hasInferredComponents |
تم استنتاج (إضافة) مكوّن عنوان واحد على الأقل غير مُضمَّن في الإدخال، يُرجى الاطّلاع على |
hasReplacedComponents |
تم استبدال مكوِّن عنوان واحد على الأقل. يُرجى الاطّلاع على |
درجة الدقة
التفاصيل المختلفة التي يمكن أن يشتمل عليها العنوان أو الرمز الجغرافي. وعند استخدامها للإشارة إلى دقة العنوان، تشير هذه القيم إلى مدى دقة العنوان في تحديد الوجهة البريدية. على سبيل المثال، يحدّد عنوان مثل "123 Main Street, Redwood City, CA, 94061" PREMISE
بينما يحدِّد شيء مثل "Redwood City, CA, 94061" LOCALITY
. مع ذلك، إذا تعذر علينا العثور على رمز جغرافي لـ "123 الشارع الرئيسي" في مدينة ريدوود، فقد يكون الرمز الجغرافي المعروض بدقة LOCALITY
على الرغم من أن العنوان أكثر دقة.
عمليات التعداد | |
---|---|
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"، فقد تبدو الرموز المميزة التي لم يتم حلها على النحو |
AddressComponent
يمثل عنصر عنوان، مثل شارع أو مدينة أو ولاية.
تمثيل JSON |
---|
{ "componentName": { object ( |
الحقول | |
---|---|
componentName |
اسم هذا المكوِّن. |
componentType |
نوع عنصر العنوان. راجع الجدول 2: الأنواع الإضافية التي تعرضها خدمة الأماكن للحصول على قائمة بالأنواع المحتملة. |
confirmationLevel |
تشير إلى مستوى اليقين الذي لدينا من صحة المكون. |
inferred |
يشير إلى أن المكوِّن لم يكن جزءًا من الإدخال، ولكننا استنتجنا ذلك لموقع العنوان ونعتقد أنه يجب تقديمه لعنوان كامل. |
spellCorrected |
يشير إلى تصحيح لخطأ إملائي في اسم المكوِّن. ويُرجى العِلم أنّ واجهة برمجة التطبيقات لا تُبلغ دائمًا عن التغييرات من صيغة إملائية إلى أخرى، كما هو الحال عند تغيير كلمة "مركز" إلى "مركز". ولا يتم دائمًا وضع علامة على الأخطاء الإملائية الشائعة، مثل تغيير "Amphitheater Pkwy" إلى "Amphitheatre Pkwy". |
replaced |
تشير هذه السمة إلى استبدال اسم المكوِّن بآخر مختلف تمامًا، على سبيل المثال رمز بريدي خاطئ يتم استبداله برمز بريدي صحيح للعنوان. هذا ليس تغييرًا تجميليًا، فقد تم تغيير مكون الإدخال إلى مكوِّن مختلف. |
unexpected |
يشير إلى عنصر عنوان غير متوقع أن يكون موجودًا في عنوان بريدي للمنطقة المحددة. وقد احتفظنا بها فقط لأنّها كانت جزءًا من البيانات. |
ComponentName
برنامج تضمين لاسم المكون.
تمثيل JSON |
---|
{ "text": string, "languageCode": string } |
الحقول | |
---|---|
text |
نص الاسم. على سبيل المثال، "5 شارع" لاسم شارع أو "1253" لرقم شارع. |
languageCode |
تمثّل هذه السمة رمز اللغة BCP-47. لن يكون هذا موجودًا إذا كان اسم المكون غير مرتبط بلغة، مثل رقم الشارع. |
ConfirmationLevel
القيم المختلفة المحتملة لمستويات التأكيد.
عمليات التعداد | |
---|---|
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]. |
PlusCode
رمز Plus Codes (http://plus.codes) هو مرجع موقع جغرافي بتنسيقَين: رمز عام يحدّد 14mx14m (1/8000 درجة من الدرجة) أو مستطيلاً أصغر حجمًا، ورمز مركّب، يتم استبدال البادئة فيه بالموقع المرجعي.
تمثيل JSON |
---|
{ "globalCode": string, "compoundCode": string } |
الحقول | |
---|---|
globalCode |
رمز المكان العالمي (الكامل)، مثل "9FWM33GV+HQ"، الذي يمثّل مساحة 1/8000 درجة × 1/8000 درجة (حوالي 14 × 14 مترًا). |
compoundCode |
الرمز المركّب للمكان، مثل " 33GV+HQ, Ramburg, النرويج"، الذي يحتوي على لاحقة الرمز العام واستبدال البادئة باسم منسَّق لكيان مرجعي |
إطار العرض
إطار عرض لخط العرض وخط الطول، يتم تمثيله كاثنتين قطريًا مقابل نقطتين 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 } }
تمثيل JSON |
---|
{ "low": { object ( |
الحقول | |
---|---|
low |
مطلوبة. النقطة المنخفضة لإطار العرض. |
high |
مطلوبة. النقطة العليا في إطار العرض. |
AddressMetadata
البيانات الوصفية للعنوان. لا نضمن لك تعبئة metadata
بالكامل لكل عنوان يتم إرساله إلى واجهة برمجة التطبيقات للتحقّق من صحة العنوان.
تمثيل JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
الحقول | |
---|---|
business |
يشير إلى أن هذا هو عنوان النشاط التجاري. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة. |
poBox |
يشير إلى عنوان صندوق البريد. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة. |
residential |
يشير إلى أن هذا هو عنوان الإقامة. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة. |
UspsData
بيانات USPS للعنوان. لا نضمن لك تعبئة uspsData
بالكامل لكل عنوان في الولايات المتحدة أو علاقات عامة يتم إرساله إلى واجهة برمجة التطبيقات للتحقّق من صحة العنوان. يُوصى بدمج حقول العنوان الاحتياطي في الرد إذا كنت تستخدم uspsData كجزء أساسي من الاستجابة.
تمثيل JSON |
---|
{
"standardizedAddress": {
object ( |
الحقول | |
---|---|
standardizedAddress |
هو عنوان موحّد لـ USPS. |
deliveryPointCode |
رمز نقطة التسليم المكوّن من رقمَين |
deliveryPointCheckDigit |
رقم اختبار نقطة التسليم. تتم إضافة هذا الرقم إلى نهايةDeliver_point_barcode للبريد الإلكتروني الممسوح ضوئيًا آليًا. يجب أن ينتج عن جمع كل أرقام رمز التسليم_point_barcode وdeliveryPointCheckDigit والرمز البريدي وZIP+4 معًا رقمًا يمكن قسمته على 10. |
dpvConfirmation |
القيم المحتملة لتأكيد DPV. تعرض حرفًا واحدًا أو لا تعرض أي قيمة.
|
dpvFootnote |
الحواشي السفلية من التحقق من صحة نقطة التسليم. يمكن ربط عدة حواشي سفلية معًا في نفس السلسلة.
|
dpvCmra |
يشير إلى ما إذا كان العنوان وكالة استقبال البريد التجاري (CMRA)--نشاط تجاري خاص يتلقى رسائل للعملاء. تعرض حرفًا واحدًا.
|
dpvVacant |
هل هذا المكان شاغر؟ تعرض حرفًا واحدًا.
|
dpvNoStat |
هل هذا عنوان بدون إحصائيات أو عنوان نشط؟ لا توجد عناوين إحصائيات هي العناوين التي لا يتم شغلها باستمرار أو العناوين التي لا تقدم لها USPS. تعرض حرفًا واحدًا.
|
dpvNoStatReasonCode |
يشير إلى نوع NoStat. لعرض رمز السبب كعدد صحيح
|
dpvDrop |
تشير العلامة إلى تسليم البريد إلى شخص واحد مستلم على موقع إلكتروني. تعرض حرفًا واحدًا.
|
dpvThrowback |
يشير إلى عدم تسليم البريد إلى عنوان الشارع. تعرض حرفًا واحدًا.
|
dpvNonDeliveryDays |
تشير العلامة إلى أنّه لا يتم تسليم البريد في كل يوم من أيام الأسبوع. تعرض حرفًا واحدًا.
|
dpvNonDeliveryDaysValues |
عدد صحيح يحدِّد أيام عدم التسليم يمكن استجوابه باستخدام علامات بت: 0x40 – الأحد هو يوم عدم التسليم 0x20 – يوم الاثنين هو يوم عدم التسليم 0x10 – يوم الثلاثاء هو يوم عدم التسليم 0x10 – الثلاثاء هو يوم عدم التسليم 0x08 – الأربعاء هو يوم عدم التسليم 0x04 – يوم الخميس هو يوم عدم التسليم 0x02 – يوم الأحد هو يوم عدم التسليم 0x02 – يوم الجمعة هو يوم عدم التسليم 0x02 – يوم الثلاثاء هو يوم عدم التسليم 0x02 – يوم الثلاثاء هو يوم عدم التسليم 0x02 – يوم السبت هو يوم عدم التسليم 0x02 – يوم السبت هو يوم عدم التسليم 0x02 – يوم الجمعة |
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 |
يشير إلى أن الطلب قد تمت معالجته. |
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 |