Method: accounts.locations.list

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

طلب HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

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

المعلمات
parent

string

مطلوب. اسم الحساب الذي تريد استرجاع المواقع الجغرافية منه إذا كان الحساب الرئيسي [Account] [google.mybusiness.accountmanagement.v1.Account] هي [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL، لا يتم إرجاع سوى المواقع الجغرافية التي يملكها الحساب بشكل مباشر، وإلّا سيتم عرض كل المواقع الجغرافية التي يمكن الوصول إليها من الحساب، سواء بشكل مباشر أو غير مباشر.

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

المعلمات
pageSize

integer

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

string

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

string

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

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

string

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

string (FieldMask format)

مطلوب. قراءة القناع لتحديد الحقول التي سيتم عرضها في الردّ

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

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

نص الاستجابة

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

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

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

object (Location)

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

string

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

integer

العدد التقريبي للمواقع الجغرافية في القائمة بغض النظر عن التقسيم على صفحات. لن يتم عرض هذا الحقل إلا في حال استخدام filter كمَعلمة طلب بحث.

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

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

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

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