Method: projects.sites.customDomains.list

يسرد كل CustomDomain مرتبط بموقع الاستضافة الإلكتروني الرئيسي المحدّد.

تعرض قيم CustomDomain بطريقة متسقة ولكن غير محدّدة، لتسهيل التقسيم على صفحات.

طلب HTTP

GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains

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

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

المَعلمات
parent

string

مطلوب. تتم استضافة Firebase على Site مع CustomDomain كيانات تريد إدراجها.

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

المَعلمات
pageSize

integer

الحد الأقصى لعدد الكيانات البالغ عددها CustomDomain المطلوب عرضها في الطلب وتكون القيمة التلقائية هي 10.
pageToken

string

رمز مميّز من مكالمة سابقة إلى customDomains.list لإعلام الخادم بمكان استئناف بطاقة بيانات المتجر
showDeleted

boolean

في حال اختيار "صحيح"، يعرض الطلب رموز CustomDomain محذوفة بشكلٍ مبدئي والتي لم يتم حذفها بالكامل بعد. لاستعادة CustomDomain محذوفة، يُرجى تقديم طلب customDomains.undelete.

نص الطلب

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

نص الاستجابة

الرد من customDomains.list

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

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

object (CustomDomain)

قائمة تضم CustomDomain كيانات مرتبطة بأداة Firebase Site المحدّدة.
nextPageToken

string

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

يمكنك تضمين هذا الرمز في مكالمتك التالية مع customDomains.list. تكون الرموز المميّزة للصفحة قصيرة الأجل ويجب عدم تخزينها.

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

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

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

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