Method: properties.list

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

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

طلب 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 RPC.

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

تمثيل 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