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".

نص الاستجابة

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

رسالة الرد لـ Locations.FindMatchingLocations.

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

object (MatchedLocation)

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

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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 وتفاصيل منطقة التغطية وlabels وadWordsLocationExtensions وphotos.serviceArea
isExactMatch

boolean

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