Method: validateAddress

للتحقق من صحة أحد العناوين.

طلب HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

يستخدم عنوان URL بنية تحويل الترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
الحقول
address

object (PostalAddress)

مطلوبة. العنوان الذي يتم التحقق منه. يجب إرسال العناوين غير المنسقة عبر addressLines.

يجب ألا يتجاوز إجمالي طول الحقول في هذا الإدخال 280 حرفًا.

يمكن العثور على المناطق التي يتوفّر فيها التطبيق هنا.

إنّ القيمة languageCode في عنوان الإدخال محجوزة للاستخدامات المستقبلية ويتم تجاهلها اليوم. وستتم تعبئة نتيجة العنوان التي تم التحقُّق منها استنادًا إلى اللغة المفضَّلة للعنوان المحدَّد، وفقًا لما يحدّده النظام.

تتجاهل واجهة برمجة تطبيقات التحقّق من صحة العناوين القيم في recipients وorganization. وسيتم تجاهل أي قيم في هذه الحقول ولن يتم عرضها. ويُرجى عدم ضبطها.

previousResponseId

string

يجب أن يكون هذا الحقل فارغًا لطلب التحقق الأول من صحة العنوان. إذا كان من الضروري إجراء المزيد من الطلبات للتحقّق من صحة عنوان واحد بشكل كامل (على سبيل المثال، إذا كانت هناك حاجة إلى إعادة التحقُّق من التغييرات التي يجريها المستخدم بعد عملية التحقّق الأولية)، يجب أن تتم تعبئة هذا الحقل لكل طلب متابعة باستخدام responseId من أول استجابة في تسلسل التحقّق.

enableUspsCass

boolean

يتم تفعيل وضع التوافق مع USPS CASS. ويؤثر هذا فقط في الحقل 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 على أنّها "بورتوريكو" (غير حساسة لحالة الأحرف) أو "PR".

ننصحك باستخدام سمة address مكوّنة، أو بدلاً من ذلك تحديد google.type.PostalAddress.address_lines على الأقل حيث يحتوي السطر الأول على رقم الشارع واسمه، ويحتوي السطر الثاني على المدينة والولاية والرمز البريدي.

languageOptions

object (LanguageOptions)

اختياريّ. معاينة: تتوفّر هذه الميزة في إصدار المعاينة (ما قبل التوفّر للجمهور العام). قد يكون دعم المنتجات والميزات في مرحلة ما قبل التوفّر للجمهور العام محدودًا، وقد لا تتوافق التغييرات التي تطرأ على منتجات وميزات ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تغطي الأحكام الخاصة بخدمة "منصة خرائط Google" "عروض مرحلة ما قبل التوفّر للجمهور العام". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق.

تمكِّن واجهة برمجة تطبيقات التحقّق من صحة العنوان من تضمين معلومات إضافية في الرد.

sessionToken

string

اختياريّ. سلسلة تحدِّد جلسة إكمال تلقائي لأغراض الفوترة. يجب أن تكون السلسلة آمنة من سلسلة base64 لعنوان URL ولها 36 حرف ASCII كحد أقصى. وفي حال عدم تنفيذ ذلك، يتم عرض خطأ POINTS_Quick.

تبدأ الجلسة عندما يُجري المستخدم طلب بحث مكتملاً تلقائيًا، وتنتهي عند اختيار مكان وإجراء مكالمة إلى تفاصيل المكان أو التحقُّق من صحة العنوان. يمكن أن تحتوي كل جلسة على طلبات بحث إكمال تلقائي متعددة، متبوعة بطلب التحقق من صحة العنوان أو تفاصيل المكان. يجب أن تنتمي بيانات الاعتماد المستخدَمة لكل طلب خلال جلسة إلى المشروع نفسه على Google Cloud Console. بعد انتهاء الجلسة، لن يصبح الرمز المميز صالحًا، لذا يجب أن ينشئ تطبيقك رمزًا مميزًا جديدًا لكل جلسة. إذا تم حذف مَعلمة sessionToken، أو إذا أعدت استخدام رمز مميّز للجلسة، يتم تحصيل الرسوم من الجلسة كما لو لم يتم تقديم رمز مميّز للجلسة (تتم فوترة كل طلب على حدة).

ملاحظة: لا يمكن استخدام ميزة "التحقّق من العناوين" إلا في الجلسات التي تتضمّن واجهة برمجة تطبيقات للإكمال التلقائي (جديدة)، وليس واجهة برمجة تطبيقات الإكمال التلقائي. لمزيد من التفاصيل، يمكنك الاطّلاع على https://developers.google.com/maps/documentation/places/web-service/session-pricing.

نص الاستجابة

الاستجابة لطلب التحقق من العنوان.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
الحقول
result

object (ValidationResult)

نتيجة عملية التحقق من العنوان.

responseId

string

المعرِّف الفريد العالمي (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

integer

تمثّل هذه السمة النسخة السابقة من المخطط من PostalAddress. إذا كانت القيمة غير 0، ستعرض واجهة برمجة التطبيقات خطأ INVALID_ARGUMENT.

regionCode

string

اختياريّ. رمز CLDR للمنطقة لبلد/منطقة العنوان لمعرفة التفاصيل، يمكنك الاطّلاع على https://cldr.unicode.org/ وhttps://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. مثال: "CH" لسويسرا إذا لم يتم تقديم رمز المنطقة، سيتم استنتاجه من العنوان. لتحقيق أفضل أداء، يُنصح بتضمين رمز المنطقة إذا كنت تعرفه. قد يؤدي استخدام مناطق متكرّرة أو غير متّسقة إلى ضعف الأداء. على سبيل المثال، إذا كانت السمة addressLines تتضمّن المنطقة، لا تقدِّم رمز المنطقة مجددًا في هذا الحقل. يمكنك الاطّلاع على المناطق التي تتوفّر فيها هذه الميزة في صفحة الأسئلة الشائعة.

languageCode

string

رمز اللغة في عنوان الإدخال محجوز للاستخدامات المستقبلية ويتم تجاهله اليوم. تعرض واجهة برمجة التطبيقات العنوان باللغة المناسبة لمكان العنوان.

postalCode

string

اختياريّ. الرمز البريدي للعنوان إنّ بعض البلدان لا تستخدم الرموز البريدية أو تشترط توفّر هذه الرموز، ولكن في أماكن استخدامها، قد تؤدي إلى إجراء عمليات تحقّق إضافية في أجزاء أخرى من العنوان (على سبيل المثال، التحقق من الولاية أو الرمز البريدي في الولايات المتحدة الأمريكية).

sortingCode

string

اختياريّ. رمز ترتيب إضافي خاص بالبلد ولا يتم استخدام هذه الميزة في معظم المناطق. في حال استخدام هذه القيمة، تكون إما سلسلة مثل "CEDEX" متبوعة برقم اختياري (مثل "CEDEX 7") أو رقم بمفرده يمثل "رمز القطاع" (جامايكا) أو "مؤشر منطقة التسليم" (مالاوي) أو "مؤشر مكتب البريد" (على سبيل المثال، كوت ديفوار).

administrativeArea

string

اختياريّ. أعلى تقسيم فرعي إداري يُستخدم للعناوين البريدية لبلد أو منطقة. على سبيل المثال، يمكن أن تكون ولاية أو مقاطعة أو مقاطعة أو محافظة. وعلى وجه التحديد، بالنسبة إلى إسبانيا، هذه هي الإقليم وليس المجتمع المستقل (مثل "برشلونة" وليس "كاتالونيا"). لا يستخدم العديد من البلدان منطقة إدارية في العناوين البريدية. على سبيل المثال، في سويسرا، يجب ترك هذا الحقل فارغًا.

locality

string

اختياريّ. يشير بوجه عام إلى جزء المدينة/البلدة من العنوان. أمثلة: مدينة في الولايات المتحدة، اتحاد تكنولوجيا المعلومات، مدينة بريد المملكة المتحدة. في المناطق من العالم التي لم يتم تعريفها بشكل جيد أو لا تتناسب مع هذا الهيكل بشكل جيد، اترك المنطقة المحلية فارغة واستخدِم addressLines.

sublocality

string

اختياريّ. المنطقة المحلية الفرعية للعنوان على سبيل المثال، يمكن أن يشمل ذلك الأحياء أو المناطق الإدارية أو الأحياء.

addressLines[]

string

مطلوبة. أسطر عنوان غير مهيكلة تصف المستويات الأدنى من العنوان.

بما أنّ القيم في addressLines لا تتضمّن معلومات عن النوع وقد تحتوي أحيانًا على قيم متعدّدة في حقل واحد (مثلاً "أوستن، تكساس")، من المهم أن يكون ترتيب الأسطر واضحًا. يجب أن يكون ترتيب أسطر العنوان "ترتيب المغلف" للبلد/المنطقة حيث يقع العنوان.

يتألف الحد الأدنى المسموح به من التمثيل الهيكلي للعنوان من جميع المعلومات الموضوعة في addressLines. في حال عدم تقديم regionCode، يتم استنتاج المنطقة من سطور العنوان.

إنشاء عنوان يحتوي على addressLines فقط، ومن ثم يكون الترميز الجغرافي هو الطريقة المُوصى بها للتعامل مع العناوين غير المنظَّمة تمامًا (بدلاً من تخمين أجزاء العنوان التي يجب أن تكون مناطق محلية أو إدارية).

recipients[]

string

يُرجى تجنب ضبط هذا الحقل. لا تستخدمها واجهة برمجة تطبيقات التحقّق من صحة العناوين حاليًا. وعلى الرغم من أنّ واجهة برمجة التطبيقات لن ترفض الطلبات التي تتضمّن مجموعة الحقول هذه في الوقت الحالي، سيتم تجاهل المعلومات ولن يتم عرضها في الردّ.

organization

string

يُرجى تجنب ضبط هذا الحقل. لا تستخدمها واجهة برمجة تطبيقات التحقّق من صحة العناوين حاليًا. وعلى الرغم من أنّ واجهة برمجة التطبيقات لن ترفض الطلبات التي تتضمّن مجموعة الحقول هذه في الوقت الحالي، سيتم تجاهل المعلومات ولن يتم عرضها في الردّ.

LanguageOptions

معاينة: تتوفّر هذه الميزة في إصدار المعاينة (ما قبل التوفّر للجمهور العام). قد يكون دعم المنتجات والميزات في مرحلة ما قبل التوفّر للجمهور العام محدودًا، وقد لا تتوافق التغييرات التي تطرأ على منتجات وميزات ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تغطي الأحكام الخاصة بخدمة "منصة خرائط Google" "عروض مرحلة ما قبل التوفّر للجمهور العام". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق.

تمكِّن واجهة برمجة تطبيقات التحقّق من صحة العنوان من تضمين معلومات إضافية في الرد.

تمثيل JSON
{
  "returnEnglishLatinAddress": boolean
}
الحقول
returnEnglishLatinAddress

boolean

معاينة: عرض google.maps.addressvalidation.v1.Address باللغة الإنجليزية لمزيد من التفاصيل، انتقِل إلى google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

ValidationResult

نتيجة التحقّق من صحة العنوان.

تمثيل JSON
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
الحقول
verdict

object (Verdict)

إجمالي علامات البيان

address

object (Address)

معلومات حول العنوان نفسه بدلاً من الرمز الجغرافي.

geocode

object (Geocode)

معلومات حول الموقع الجغرافي والمكان الذي تمّ ترميز العنوان الجغرافي إليه.

metadata

object (AddressMetadata)

معلومات أخرى ذات صلة بالتسليم. لا يمكن ضمان تعبئة metadata بالكامل لكل عنوان يتم إرساله إلى واجهة برمجة تطبيقات التحقّق من صحة العناوين.

uspsData

object (UspsData)

علامات تسليم إضافية تقدّمها شركة USPS. تم توفير هذه السمة في المنطقتَين US وPR فقط.

englishLatinAddress

object (Address)

معاينة: تتوفّر هذه الميزة في إصدار المعاينة (ما قبل التوفّر للجمهور العام). قد يكون دعم المنتجات والميزات في مرحلة ما قبل التوفّر للجمهور العام محدودًا، وقد لا تتوافق التغييرات التي تطرأ على منتجات وميزات ما قبل التوفّر للجمهور العام مع الإصدارات الأخرى المتاحة للجمهور العام. تغطي الأحكام الخاصة بخدمة "منصة خرائط Google" "عروض مرحلة ما قبل التوفّر للجمهور العام". لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مراحل الإطلاق.

تمت ترجمة العنوان إلى اللغة الإنجليزية.

لا يمكن إعادة استخدام العناوين المترجَمة كإدخال من واجهة برمجة التطبيقات. وتوفّر الخدمة للمستخدمِين هذه الخدمة ليتمكّنوا من استخدام لغتهم الأم لتأكيد أو رفض التحقّق من صحة العنوان الذي تم تقديمه في الأصل.

إذا لم تتوفر ترجمة باللغة الإنجليزية لجزء من العنوان، تعرض الخدمة هذا الجزء بلغة بديلة تستخدم نصًا لاتينيًا. يمكنك النقر هنا للحصول على شرح عن كيفية اختيار اللغة البديلة. إذا لم يكن لجزء من العنوان أي ترجمات أو عمليات تحويل صوتي بلغة تستخدم نصًا لاتينيًا، تعرض الخدمة هذا الجزء باللغة المحلية المرتبطة بالعنوان.

ويمكنك تفعيل هذه النتيجة باستخدام العلامة google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

ملاحظة: لا تتم تعبئة الحقل google.maps.addressvalidation.v1.Address.unconfirmed_component_types في الحقل englishLatinAddress والحقل google.maps.addressvalidation.v1.AddressComponent.confirmation_level في englishLatinAddress.address_components.

النتيجة

نظرة عامة شاملة على نتيجة التحقق من العنوان والرمز الجغرافي.

تمثيل JSON
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
الحقول
inputGranularity

enum (Granularity)

دقة عنوان الإدخال. ويأتي هذا نتيجة تحليل عنوان الإدخال ولا يعطي أي إشارات للتحقّق من الصحة. للاطّلاع على إشارات التحقّق من الصحة، يمكنك الرجوع إلى validationGranularity أدناه.

على سبيل المثال، إذا كان عنوان الإدخال يتضمّن رقم شقة معيّنًا، ستكون قيمة inputGranularity هنا SUB_PREMISE. إذا لم نتمكّن من مطابقة رقم الشقة في قواعد البيانات أو كان رقم الشقة غير صالح، من المرجّح أن يكون رقم validationGranularity PREMISE أو أقلّ.

validationGranularity

enum (Granularity)

مستوى الدقة الذي يمكن لواجهة برمجة التطبيقات validate من العنوان له بالكامل. على سبيل المثال، تشير قيمة validationGranularity للسمة PREMISE إلى أنه يمكن التحقق من كل مكوّنات العنوان عند المستوى PREMISE أو أقل.

يمكن العثور على نتيجة التحقق من المكوِّن حسب العنوان في google.maps.addressvalidation.v1.Address.address_components.

geocodeGranularity

enum (Granularity)

تمثّل هذه السمة معلومات عن مستوى دقة geocode. ويمكن فهم ذلك على أنّه المعنى الدلالي لمدى دقّة الموقع الجغرافي المرمّز جغرافيًا.

يمكن أن يختلف هذا في بعض الأحيان عن validationGranularity أعلاه. على سبيل المثال، قد تسجل قاعدة البيانات لدينا وجود رقم الشقة ولكن ليس لها موقع دقيق للشقة داخل مجمع سكني كبير. في هذه الحالة، سيكون validationGranularity SUB_PREMISE في حين سيكون geocodeGranularity PREMISE.

addressComplete

boolean

يُعد العنوان مكتملاً في حال عدم وجود رموز مميزة لم يتم حلها، أو عدم وجود مكونات عنوان غير متوقعة أو مفقودة. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة هي false. يمكنك الاطّلاع على الحقول missingComponentTypes أو unresolvedTokens أو unexpected للحصول على مزيد من التفاصيل.

hasUnconfirmedComponents

boolean

لا يمكن تصنيف مكوّن عنوان واحد على الأقل أو التحقّق من صحته. لمزيد من التفاصيل، يُرجى مراجعة google.maps.addressvalidation.v1.Address.address_components.

hasInferredComponents

boolean

تم استنتاج (تمت إضافة) مكوّن عنوان واحد على الأقل غير مضمّن في الإدخال. يُرجى الاطّلاع على google.maps.addressvalidation.v1.Address.address_components لمعرفة التفاصيل.

hasReplacedComponents

boolean

تم استبدال مكوّن عنوان واحد على الأقل. يُرجى الاطّلاع على google.maps.addressvalidation.v1.Address.address_components للحصول على التفاصيل.

درجة الدقة

يشير ذلك المصطلح إلى درجات الدقة المختلفة التي يمكن أن يتضمّنها العنوان أو الرمز الجغرافي. وعند استخدامها للإشارة إلى مستوى دقة عنوان، تشير هذه القيم إلى مدى دقة العنوان في تحديد الوجهة البريدية. على سبيل المثال، يحدِّد عنوان مثل "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 (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
الحقول
formattedAddress

string

العنوان بعد المعالجة، والمنسق كعنوان مكوَّن من سطر واحد وفقًا لقواعد تنسيق العنوان للمنطقة التي يقع فيها العنوان.

postalAddress

object (PostalAddress)

العنوان الذي تمّت معالجته لاحقًا كعنوان بريدي.

addressComponents[]

object (AddressComponent)

قائمة بدون ترتيب. مكونات العنوان الفردي للعنوان المنسَّق والصحيح، بالإضافة إلى معلومات التحقّق من الصحة. يوفر هذا معلومات عن حالة التحقق من صحة المكونات الفردية.

لا يتم ترتيب مكونات العنوان بطريقة معينة. عدم وضع أي افتراضات بشأن ترتيب مكونات العنوان في القائمة

missingComponentTypes[]

string

تعذّر العثور على أنواع المكوّنات التي كان من المتوقّع وجودها في عنوان بريدي تم تنسيقه بشكل صحيح، ولكن لم يتم العثور عليها في البيانات المعروضة وتعذّر استنتاجها. لا تتوفر مكونات من هذا النوع في formattedAddress أو postalAddress أو addressComponents. مثال: ['street_number', 'route'] لإدخال مثل "بولدر، كولورادو، 80301، الولايات المتحدة الأمريكية". يمكنك العثور هنا على قائمة بالأنواع المحتملة.

unconfirmedComponentTypes[]

string

تمثّل هذه السمة أنواع المكوّنات المتوفّرة في addressComponents ولكن تعذّر التأكّد من صحتها. يتم توفير هذا الحقل للتيسير عليك، فمحتواه يعادل التكرار خلال addressComponents للعثور على أنواع جميع المكوّنات التي لا تكون فيها السمة confirmationLevel CONFIRMED أو التي لم يتم ضبط العلامة inferred على true. يمكنك العثور هنا على قائمة بالأنواع المحتملة.

unresolvedTokens[]

string

أي رموز مميزة في الإدخال لا يمكن حلها. قد يكون هذا إدخالاً لم يتم التعرف عليه على أنه جزء صالح من العنوان (على سبيل المثال، في إدخال مثل "123235253253 Main St, San Francisco, CA, 94105"، فقد تبدو الرموز المميزة التي لم يتم حلها مثل ["123235253253"] لأنه لا يبدو كرقم شارع صالح.

AddressComponent

يمثل عنصر عنوان، مثل شارع أو مدينة أو ولاية.

تمثيل JSON
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
الحقول
componentName

object (ComponentName)

اسم هذا المكون.

componentType

string

تمثّل هذه السمة نوع مكوِّن العنوان. راجع الجدول 2: الأنواع الإضافية التي تعرضها خدمة "الأماكن" للحصول على قائمة بالأنواع المحتملة.

confirmationLevel

enum (ConfirmationLevel)

يشير إلى مستوى اليقين الذي لدينا من أن المكون.

inferred

boolean

تشير هذه السمة إلى أنّ المكوّن لم يكن جزءًا من الإدخال، ولكننا استنتجنا ذلك من موقع العنوان ونعتقد أنّه يجب توفيره للعنوان الكامل.

spellCorrected

boolean

تشير إلى تصحيح لخطأ إملائي في اسم المكون. لا تُبلِغ واجهة برمجة التطبيقات دائمًا عن التغييرات من صيغة إملائية إلى أخرى، كما هو الحال عند تغيير "مركز" إلى "مركز". ولا يُظهر أيضًا الأخطاء الإملائية الشائعة، مثل تغيير "Amphitheater Pkwy" إلى "Amphitheatre Pkwy".

replaced

boolean

تشير هذه السمة إلى استبدال اسم المكوّن بآخر مختلف تمامًا، على سبيل المثال، يتم استبدال رمز بريدي خاطئ برمز بريدي صحيح للعنوان. هذا ليس تغييرًا تجميليًا، فقد تم تغيير مكون الإدخال إلى مكوِّن مختلف.

unexpected

boolean

يشير إلى مكوّن عنوان غير متوقع أن يكون متوفرًا في عنوان بريدي للمنطقة المحددة. وقد تم الاحتفاظ بها لأنها كانت جزءًا من البيانات التي أدخلناها.

ComponentName

برنامج تضمين لاسم المكون.

تمثيل JSON
{
  "text": string,
  "languageCode": string
}
الحقول
text

string

نص الاسم. على سبيل المثال، "الجادة الخامسة" لاسم شارع أو "1253" لرقم شارع.

languageCode

string

تمثّل هذه السمة رمز اللغة BCP-47. لن يكون هذا موجودًا إذا كان اسم المكون غير مرتبط بلغة، مثل رقم الشارع.

ConfirmationLevel

القيم المختلفة المحتملة لمستويات التأكيد.

عمليات التعداد
CONFIRMATION_LEVEL_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
CONFIRMED تمكنا من التحقق من أن هذا المكون موجود منطقية في سياق بقية العنوان.
UNCONFIRMED_BUT_PLAUSIBLE تعذّر تأكيد هذا العنصر، لكن من المنطقي أنّه موجود. على سبيل المثال، رقم شارع يقع ضمن نطاق أرقام صالح معروف في شارع لا تكون فيه أرقام المنازل المحدّدة معروفة.
UNCONFIRMED_AND_SUSPICIOUS لم يتم تأكيد هذا المكوّن ومن المحتمل أن يكون غير صحيح. على سبيل المثال، حي لا يتناسب مع بقية العنوان.

الترميز الجغرافي

يحتوي على معلومات حول المكان الذي تم ترميز الإدخال جغرافيًا إليه.

تمثيل JSON
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
الحقول
location

object (LatLng)

الموقع الجغرافي للإدخال المرمَّز جغرافيًا.

يُفضَّل استخدام أرقام تعريف الأماكن على استخدام العناوين أو إحداثيات خطوط الطول والعرض أو رموز الجمع. سوف يؤدي استخدام الإحداثيات عند تحديد مسار القيادة أو حساب اتجاهات القيادة دائمًا إلى انطباق النقطة إلى الطريق الأقرب إلى تلك الإحداثيات. قد لا يكون هذا طريقًا يؤدي بشكل سريع أو آمن إلى الوجهة وقد لا يكون قريبًا من إحدى نقاط الوصول إلى العقار. بالإضافة إلى ذلك، عندما يتم ترميز الموقع الجغرافي بشكل عكسي، ليس هناك ما يضمن تطابق العنوان الذي تم إرجاعه مع العنوان الأصلي.

plusCode

object (PlusCode)

تمثّل هذه السمة رمز Plus Codes المتوافق مع location.

bounds

object (Viewport)

حدود المكان المرمّز جغرافيًا.

featureSizeMeters

number

حجم المكان المرمّز جغرافيًا بالمتر وهذا مقياس آخر لدرجة شدة الموقع الجغرافي المرمَّز جغرافيًا، ولكن في الحجم الفعلي وليس المعنى الدلالي.

placeId

string

رقم تعريف المكان للمكان الذي يتم الترميز الجغرافي لهذا الإدخال إليه.

يمكنك الاطّلاع هنا على مزيد من المعلومات عن أرقام تعريف الأماكن.

placeTypes[]

string

نوع(أنواع) المكان الذي تم ترميز الإدخال جغرافيًا إليه. مثلاً: ['locality', 'political'] يمكن الاطّلاع على القائمة الكاملة للأنواع هنا.

LatLng

يشير ذلك المصطلح إلى كائن يمثّل زوجًا من خط العرض/خط الطول. يتم التعبير عن ذلك كزوج من الزوجين لتمثيل خطوط الطول والعرض بالدرجات. يجب أن يتوافق هذا العنصر مع معيار WGS84 ما لم يرد خلاف ذلك. يجب أن تكون القيم ضمن النطاقات التي تمت تسويتها.

تمثيل JSON
{
  "latitude": number,
  "longitude": number
}
الحقول
latitude

number

تمثّل هذه السمة خط العرض بالدرجات. يجب أن يكون ضمن النطاق [-90.0، +90.0].

longitude

number

خط الطول بالدرجات. يجب أن يكون ضمن النطاق [-180.0، +180.0].

PlusCode

رمز Plus Codes (http://plus.codes) هو مرجع موقع بتنسيقين: رمز عام يحدد 14MX14m (1/8000 من الدرجة) أو مستطيلاً أصغر حجمًا، ورمزًا مركّبًا، حيث يتم استبدال البادئة بالموقع المرجعي.

تمثيل JSON
{
  "globalCode": string,
  "compoundCode": string
}
الحقول
globalCode

string

الرمز العالمي للمكان (الكامل)، مثل "9FWM33GV+HQ"، الذي يمثّل مساحة 1/8000 x 1/8000 درجة (حوالي 14 × 14 متر)

compoundCode

string

الرمز المركَّب للمكان، مثل "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 } }

تمثيل JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
الحقول
low

object (LatLng)

مطلوبة. النقطة المنخفضة لإطار العرض.

high

object (LatLng)

مطلوبة. النقطة المرتفعة لإطار العرض.

AddressMetadata

البيانات الوصفية للعنوان. لا يمكن ضمان تعبئة metadata بالكامل لكل عنوان يتم إرساله إلى واجهة برمجة تطبيقات التحقّق من صحة العناوين.

تمثيل JSON
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
الحقول
business

boolean

يشير إلى أن هذا هو عنوان نشاط تجاري. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة.

poBox

boolean

تشير هذه السمة إلى عنوان صندوق البريد. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة.

residential

boolean

يشير هذا الرمز إلى أنّ هذا العنوان هو عنوان مسكن. في حال ترك هذه السياسة بدون ضبط، يعني ذلك أنّ القيمة غير معروفة.

UspsData

بيانات USPS للعنوان لا يمكن ضمان تعبئة uspsData بالكامل لكل عنوان في الولايات المتحدة أو علاقات عامة يتم إرساله إلى واجهة برمجة تطبيقات التحقّق من صحة العناوين. يُنصَح بدمج حقول العنوان الاحتياطي في الردّ في حال استخدام uspsData كجزء أساسي من الاستجابة.

تمثيل JSON
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
الحقول
standardizedAddress

object (UspsAddress)

عنوان موحّد لـ USPS.

deliveryPointCode

string

رمز نقطة التسليم المكوّن من رقمَين

deliveryPointCheckDigit

string

رقم اختبار نقطة التسليم. تتم إضافة هذا الرقم إلى نهايةdelivery_point_barcode للبريد الذي يتم مسحه ضوئيًا آليًا. يجب أن تؤدي إضافة كل أرقام العنوانdelivery_point_barcode وdeliveryPointCheckDigit والرمز البريدي والرمز ZIP+4 معًا إلى رقم قابل للقسمة على 10.

dpvConfirmation

string

القيم المحتملة لتأكيد DPV. تعرِض حرفًا واحدًا أو لا تعرِض أي قيمة.

  • N: تعذّر تأكيد DPV من خلال معلومات الأرقام الأساسية وأي أرقام ثانوية.
  • D: تم تأكيد DPV للرقم الأساسي فقط ولم يتم إدخال معلومات الرقم الثانوي.
  • S: تم تأكيد DPV للرقم الأساسي فقط، وكانت معلومات الرقم الثانوية موجودة ولكن لم يتم تأكيدها.
  • Y: تم تأكيد عنوان DPV للأرقام الأساسية وأي أرقام ثانوية.
  • فارغ: إذا لم تتضمّن الاستجابة أي قيمة dpvConfirmation، لم يتم إرسال العنوان لتأكيد DPV.
dpvFootnote

string

الحواشي السفلية من التحقق من صحة نقطة التسليم. يمكن دمج الحواشي السفلية المتعددة معًا في السلسلة نفسها.

  • AA: عنوان الإدخال مطابق لملف ZIP+4
  • A1: لم تتم مطابقة عنوان الإدخال مع ملف ZIP+4
  • BB: تتم المطابقة مع DPV (جميع المكوّنات)
  • CC: الرقم الثانوي غير متطابق وغير مطلوب
  • C1: الرقم الثانوي غير متطابق ولكنه مطلوب
  • N1: العنوان الشاهق ينقصه رقم ثانوي
  • M1: الرقم الأساسي مفقود
  • M3: الرقم الأساسي غير صالح
  • P1: عدم توفّر رقم صندوق طلب الشراء أو رقم RR أو HC لعنوان الإدخال
  • P3: رقم صندوق البريد لعنوان الإدخال أو رقم RR أو HC غير صالح
  • F1: عنوان إدخال مطابق لعنوان عسكري
  • G1: عنوان إدخال مطابق لعنوان تسليم عام
  • U1: عنوان إدخال مطابق لرمز بريدي فريد.
  • PB: عنوان إدخال مطابق لسجلّ PBSA
  • RR: عنوان DPV الذي تم تأكيده مع معلومات PMB
  • R1: عنوان DPV الذي تم تأكيده بدون معلومات PMB
  • R7: سجل مسار شركة النقل R777 أو R779
  • IA: تم تحديد العنوان المبلَّغ عنه
  • TA: الرقم الأساسي الذي تتم مطابقته من خلال إسقاط ألفا لاحقة
dpvCmra

string

يشير إلى ما إذا كان العنوان وكالة CMRA (وكالة استلام البريد التجاري)، وهي مؤسسة خاصة تتلقى البريد للعملاء. تعرِض حرفًا واحدًا.

  • Y: العنوان هو مؤسسة CMRA
  • N: العنوان ليس هيئة CMRA
dpvVacant

string

هل هذا المكان شاغر؟ تعرِض حرفًا واحدًا.

  • Y: العنوان شاغر
  • N: العنوان غير شاغر
dpvNoStat

string

هل هذا العنوان بلا إحصاءات أو عنوان نشط؟ لا توجد عناوين إحصائيات هي العناوين التي لا يتم شغلها بشكل مستمر أو العناوين التي لا تقدم وكالة USPS خدماتها. تعرِض حرفًا واحدًا.

  • Y: العنوان غير نشط
  • N: العنوان نشط
dpvNoStatReasonCode

integer

يشير إلى النوع NoStat. تعرض رمز السبب على أنّه عدد صحيح.

  • 1: IDA (عنوان التسليم الداخلي): هي العناوين التي لا تتلقّى الرسائل الإلكترونية مباشرةً من USPS، ولكن يتم تسليمها إلى عنوان بريد إلكتروني يقدّم خدماتها.
  • 2: CDS: العناوين التي لم يتم تسليمها بعد على سبيل المثال، قسم فرعي جديد حيث تم تحديد الكثير والأرقام الأساسية، ولكن لا يوجد هيكل حتى الآن للإشغال.
  • 3: تصادم: العناوين التي لا تؤكّد DPV فعلاً
  • 4: CMZ (الكليات والعسكرية والأنواع الأخرى) - ZIP + 4 سجلات تم دمجها بالولايات المتحدة (USPS) في البيانات.
  • 5: عادي: يشير إلى العناوين التي لا تتلقّى خدمة التسليم، ولا يتم احتساب العناوين كعمليات تسليم ممكنة.
  • 6: مطلوب ثانوي - يتطلب العنوان معلومات ثانوية.
dpvDrop

string

تشير العلامة إلى تسليم البريد إلى شخص المستلم واحد على أحد المواقع. تعرِض حرفًا واحدًا.

  • Y: يتم تسليم البريد إلى جهة استلام واحدة على أحد المواقع الإلكترونية.
  • N: لا يتم تسليم البريد إلى أحد الأشخاص إمكانية استلامه على أحد المواقع الإلكترونية.
dpvThrowback

string

يشير إلى عدم تسليم البريد إلى عنوان الشارع. تعرِض حرفًا واحدًا.

  • Y: لا يتم تسليم الرسالة إلى عنوان الشارع.
  • N: يتم تسليم البريد إلى عنوان الشارع.
dpvNonDeliveryDays

string

تشير العلامة إلى أنّه لا يتم تسليم البريد في كل يوم من أيام الأسبوع. تعرِض حرفًا واحدًا.

  • Y: لا يتم تسليم البريد كل يوم من أيام الأسبوع.
  • N: ما مِن مؤشر على أنّه لا يتم تسليم البريد كل يوم من أيام الأسبوع.
dpvNonDeliveryDaysValues

integer

عدد صحيح لتحديد أيام عدم التسليم يمكن التحقيق في ذلك باستخدام علامات بت: 0x40 - الأحد هو يوم عدم التسليم 0x20 - يوم الاثنين هو يوم عدم التسليم 0x10 - يوم الثلاثاء هو يوم عدم التسليم 0x08 - يوم الثلاثاء هو يوم عدم التسليم 0x08 - ويوم الأربعاء هو يوم عدم التسليم 0x04 - يوم الخميس هو يوم عدم التسليم 0x02 أو يوم الجمعة هو يوم عدم التسليم 0x02 أو يوم الجمعة هو يوم عدم التسليم 0x02 - يوم الجمعة هو يوم عدم التسليم 0x02 أو يوم الجمعة هو يوم عدم التسليم 0x02

dpvNoSecureLocation

string

تشير العلامة إلى أنّه يمكن الوصول إلى الباب، ولكن لن يتم ترك الطرد لأسباب تتعلّق بالأمان. تعرِض حرفًا واحدًا.

  • Y: لن يتم ترك الطرد لأسباب تتعلق بالأمان.
  • N: ما مِن إشارة إلى عدم ترك الطرد بسبب مخاوف تتعلّق بالأمان.
dpvPbsa

string

يشير إلى مطابقة العنوان مع سجلّ PBSA. تعرِض حرفًا واحدًا.

  • Y: تمت مطابقة العنوان مع سجلّ PBSA.
  • N: لم يتطابق العنوان مع سجلّ PBSA.
dpvDoorNotAccessible

string

تشير العلامة إلى العناوين التي لا يمكن لـ USPS طرقها على الباب لتسليم البريد. تعرِض حرفًا واحدًا.

  • Y: الباب لا يمكن الوصول إليه.
  • N: ما مِن إشارة إلى أنّه لا يمكن الوصول إلى الباب.
dpvEnhancedDeliveryCode

string

تشير هذه القيمة إلى أنّ أكثر من رمز إرجاع DPV واحد صالح للعنوان. تعرِض حرفًا واحدًا.

  • Y: تم تأكيد عنوان DPV للأرقام الأساسية وأي أرقام ثانوية.
  • N: تعذّر تأكيد DPV من خلال معلومات الأرقام الأساسية وأي أرقام ثانوية.
  • S: تم تأكيد DPV للرقم الأساسي فقط، وكانت معلومات الرقم الثانوي غير مؤكدة، أو تم إسقاط رسالة ألفا لاحقة واحدة على رقم أساسي لإجراء مطابقة DPV وطلب معلومات ثانوية.
  • D: تم تأكيد DPV للرقم الأساسي فقط ولم يتم إدخال معلومات الرقم الثانوي.
  • R: تم تأكيد العنوان ولكن تم تعيينه للمسار الوهمي R777 وR779، ولم يتم تقديم التسليم إلى USPS.
carrierRoute

string

رمز مسار مشغّل شبكة الجوّال. رمز مكون من أربعة أحرف يتكون من بادئة حرف واحد ومصمم مسار مكون من ثلاثة أرقام.

البادئات:

  • C: مسار شركة النقل (أو مسار المدينة)
  • R: طريق ريفي
  • H: مسار التعاقد على الطرق السريعة
  • B: قسم صندوق البريد
  • G: وحدة التسليم العامة
carrierRouteIndicator

string

مؤشر فرز معدل مسار مشغّل شبكة الجوّال

ewsNoMatch

boolean

عنوان التسليم مطابق، لكن ملف EWS يشير إلى أن المطابقة التامة ستتوفر قريبًا.

postOfficeCity

string

المدينة الرئيسية لمكتب البريد.

postOfficeState

string

ولاية مكتب البريد الرئيسي.

abbreviatedCity

string

المدينة المختصرة.

fipsCountyCode

string

رمز FIPS للمقاطعة.

county

string

اسم المقاطعة.

elotNumber

string

رقم خط السفر المحسّن (eLOT).

elotFlag

string

علامة eLOT تصاعدية/تنازلية (A/D).

poBoxOnlyPostalCode

boolean

الرمز البريدي لصندوق البريد فقط

pmbDesignator

string

مصمّم وحدة صندوق البريد الخاص (PMB).

pmbNumber

string

رقم صندوق البريد الخاص (PMB)

addressRecordType

string

نوع سجلّ العنوان الذي يتطابق مع عنوان الإدخال

  • F: شركة FIRM يتطابق هذا مع السجل الثابت، وهو أفضل مستوى من المطابقة المتاح للعنوان.
  • G: التسليم العام يتطابق هذا مع سجلّ تسليم عام.
  • H: مبنى / شقة يتطابق هذا مع سجلّ مبنى أو شقة.
  • P: مربّع مكتب البريد هذا مطابق لصندوق بريد.
  • R: مسار ريفي أو عقد طريق سريع: يتطابق هذا الخيار مع سجل مسار ريفي أو عقد طريق سريع، وقد يحتوي كلاهما على نطاقات أرقام صندوقية مرتبطة.
  • S: سجلّ الشارع: يتطابق هذا مع سجلّ شارع يحتوي على نطاق أرقام أساسي صالح.
defaultAddress

boolean

يشير إلى العثور على عنوان تلقائي، ولكن هناك عناوين أكثر تحديدًا.

errorMessage

string

رسالة خطأ لاسترداد بيانات USPS. تتم تعبئة هذه المعلومات عندما يتم تعليق معالجة USPS بسبب رصد عناوين تم إنشاؤها بشكل مصطنع.

قد لا تتم تعبئة حقول بيانات USPS عند ظهور هذا الخطأ.

cassProcessed

boolean

مؤشر على أنه تمت معالجة الطلب باستخدام CASS

UspsAddress

تمثيل USPS لعنوان في الولايات المتحدة.

تمثيل JSON
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
الحقول
firstAddressLine

string

سطر العنوان الأول.

firm

string

اسم الشركة.

secondAddressLine

string

سطر العنوان الثاني.

urbanization

string

اسم التحضر في بورتوريكو.

cityStateZipAddressLine

string

المدينة والولاية والرمز البريدي

city

string

اسم المدينة

state

string

رمز الولاية المكوّن من حرفين.

zipCode

string

الرمز البريدي، مثل 10009.

zipCodeExtension

string

إضافة الرمز البريدي المكوّنة من 4 أرقام، مثلاً 5023