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
  • 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

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