Method: projects.availableLocations.list

يسرد مواقع موارد Google Cloud Platform (GCP) الصالحة للمشروع المحدّد (بما في ذلك FirebaseProject).

يمكن اختيار أحد هذه المواقع الجغرافية ليكون الموقع الجغرافي التلقائي لمورد GCP الخاص بالمشروع، وهو الموقع الجغرافي الذي سيتم فيه توفير موارد المشروع تلقائيًا، مثل Cloud Firestore. ومع ذلك، إذا سبق أن تم ضبط الموقع الجغرافي التلقائي لمورد Google Cloud Platform لهذا المشروع، لا يمكن تغيير هذا الإعداد.

تتحقّق هذه المكالمة من وجود أي قيود محتمَلة على الموقع الجغرافي للمشروع المحدّد، وبالتالي قد تعرض مجموعة فرعية من جميع المواقع الجغرافية المحتملة لموارد Google Cloud Platform. لإدراج جميع المواقع الجغرافية لموارد Google Cloud Platform (بغض النظر عن أي قيود)، يمكنك طلب نقطة النهاية بدون تحديد معرّف مشروع فريد (أي /v1beta1/{parent=projects/-}/listAvailableLocations).

لطلب availableLocations.list من خلال مشروع محدّد، يجب أن يكون العضو مُشاهدًا للمشروع على الأقل. لا تتطلب المكالمات التي لا تتضمّن مشروعًا محدّدًا أي أذونات محدّدة للمشروع.

طلب HTTP

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

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

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

المَعلمات
parent

string

FirebaseProject المطلوب إدراج مواقع موارد Google Cloud Platform له بالتنسيق:

projects/PROJECT_IDENTIFIER

راجِع الحقل FirebaseProject name للحصول على تفاصيل حول قيم PROJECT_IDENTIFIER.

في حال عدم تحديد معرّف مشروع فريد (أي projects/-)، لن تأخذ القائمة المعروضة في الاعتبار قيود الموقع الجغرافي الخاصة بالمؤسسة أو الخاصة بالمشروع.

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

المَعلمات
pageToken

string

تم عرض رمز مميّز من مكالمة سابقة إلى availableLocations.list يشير إلى مكان استئناف الإدراج في قائمة المواقع الجغرافية.
pageSize

integer

الحد الأقصى لعدد المواقع الجغرافية المطلوب عرضها في الردّ.

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

لا يمكن أن تكون هذه القيمة سالبة.

نص الطلب

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

نص الاستجابة

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

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

object (Location)

صفحة واحدة من نتائج مكالمة إلى availableLocations.list.
nextPageToken

string

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

ويمكن استخدام هذا الرمز في مكالمة لاحقة إلى availableLocations.list للعثور على المزيد من المواقع الجغرافية.

تكون الرموز المميّزة للصفحة قصيرة الأجل ويجب عدم الاحتفاظ بها.

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

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

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

موقع لمورد Google Cloud Platform يمكن اختياره لـ FirebaseProject.

تمثيل JSON 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
الحقول
locationId

string

رقم تعريف الموقع الجغرافي لمورِّد Google Cloud Platform وسيكون أحد مواقع موارد GCP المتاحة.
type

enum (LocationType)

يشير إلى ما إذا كان موقع مورد Google Cloud Platform (GCP) هو موقعًا إقليميًا أو متعدد المناطق لتكرار البيانات.
features[]

enum (LocationFeature)

المنتجات والخدمات المتوفّرة في موقع موارد GCP.

LocationType

يحدِّد هذا الإعداد كيفية نسخ البيانات ضمن موقع مورد Google Cloud Platform. تعرَّف على المزيد من المعلومات عن أنواع مواقع موارد Google Cloud Platform.

تعدادات
LOCATION_TYPE_UNSPECIFIED يتم استخدام البيانات داخليًا للتمييز بين القيم التي لم يتم ضبطها، وهي ليست مخصّصة للاستخدام الخارجي.
REGIONAL

الموقع الجغرافي هو موقع جغرافي إقليمي.

يتم نسخ البيانات في موقع إقليمي في مناطق متعددة داخل المنطقة.
MULTI_REGIONAL

الموقع الجغرافي متعدّد المناطق.

يتم نسخ البيانات في موقع جغرافي متعدد المناطق في عدة مناطق. داخل كل منطقة، يتم نسخ البيانات في مناطق متعددة.

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

المنتجات والخدمات المتوفّرة في موقع موارد GCP.

تعدادات
LOCATION_FEATURE_UNSPECIFIED يتم استخدام البيانات داخليًا للتمييز بين القيم التي لم يتم ضبطها، وهي ليست مخصّصة للاستخدام الخارجي.
FIRESTORE

يتوافق هذا الموقع مع مثيلات قاعدة بيانات Cloud Firestore.

يتوفر App Engine في هذا الموقع، لذا يمكن أن يكون الموقع التلقائي لمورد Google Cloud Platform للمشروع.
DEFAULT_STORAGE

يتيح هذا الموقع الجغرافي إمكانية استخدام الحزم التلقائية في Cloud Storage.

يتوفر App Engine في هذا الموقع، لذا يمكن أن يكون الموقع التلقائي لمورد Google Cloud Platform للمشروع.
FUNCTIONS تتوفّر وظائف السحابة الإلكترونية لبرنامج Firebase في هذا الموقع الجغرافي.