Method: googleLocations.search

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

طلب HTTP

POST https://mybusinessbusinessinformation.googleapis.com/v1/googleLocations:search

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

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
الحقول
pageSize

integer

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

object (Location)

الموقع الجغرافي المطلوب البحث عنه في حال توفّرها، سيتم العثور على المواقع الجغرافية التي تتطابق مع تفاصيل الموقع الجغرافي المقدَّمة، والتي يجب أن تتضمّن قيمة للعنوان.
query

string

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

نص الاستجابة

رسالة الردّ على GoogleLocations.SearchGoogleLocations.

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

تمثيل JSON 
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
الحقول
googleLocations[]

object (GoogleLocation)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

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