Method: accounts.locations.list

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

طلب HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

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

المعلمات
parent

string

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

معامِلات طلب البحث

المعلمات
pageSize

integer

عدد المواقع الجغرافية المطلوب جلبها لكل صفحة الإعداد التلقائي هو 100، والحد الأدنى هو 1، والحد الأقصى لحجم الصفحة هو 100.
pageToken

string

وفي حال تحديده، سيتم جلب page التالية من المواقع الجغرافية. يتم عرض الرمز المميّز للصفحة من خلال الطلبات السابقة إلى locations.list عندما يكون عدد المواقع الجغرافية أكثر من الحجم المطلوب.
filter

string

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

لمزيد من المعلومات حول الحقول الصالحة وأمثلة الاستخدام، اطّلِع على دليل العمل باستخدام بيانات الموقع الجغرافي.
languageCode
(deprecated)

string

رمز اللغة BCP 47 الذي يمكن استخدامه لعرض خصائص الموقع الجغرافي إذا لم تكن هذه اللغة متوفّرة، سيتم توفيرها بلغة الموقع الجغرافي. وإذا لم تتوفّر أي منهما، سيتم تقديمها باللغة الإنجليزية.

تمّ الإيقاف. بعد 15 آب (أغسطس) 2020، لن يبقى هذا الحقل ساريًا. وبدلاً من ذلك، سيتم استخدام لغة الموقع الجغرافي دائمًا.
orderBy

string

ترتيب الطلب: يجب أن تكون الحقول المتعددة مفصولة بفواصل، وفقًا لبنية SQL. يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي، يجب استخدام لاحقة " وصف" . الحقلان الصالحان لأمر orderBy هو locationName وstoreCode. على سبيل المثال: "locationName, storeCode desc" أو "locationName" أو "storeCode desc"

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

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

رسالة ردّ لـ Sites.ListLocations.

تمثيل JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
الحقول
locations[]

object (Location)

المواقع الجغرافية
nextPageToken

string

إذا تجاوز عدد المواقع الجغرافية حجم الصفحة المطلوب، تتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من المواقع الجغرافية في مكالمة لاحقة إلى الرقم locations.list. إذا لم تكن هناك مواقع جغرافية أخرى، هذا يعني أنّ هذا الحقل غير متوفّر في الردّ.
totalSize

integer

العدد التقريبي للمواقع الجغرافية في القائمة بغض النظر عن التقسيم على صفحات.

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

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

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

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