Method: accounts.locations.list

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

طلب HTTP

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

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

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

المعلمات
parent

string

الحقل مطلوب. اسم الحساب الذي سيتم جلب المواقع الجغرافية منه

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

  • حرف البدل (-): يؤدي استخدام accounts/- إلى تحديد المستخدم الذي تمت مصادقته. يتم ضبط هذا النطاق تلقائيًا على AccountType.PERSONAL، ولكنه يتضمّن المواقع الجغرافية المملوكة بشكل مباشر وغير مباشر (مثل المواقع التي يمكن الوصول إليها من خلال مجموعات الأعضاء).

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

المعلمات
pageSize

integer

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

string

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

string

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

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

string

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

string (FieldMask format)

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

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

نص الطلب

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

نص الاستجابة

رسالة الردّ على Locations.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 Overview.