Method: accounts.locations.list

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

طلب HTTP

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

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

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

المَعلمات
parent

string

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

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

المَعلمات
pageSize

integer

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

string

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

string

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

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

string

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

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

string

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

نص الطلب

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

نص الاستجابة

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

رسالة استجابة لـ Locations.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.