Method: subscriptions.list

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

طلب HTTP

GET https://workspaceevents.googleapis.com/v1/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

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