Method: properties.list

تعرِض هذه الدالة المواقع الفرعية ضمن الحساب الرئيسي المحدّد.

سيتم استبعاد المواقع إذا لم يكن لدى المتصل إذن الوصول إليها. يتم تلقائيًا استبعاد المواقع التي تم حذفها مؤقتًا (أي "المُرسَلة إلى المهملات"). تعرِض هذه الدالة قائمة فارغة في حال عدم العثور على أيّ مواقع ذات صلة.

طلب HTTP

GET https://analyticsadmin.googleapis.com/v1beta/properties

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

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

المعلمات
filter

string

مطلوب. تعبير لفلترة نتائج الطلب الحقول المؤهَّلة للفلترة هي: parent:(اسم المورد للحساب/الموقع الرئيسي) أو ancestor:(اسم المورد للحساب الرئيسي) أو firebase_project:(رقم أو معرّف مشروع Firebase المرتبط). في ما يلي بعض الأمثلة على الفلاتر:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

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

string

رمز مميّز للصفحة، تم تلقّيه من مكالمة properties.list سابقة قدِّم هذا المرجع لاسترداد الصفحة اللاحقة. عند تقسيم الصفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى properties.list مع الطلب الذي قدّم الرمز المميّز للصفحة.
showDeleted

boolean

ما إذا كان سيتم تضمين المواقع التي تم حذفها مؤقتًا (أي "المُرسَلة إلى المهملات") في النتائج. يمكن فحص المواقع لتحديد ما إذا تم حذفها أم لا.

نص الطلب

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

نص الاستجابة

رسالة الاستجابة لاستدعاء إجراء properties.list عن بُعد

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

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

object (Property)

النتائج التي تطابقت مع معايير الفلترة وكان بإمكان المتصل الوصول إليها
nextPageToken

string

رمز مميّز يمكن إرساله كـ pageToken لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

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

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit