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

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