Method: properties.list

ویژگی‌های فرزند را تحت حساب والد مشخص‌شده برمی‌گرداند.

اگر فراخوانی‌کننده دسترسی نداشته باشد، ویژگی‌ها حذف می‌شوند. ویژگی‌های حذف‌شده‌ی موقت (یعنی: "حذف‌شده") به‌طور پیش‌فرض حذف می‌شوند. اگر هیچ ویژگی مرتبطی یافت نشود، یک لیست خالی برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای پرس و جو

پارامترها
filter

string

الزامی. عبارتی برای فیلتر کردن نتایج درخواست. فیلدهای واجد شرایط برای فیلتر کردن عبارتند از: parent: (نام منبع حساب/ویژگی والد) یا ancestor: (نام منبع حساب والد) یا firebase_project: (شناسه یا شماره پروژه فایربیس لینک شده). چند نمونه از فیلترها:

| 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

اختیاری. حداکثر تعداد منابعی که باید برگردانده شوند. سرویس ممکن است کمتر از این مقدار را برگرداند، حتی اگر صفحات اضافی وجود داشته باشد. اگر مشخص نشود، حداکثر ۵۰ منبع برگردانده می‌شود. حداکثر مقدار ۲۰۰ است؛ (مقادیر بالاتر به حداکثر مقدار خود محدود می‌شوند)

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