يسرد المواقع الجغرافية للحساب المحدّد.
طلب HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. اسم الحساب المطلوب جلب المواقع الجغرافية منه إذا كان العنصر الرئيسي [Account] [google.mybusiness.accountmanagement.v1.Account] من [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] شخصية، لن يتم عرض سوى المواقع الجغرافية التي يملكها الحساب بشكل مباشر، وإلا سيتم عرض جميع المواقع الجغرافية التي يمكن الوصول إليها من الحساب، سواء بشكل مباشر أو غير مباشر. |
معلمات طلب البحث
المَعلمات | |
---|---|
pageSize |
اختياريّ. عدد المواقع الجغرافية المطلوب جلبها لكل صفحة. وتكون القيمة التلقائية 10 في حال عدم ضبطها. الحد الأدنى هو 1 والحد الأقصى لحجم الصفحة هو 100. |
pageToken |
اختياريّ. في حال تحديدها، سيتم جلب |
filter |
اختياريّ. فلتر يقيد المواقع بالرجوع. لا يتضمن الرد سوى الإدخالات التي تتطابق مع الفلتر. إذا كانت لمزيد من المعلومات عن الحقول الصالحة وأمثلة على الاستخدام، يُرجى الاطّلاع على دليل العمل باستخدام بيانات الموقع الجغرافي. |
orderBy |
اختياريّ. ترتيب الفرز للطلب. يجب أن تكون الحقول المتعددة مفصولة بفواصل، وفقًا لبنية SQL. يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد الترتيب التنازلي، يجب إضافة اللاحقة " desc". الحقلان الصالحان للسمة orderBy هو هما العنوان وstoreCode. على سبيل المثال: "العنوان" أو "وصف رمز المتجر" أو "العنوان" أو "وصف رمز المتجر" |
readMask |
مطلوبة. قراءة القناع لتحديد الحقول التي سيتم عرضها في الرد هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة استجابة لـ Locations.ListLocations.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"locations": [
{
object ( |
الحقول | |
---|---|
locations[] |
المواقع الجغرافية. |
nextPageToken |
إذا تجاوز عدد المواقع الجغرافية حجم الصفحة المطلوب، تتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من المواقع الجغرافية عند إجراء مكالمة لاحقة إلى |
totalSize |
العدد التقريبي للمواقع الجغرافية في القائمة بغض النظر عن تقسيمها على صفحات. وسيتم عرض هذا الحقل فقط في حال استخدام |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/business.manage
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.