Package google.maps.addressvalidation.v1

الفهرس

AddressValidation

خدمة التحقّق من صحة العناوين

ProvideValidationFeedback

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

ملاحظات حول نتيجة سلسلة محاولات التحقق من الصحة. يجب أن يكون هذا الإجراء هو آخر طلب يتم إجراؤه بعد سلسلة من طلبات التحقّق للعنوان نفسه، ويجب طلبه بعد إتمام المعاملة. يجب إرسال هذه المعلومات مرة واحدة فقط لتسلسل طلبات ValidateAddress اللازمة للتحقّق من صحة العنوان بالكامل.

ValidateAddress

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

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

العنوان

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

الحقول
formatted_address

string

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

postal_address

PostalAddress

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

address_components[]

AddressComponent

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

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

missing_component_types[]

string

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

unconfirmed_component_types[]

string

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

unresolved_tokens[]

string

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

AddressComponent

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

الحقول
component_name

ComponentName

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

component_type

string

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

confirmation_level

ConfirmationLevel

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

inferred

bool

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

spell_corrected

bool

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

replaced

bool

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

unexpected

bool

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

ConfirmationLevel

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

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

AddressMetadata

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

الحقول
business

bool

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

po_box

bool

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

residential

bool

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

ComponentName

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

الحقول
text

string

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

language_code

string

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

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

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

الحقول
location

LatLng

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

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

plus_code

PlusCode

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

bounds

Viewport

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

feature_size_meters

float

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

place_id

string

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

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

place_types[]

string

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

LanguageOptions

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

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

الحقول
return_english_latin_address

bool

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

PlusCode

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

الحقول
global_code

string

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

compound_code

string

الرمز المركَّب للمكان، مثل "33GV+HQ، رامبيرغ، النرويج"، الذي يحتوي على لاحقة الرمز العالمي ويستبدل البادئة باسم منسَّق لكيان مرجعي

ProvideValidationFeedbackRequest

طلب إرسال ملاحظات التحقق من الصحة.

الحقول
conclusion

ValidationConclusion

مطلوبة. يشير ذلك المصطلح إلى نتيجة تسلسل محاولات التحقّق من الصحة.

في حال ضبط هذا الحقل على "VALIDATION_CONCLUSION_UNSPECIFIED"، سيظهر خطأ INVALID_ARGUMENT.

response_id

string

مطلوبة. رقم تعريف الردّ الذي تتعلّق به هذه الملاحظات. يجب أن يكون هذا الحقل [Response_id][google.maps.addressforceation.v1.verifyAddressRequest.response_id] من الردّ الأوّل في سلسلة من محاولات التحقق من صحة العنوان.

ValidationConclusion

النتائج النهائية المحتملة لتسلسل طلبات التحقّق من العنوان اللازمة للتحقق من صحة عنوان.

عمليات التعداد
VALIDATION_CONCLUSION_UNSPECIFIED هذه القيمة غير مستخدمة. وفي حال ضبط الحقل ProvideValidationFeedbackRequest.conclusion على VALIDATION_CONCLUSION_UNSPECIFIED، سيتم عرض الخطأ INVALID_ARGUMENT.
VALIDATED_VERSION_USED تم استخدام نسخة العنوان التي تعرضها واجهة برمجة التطبيقات Address Verification API للمعاملة.
USER_VERSION_USED تم استخدام نسخة العنوان التي قدّمها المستخدم في المعاملة.
UNVALIDATED_VERSION_USED وتم استخدام نسخة من العنوان الذي تم إدخاله بعد آخر محاولة تحقُّق ولكن لم تتم إعادة التحقُّق منه للمعاملة.
UNUSED تم إلغاء المعاملة وعدم استخدام العنوان.

ProvideValidationFeedbackResponse

لا يشتمل هذا النوع على أي حقول.

الاستجابة لملاحظات التحقق من الصحة.

يكون الرد فارغًا إذا تم إرسال الملاحظات بنجاح.

UspsAddress

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

الحقول
first_address_line

string

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

firm

string

اسم الشركة.

second_address_line

string

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

urbanization

string

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

city_state_zip_address_line

string

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

city

string

اسم المدينة

state

string

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

zip_code

string

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

zip_code_extension

string

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

UspsData

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

الحقول
standardized_address

UspsAddress

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

delivery_point_code

string

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

delivery_point_check_digit

string

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

dpv_confirmation

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

int32

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

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

string

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

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

string

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

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

string

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

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

int32

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

dpv_no_secure_location

string

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

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

string

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

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

string

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

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

string

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

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

string

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

البادئات:

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

string

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

ews_no_match

bool

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

post_office_city

string

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

post_office_state

string

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

abbreviated_city

string

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

fips_county_code

string

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

county

string

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

elot_number

string

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

elot_flag

string

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

po_box_only_postal_code

bool

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

pmb_designator

string

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

pmb_number

string

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

address_record_type

string

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

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

bool

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

error_message

string

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

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

cass_processed

bool

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

ValidateAddressRequest

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

الحقول
address

PostalAddress

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

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

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

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

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

previous_response_id

string

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

enable_usps_cass

bool

يتم تفعيل وضع التوافق مع USPS CASS. ويؤثر هذا فقط في الحقل google.maps.addressvalidation.v1.ValidationResult.usps_data في google.maps.addressvalidation.v1.ValidationResult. ملاحظة: بالنسبة إلى الطلبات التي توفّر خدمة USPS CASS للعناوين في بورتوريكو، يجب تقديم google.type.PostalAddress.region_code من address على أنّها "PR"، أو google.type.PostalAddress.administrative_area من address على أنّها "بورتوريكو" (غير حساسة لحالة الأحرف) أو "PR".

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

language_options

LanguageOptions

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

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

session_token

string

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

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

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

ValidateAddressResponse

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

الحقول
result

ValidationResult

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

response_id

string

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

ValidationResult

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

الحقول
verdict

Verdict

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

address

Address

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

geocode

Geocode

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

metadata

AddressMetadata

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

usps_data

UspsData

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

english_latin_address

Address

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

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

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

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

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

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

النتيجة

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

الحقول
input_granularity

Granularity

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

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

validation_granularity

Granularity

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

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

geocode_granularity

Granularity

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

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

address_complete

bool

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

has_unconfirmed_components

bool

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

has_inferred_components

bool

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

has_replaced_components

bool

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

درجة الدقة

يشير ذلك المصطلح إلى درجات الدقة المختلفة التي يمكن أن يتضمّنها العنوان أو الرمز الجغرافي. وعند استخدامها للإشارة إلى مستوى دقة عنوان، تشير هذه القيم إلى مدى دقة العنوان في تحديد الوجهة البريدية. على سبيل المثال، يحدِّد عنوان مثل "123 Main Street, Redwood City, CA, 94061" PREMISE بينما يحدِّد شيء مثل "Redwood City, CA, 94061" LOCALITY. ومع ذلك، إذا لم نتمكن من العثور على رمز جغرافي لـ "123 الشارع الرئيسي" في مدينة ريدوود، قد يكون الرمز الجغرافي المعروض بدقة LOCALITY على الرغم من أن العنوان أكثر دقة.

عمليات التعداد
GRANULARITY_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
SUB_PREMISE نتيجة من طابق أقل من المبنى، مثل شقة
PREMISE النتيجة على مستوى المبنى
PREMISE_PROXIMITY رمز جغرافي تقريبي من موقع العنوان على مستوى المبنى
BLOCK يشير العنوان أو الرمز الجغرافي إلى كتلة. تُستخدم فقط في المناطق التي تحتوي على عناوين على مستوى الحظر، مثل اليابان.
ROUTE يكون الرمز الجغرافي أو العنوان دقيقًا بالنسبة إلى المسار، مثل شارع أو طريق أو طريق سريع.
OTHER جميع التفاصيل الدقيقة الأخرى، التي يتم تجميعها معًا نظرًا لأنها غير قابلة للمُخرَج النهائي.