Method: accounts.locations.findMatches

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

طلب HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches

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

مَعلمات المسار

المعلمات
name

string

اسم المورد للموقع الجغرافي الذي تريد العثور على مطابقات له.

نص الطلب

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

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

string

اللغة المفضّلة للموقع الجغرافي المطابق (بتنسيق BCP-47)

numResults

integer

عدد النتائج المطابقة المطلوب عرضها. القيمة التلقائية هي 3، بحدّ أقصى 10. يُرجى العِلم أنّ وقت الاستجابة قد يزيد في حال طلب المزيد. ولا يتم التقسيم على صفحات.

maxCacheDuration

string (Duration format)

تمّ الإيقاف. يتم تجاهل هذا الحقل لجميع الطلبات.

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى، ويتم إنهاؤها بعبارة "s". مثال: "3.5s"

نص الاستجابة

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

رسالة استجابة لـ Location.FindMatchingLocations.

تمثيل JSON
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
الحقول
matchedLocations[]

object (MatchedLocation)

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

matchTime

string (Timestamp format)

آخر مرة تم فيها تنفيذ خوارزمية المطابقة لهذا الموقع الجغرافي.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

MatchedLocation

يمثل تطابقًا محتملاً مع موقع جغرافي.

تمثيل JSON
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
الحقول
location

object (Location)

الموقع الجغرافي ذو الكثافة السكانية المنخفضة والذي قد يكون مطابقًا محتملاً. تشمل الحقول التي لم تتم تعبئتها، على سبيل المثال لا الحصر: الاسم (لا يمكن استرداد الموقع الجغرافي المطابِق عبر locations.get أو locations.batchGet). storeCode؛ تفاصيل منطقة التغطية serviceArea labels؛ adWordsLocationExtensions؛ photos

isExactMatch

boolean

هل هذه مطابقة تامة؟