Method: alerts.list

هشدارها را فهرست می کند.

درخواست HTTP

GET https://alertcenter.googleapis.com/v1beta1/alerts

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
customerId

string

اختیاری. شناسه منحصر به فرد حساب Google Workspace مشتری که هشدارها با آن مرتبط است. customerId باید «C» اولیه را حذف کرده باشد (مثلاً 046psxkn ). در صورت عدم ارائه از هویت تماس گیرنده استنباط می شود. شناسه مشتری خود را پیدا کنید .

pageSize

integer

اختیاری. اندازه صفحه درخواستی سرور ممکن است تعداد کمتری از موارد درخواستی را برگرداند. اگر مشخص نشده باشد، سرور یک پیش فرض مناسب را انتخاب می کند.

pageToken

string

اختیاری. نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. اگر خالی باشد، یک تکرار جدید شروع می شود. برای ادامه یک تکرار، مقدار فیلد nextPageToken مربوط به ListAlertsResponse قبلی را وارد کنید.

filter

string

اختیاری. یک رشته پرس و جو برای فیلتر کردن نتایج هشدار. برای جزئیات بیشتر، فیلترهای پرس و جو و فیلدهای فیلتر درخواست پشتیبانی شده را ببینید.

orderBy

string

اختیاری. ترتیب مرتب سازی نتایج لیست اگر نتایج مشخص نشده باشد ممکن است به ترتیب دلخواه برگردانده شوند. با استفاده از orderBy="createTime desc" می‌توانید نتایج را به ترتیب نزولی بر اساس مُهر زمانی ایجاد مرتب کنید. در حال حاضر، مرتب‌سازی پشتیبانی شده عبارتند از createTime asc ، createTime desc ، updateTime desc

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پیام پاسخ برای درخواست لیست هشدار.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
فیلدها
alerts[]

object ( Alert )

لیست هشدارها

nextPageToken

string

نشانه برای صفحه بعد. اگر خالی نباشد، نشان می دهد که ممکن است هشدارهای بیشتری وجود داشته باشد که با درخواست فهرست مطابقت داشته باشد. این مقدار را می توان در یک ListAlertsRequest بعدی برای دریافت هشدارهای ادامه یافته از آخرین نتیجه تماس فعلی لیست استفاده کرد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/apps.alerts

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.