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

למידע נוסף, ניתן לעיין במדריך ההרשאות.