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

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