הצגת רשימת המשתתפים בתיעוד של שיחת ועידה. כברירת מחדל, הרשימה ממוינת לפי שעת ההצטרפות של המשתתפים בסדר יורד. ה-API הזה תומך ב-fields
כפרמטרים רגילים, כמו כל ממשק API אחר. עם זאת, אם משמיטים את פרמטר הבקשה fields
, ברירת המחדל של ה-API הזה היא 'participants/*,
nextPageToken'
.
בקשת HTTP
GET https://meet.googleapis.com/v2/{parent=conferenceRecords/*}/participants
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. פורמט: |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
מספר המשתתפים המקסימלי שיוחזר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים דבר, יוחזרו עד 100 משתתפים. הערך המקסימלי הוא 250. ערכים מעל 250 יומרו ל-250. המספר המקסימלי עשוי להשתנות בעתיד. |
pageToken |
אסימון דף שהוחזר מהקריאה הקודמת ל-List. |
filter |
אופציונלי. תנאי סינון שהוגדר על ידי המשתמש בפורמט EBNF. אלה השדות שניתן לסנן:
לדוגמה, |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה של השיטה participants.list.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"participants": [
{
object ( |
שדות | |
---|---|
participants[] |
רשימת המשתתפים בדף אחד. |
nextPageToken |
אסימון שיוחזר לקריאה נוספת של הרשימה אם הרשימה הנוכחית לא כוללת את כל המשתתפים. הערך לא מוגדר אם כל המשתתפים מוחזרים. |
totalSize |
המספר המדויק הכולל של |
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/meetings.space.created
https://www.googleapis.com/auth/meetings.space.readonly
מידע נוסף זמין במדריך ההרשאות.