Method: subscriptions.list

מציג את המינויים ל-Google Workspace. כאן מוסבר איך משתמשים בשיטה הזו.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אופציונלי. המספר המקסימלי של מינויים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך או אם הערך הוא 0, מוחזרים עד 50 מינויים.

הערך המקסימלי הוא 100. אם מציינים ערך שגדול מ-100, המערכת מחזירה רק 100 מינויים.
pageToken

string

אופציונלי. אסימון דף שהתקבל מקריאה קודמת של list subscriptions. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, ערך המסנן צריך להיות זהה לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות בלתי צפויות.
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

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