Method: subscriptions.list

تعرض هذه الطريقة اشتراكات Google Workspace. للتعرّف على كيفية استخدام هذه الطريقة، يُرجى الاطّلاع على قائمة اشتراكات Google Workspace.

طلب HTTP

GET https://workspaceevents.googleapis.com/v1beta/subscriptions

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

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

المعلمات
pageSize

integer

اختيارية: تمثّل هذه السمة الحدّ الأقصى لعدد الاشتراكات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة.

إذا لم يتم تحديدها أو تم ضبطها على 0، سيتم عرض ما يصل إلى 50 اشتراكًا.

الحد الأقصى للقيمة هو 100. إذا حدّدت قيمة أكبر من 100، لن يعرض النظام سوى 100 اشتراك.
pageToken

string

اختيارية: رمز مميّز للصفحة تم استلامه من طلب سابق لعرض قائمة الاشتراكات. قدِّم هذه المَعلمة لاسترداد الصفحة التالية.

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق قيمة الفلتر مع طلب البحث الذي قدّم الرمز المميّز للصفحة. قد يؤدي تمرير قيمة مختلفة إلى نتائج غير متوقّعة.
filter

string

مطلوب. فلتر طلب البحث

يمكنك فلترة الاشتراكات حسب نوع الحدث (event_types) والمورد المستهدف (target_resource).

يجب تحديد نوع حدث واحد على الأقل في طلب البحث. للفلترة حسب أنواع أحداث متعددة، استخدِم عامل التشغيل OR.

للفلترة حسب نوع الحدث والمورد المستهدف، استخدِم عامل التشغيل AND وحدِّد اسم المورد الكامل، مثل //chat.googleapis.com/spaces/{space}.

على سبيل المثال، الاستعلامات التالية صالحة:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ INVALID_ARGUMENT.

نص الطلب

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

نص الاستجابة

رسالة الردّ على SubscriptionsService.ListSubscriptions

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

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

object (Subscription)

قائمة الاشتراكات
nextPageToken

string

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

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

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.