Method: projects.locations.list

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

طلب HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

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

المَعلمات
name

string

تمثّل هذه السمة المورد الذي يملك مجموعة المواقع الجغرافية، إذا كان ذلك منطبقًا.

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

المَعلمات
filter

string

فلتر لتضييق نطاق النتائج إلى مجموعة فرعية مفضَّلة. تقبل لغة الفلترة السلاسل مثل "displayName=tokyo"، ويتم توثيقها بمزيد من التفاصيل في AIP-160.

pageSize

integer

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

pageToken

string

رمز مميّز للصفحة تم استلامه من حقل nextPageToken في الردّ أرسِل الرمز المميّز للصفحة هذا لتلقّي الصفحة التالية.

نص الطلب

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

نص الاستجابة

رسالة الرد لـ Locations.ListLocations.

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

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

object (Location)

قائمة بالمواقع الجغرافية التي تطابق الفلتر المحدَّد في الطلب

nextPageToken

string

الرمز المميز العادي للقائمة التالية.

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

يتطلب استخدام أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

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