این راهنما توضیح میدهد که چگونه با استفاده از API REST گوگل میت، جزئیات مربوط به شرکتکنندگانی که در کنفرانسهای قبلی شرکت کردهاند یا در یک کنفرانس فعال هستند را به همراه اطلاعات جلسه آنها دریافت کنید.
شرکتکننده شخصی است که به یک تماس پیوسته یا از حالت همراهی استفاده میکند، به عنوان بیننده تماشا میکند، یا یک دستگاه اتاق است که به یک تماس متصل است. برای هر فرد یک منبع participants وجود دارد.
یک جلسه شرکتکننده، یک شناسه جلسه منحصر به فرد است که برای هر جفت شرکتکننده-دستگاه که به یک تماس میپیوندد، ایجاد میشود. برای هر جلسه یک منبع participantSessions وجود دارد. اگر شرکتکننده چندین بار از یک جفت شرکتکننده-دستگاه به یک تماس بپیوندد، به هر یک از آنها شناسههای جلسه منحصر به فردی اختصاص داده میشود.
اگر شما مالک یا شرکتکنندهی فضای جلسه هستید، میتوانید متدهای get() و list() را هم در منابع participants و هم در منابع participantSessions فراخوانی کنید تا رکوردهای شرکتکننده را بازیابی کنید.
احراز هویت و مجوزدهی با استفاده از اعتبارنامههای کاربر به برنامههای Google Meet اجازه میدهد تا به دادههای کاربر دسترسی پیدا کرده و عملیات را از طرف کاربر احراز هویتشده انجام دهند. احراز هویت با واگذاری اختیارات در سطح دامنه به شما امکان میدهد تا حساب سرویس یک برنامه را برای دسترسی به دادههای کاربران خود بدون نیاز به رضایت هر کاربر، مجاز کنید.
شرکتکنندگان
بخشهای بعدی نحوهی دریافت اطلاعات شرکتکنندگان در یک رکورد کنفرانس را شرح میدهند.
منبع participants با فیلد user ادغام میشود. یک user میتواند فقط یکی از اشیاء زیر باشد:
یک
signedinUserیکی از موارد زیر است:فردی که از طریق رایانه شخصی، دستگاه تلفن همراه یا از طریق حالت همراه (Companion mode) به سیستم متصل میشود.
یک حساب کاربری ربات که توسط دستگاههای اتاق کنفرانس استفاده میشود.
کاربر
anonymousUserکاربری ناشناس است که به حساب گوگل خود وارد نشده است.phoneUserکاربری است که از تلفنی که هویتش ناشناخته است تماس میگیرد زیرا با حساب گوگل وارد نشده است.
توجه داشته باشید که اگرچه هر سه شیء یک displayName برمیگردانند، signedinUser همچنین یک شناسه user منحصر به فرد را برمیگرداند که با Admin SDK API و People API قابل تعامل است. فرمت: users/{user} . برای اطلاعات بیشتر در مورد استفاده از شناسه user با People API، به بخش بازیابی جزئیات شرکتکننده با People API مراجعه کنید.
دریافت جزئیات مربوط به یک شرکتکننده
برای دریافت جزئیات مربوط به یک شرکتکننده خاص، از متد get() روی منبع participants به همراه پارامتر name path استفاده کنید. اگر نام شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() نام تمام شرکتکنندگان را لیست کنید .
این متد، دادههای یک شرکتکننده را به عنوان نمونهای از منبع participants برمیگرداند.
نمونه کد زیر نحوه بازیابی یک شرکتکننده خاص را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه شرکتکننده خاص در یک رکورد کنفرانس جایگزین کنید.
فهرست همه شرکتکنندگان
برای فهرست کردن جزئیات مربوط به همه شرکتکنندگان در یک رکورد کنفرانس، از متد list() روی منبع participants به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord} .
این متد لیستی از شرکتکنندگان کنفرانس را که بر اساس earliestStartTime به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participants برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به سفارشیسازی صفحهبندی یا فیلتر کردن لیست شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن همه شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد شرکتکنندگان برای بازگشت. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ شرکتکننده برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
earliestStartTimeیاlatestEndTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن عضو شدهاند استفاده کنید. هر دو فیلد از قالب Timestamp در قالب RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
earliestStartTime < 2023-10-01T15:01:23Z -
latestEndTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام شرکتکنندگان فعال در یک کنفرانس موجود،
latestEndTime IS NULLاستفاده کنید.-
جزئیات شرکتکنندگان را با People API بازیابی کنید
برای بازیابی جزئیات مربوط به یک شرکتکننده، از متد get() روی منبع people در People API استفاده کنید.
شناسه شخص را از منبع
participantبا استفاده از مؤلفه انتهایی مسیر استخراج کنید. برای مثال، اگر مقدار منبعparticipantconferenceRecords/abc-123/participants/12345باشد، شناسه برای API People12345است.READ_SOURCE_TYPE_PROFILE،READ_SOURCE_TYPE_CONTACTوREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceTypeوارد کنید. این کار تضمین میکند که هم کاربران داخلی سازمان Google Workspace و هم مخاطبین خارجی در پاسخ گنجانده شدهاند.
نمونه کد زیر نحوه جستجوی پروفایلهای سازمانی و مخاطبین یک شخص را نشان میدهد:
حلقه
curl \
'https://people.googleapis.com/v1/people/PERSON_ID?personFields=names%2CemailAddresses&sources=READ_SOURCE_TYPE_OTHER_CONTACT&sources=READ_SOURCE_TYPE_PROFILE&sources=READ_SOURCE_TYPE_CONTACT' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
موارد زیر را جایگزین کنید:
- PERSON_ID : شناسهی شخصی که قرار است پیدا شود.
- ACCESS_TOKEN : توکن دسترسی که دسترسی به چندین API را اعطا میکند.
جلسات شرکت کنندگان
بخشهای بعدی نحوهی دریافت اطلاعات مربوط به جلسات شرکتکنندگان یک شرکتکننده در یک رکورد کنفرانس را شرح میدهند.
جزئیات مربوط به جلسه شرکتکننده را دریافت کنید
برای دریافت جزئیات مربوط به یک جلسهی خاص از شرکتکنندگان، از متد get() در منبع participantSessions به همراه پارامتر name path استفاده کنید. اگر نام جلسهی شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() تمام جلسات شرکتکنندهی یک شرکتکننده را فهرست کنید .
این متد نام یک شرکتکننده را به عنوان نمونهای از منبع participantSessions برمیگرداند.
نمونه کد زیر نحوه بازیابی یک جلسه خاص از شرکتکنندگان را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه جلسه شرکتکننده خاص در یک جلسه شرکتکننده جایگزین کنید.
فهرست تمام جلسات شرکتکنندگان
برای فهرست کردن جزئیات مربوط به تمام جلسات یک شرکتکننده در یک رکورد کنفرانس، از متد list() در منبع participantSessions به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord}/participants/{participant} .
این متد لیستی از جلسات شرکتکنندگان را که بر اساس startTime و به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participantSession برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به بخش سفارشیسازی صفحهبندی یا فیلتر کردن لیست جلسات شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن تمام جلسات شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام جلسات شرکتکنندهی یک شرکتکننده در یک رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست جلسات شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی اختیاری زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن جلسات شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد جلسات شرکتکنندگان برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ جلسه شرکتکنندگان برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
startTimeیاendTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن خارج شدهاند، استفاده کنید. هر دو فیلد از قالب Timestamp در RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
startTime < 2023-10-01T15:01:23Z -
endTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام جلسات شرکتکنندگان فعال در رکورد کنفرانس،
endTime IS NULLاستفاده کنید.-
این راهنما توضیح میدهد که چگونه با استفاده از API REST گوگل میت، جزئیات مربوط به شرکتکنندگانی که در کنفرانسهای قبلی شرکت کردهاند یا در یک کنفرانس فعال هستند را به همراه اطلاعات جلسه آنها دریافت کنید.
شرکتکننده شخصی است که به یک تماس پیوسته یا از حالت همراهی استفاده میکند، به عنوان بیننده تماشا میکند، یا یک دستگاه اتاق است که به یک تماس متصل است. برای هر فرد یک منبع participants وجود دارد.
یک جلسه شرکتکننده، یک شناسه جلسه منحصر به فرد است که برای هر جفت شرکتکننده-دستگاه که به یک تماس میپیوندد، ایجاد میشود. برای هر جلسه یک منبع participantSessions وجود دارد. اگر شرکتکننده چندین بار از یک جفت شرکتکننده-دستگاه به یک تماس بپیوندد، به هر یک از آنها شناسههای جلسه منحصر به فردی اختصاص داده میشود.
اگر شما مالک یا شرکتکنندهی فضای جلسه هستید، میتوانید متدهای get() و list() را هم در منابع participants و هم در منابع participantSessions فراخوانی کنید تا رکوردهای شرکتکننده را بازیابی کنید.
احراز هویت و مجوزدهی با استفاده از اعتبارنامههای کاربر به برنامههای Google Meet اجازه میدهد تا به دادههای کاربر دسترسی پیدا کرده و عملیات را از طرف کاربر احراز هویتشده انجام دهند. احراز هویت با واگذاری اختیارات در سطح دامنه به شما امکان میدهد تا حساب سرویس یک برنامه را برای دسترسی به دادههای کاربران خود بدون نیاز به رضایت هر کاربر، مجاز کنید.
شرکتکنندگان
بخشهای بعدی نحوهی دریافت اطلاعات شرکتکنندگان در یک رکورد کنفرانس را شرح میدهند.
منبع participants با فیلد user ادغام میشود. یک user میتواند فقط یکی از اشیاء زیر باشد:
یک
signedinUserیکی از موارد زیر است:فردی که از طریق رایانه شخصی، دستگاه تلفن همراه یا از طریق حالت همراه (Companion mode) به سیستم متصل میشود.
یک حساب کاربری ربات که توسط دستگاههای اتاق کنفرانس استفاده میشود.
کاربر
anonymousUserکاربری ناشناس است که به حساب گوگل خود وارد نشده است.phoneUserکاربری است که از تلفنی که هویتش ناشناخته است تماس میگیرد زیرا با حساب گوگل وارد نشده است.
توجه داشته باشید که اگرچه هر سه شیء یک displayName برمیگردانند، signedinUser همچنین یک شناسه user منحصر به فرد را برمیگرداند که با Admin SDK API و People API قابل تعامل است. فرمت: users/{user} . برای اطلاعات بیشتر در مورد استفاده از شناسه user با People API، به بخش بازیابی جزئیات شرکتکننده با People API مراجعه کنید.
دریافت جزئیات مربوط به یک شرکتکننده
برای دریافت جزئیات مربوط به یک شرکتکننده خاص، از متد get() روی منبع participants به همراه پارامتر name path استفاده کنید. اگر نام شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() نام تمام شرکتکنندگان را لیست کنید .
این متد، دادههای یک شرکتکننده را به عنوان نمونهای از منبع participants برمیگرداند.
نمونه کد زیر نحوه بازیابی یک شرکتکننده خاص را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه شرکتکننده خاص در یک رکورد کنفرانس جایگزین کنید.
فهرست همه شرکتکنندگان
برای فهرست کردن جزئیات مربوط به همه شرکتکنندگان در یک رکورد کنفرانس، از متد list() روی منبع participants به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord} .
این متد لیستی از شرکتکنندگان کنفرانس را که بر اساس earliestStartTime به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participants برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به سفارشیسازی صفحهبندی یا فیلتر کردن لیست شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن همه شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد شرکتکنندگان برای بازگشت. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ شرکتکننده برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
earliestStartTimeیاlatestEndTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن عضو شدهاند استفاده کنید. هر دو فیلد از قالب Timestamp در قالب RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
earliestStartTime < 2023-10-01T15:01:23Z -
latestEndTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام شرکتکنندگان فعال در یک کنفرانس موجود،
latestEndTime IS NULLاستفاده کنید.-
جزئیات شرکتکنندگان را با People API بازیابی کنید
برای بازیابی جزئیات مربوط به یک شرکتکننده، از متد get() روی منبع people در People API استفاده کنید.
شناسه شخص را از منبع
participantبا استفاده از مؤلفه انتهایی مسیر استخراج کنید. برای مثال، اگر مقدار منبعparticipantconferenceRecords/abc-123/participants/12345باشد، شناسه برای API People12345است.READ_SOURCE_TYPE_PROFILE،READ_SOURCE_TYPE_CONTACTوREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceTypeوارد کنید. این کار تضمین میکند که هم کاربران داخلی سازمان Google Workspace و هم مخاطبین خارجی در پاسخ گنجانده شدهاند.
نمونه کد زیر نحوه جستجوی پروفایلهای سازمانی و مخاطبین یک شخص را نشان میدهد:
حلقه
curl \
'https://people.googleapis.com/v1/people/PERSON_ID?personFields=names%2CemailAddresses&sources=READ_SOURCE_TYPE_OTHER_CONTACT&sources=READ_SOURCE_TYPE_PROFILE&sources=READ_SOURCE_TYPE_CONTACT' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
موارد زیر را جایگزین کنید:
- PERSON_ID : شناسهی شخصی که قرار است پیدا شود.
- ACCESS_TOKEN : توکن دسترسی که دسترسی به چندین API را اعطا میکند.
جلسات شرکت کنندگان
بخشهای بعدی نحوهی دریافت اطلاعات مربوط به جلسات شرکتکنندگان یک شرکتکننده در یک رکورد کنفرانس را شرح میدهند.
جزئیات مربوط به جلسه شرکتکننده را دریافت کنید
برای دریافت جزئیات مربوط به یک جلسهی خاص از شرکتکنندگان، از متد get() در منبع participantSessions به همراه پارامتر name path استفاده کنید. اگر نام جلسهی شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() تمام جلسات شرکتکنندهی یک شرکتکننده را فهرست کنید .
این متد نام یک شرکتکننده را به عنوان نمونهای از منبع participantSessions برمیگرداند.
نمونه کد زیر نحوه بازیابی یک جلسه خاص از شرکتکنندگان را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه جلسه شرکتکننده خاص در یک جلسه شرکتکننده جایگزین کنید.
فهرست تمام جلسات شرکتکنندگان
برای فهرست کردن جزئیات مربوط به تمام جلسات یک شرکتکننده در یک رکورد کنفرانس، از متد list() در منبع participantSessions به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord}/participants/{participant} .
این متد لیستی از جلسات شرکتکنندگان را که بر اساس startTime و به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participantSession برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به بخش سفارشیسازی صفحهبندی یا فیلتر کردن لیست جلسات شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن تمام جلسات شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام جلسات شرکتکنندهی یک شرکتکننده در یک رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست جلسات شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی اختیاری زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن جلسات شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد جلسات شرکتکنندگان برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ جلسه شرکتکنندگان برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
startTimeیاendTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن خارج شدهاند، استفاده کنید. هر دو فیلد از قالب Timestamp در RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
startTime < 2023-10-01T15:01:23Z -
endTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام جلسات شرکتکنندگان فعال در رکورد کنفرانس،
endTime IS NULLاستفاده کنید.-
این راهنما توضیح میدهد که چگونه با استفاده از API REST گوگل میت، جزئیات مربوط به شرکتکنندگانی که در کنفرانسهای قبلی شرکت کردهاند یا در یک کنفرانس فعال هستند را به همراه اطلاعات جلسه آنها دریافت کنید.
شرکتکننده شخصی است که به یک تماس پیوسته یا از حالت همراهی استفاده میکند، به عنوان بیننده تماشا میکند، یا یک دستگاه اتاق است که به یک تماس متصل است. برای هر فرد یک منبع participants وجود دارد.
یک جلسه شرکتکننده، یک شناسه جلسه منحصر به فرد است که برای هر جفت شرکتکننده-دستگاه که به یک تماس میپیوندد، ایجاد میشود. برای هر جلسه یک منبع participantSessions وجود دارد. اگر شرکتکننده چندین بار از یک جفت شرکتکننده-دستگاه به یک تماس بپیوندد، به هر یک از آنها شناسههای جلسه منحصر به فردی اختصاص داده میشود.
اگر شما مالک یا شرکتکنندهی فضای جلسه هستید، میتوانید متدهای get() و list() را هم در منابع participants و هم در منابع participantSessions فراخوانی کنید تا رکوردهای شرکتکننده را بازیابی کنید.
احراز هویت و مجوزدهی با استفاده از اعتبارنامههای کاربر به برنامههای Google Meet اجازه میدهد تا به دادههای کاربر دسترسی پیدا کرده و عملیات را از طرف کاربر احراز هویتشده انجام دهند. احراز هویت با واگذاری اختیارات در سطح دامنه به شما امکان میدهد تا حساب سرویس یک برنامه را برای دسترسی به دادههای کاربران خود بدون نیاز به رضایت هر کاربر، مجاز کنید.
شرکتکنندگان
بخشهای بعدی نحوهی دریافت اطلاعات شرکتکنندگان در یک رکورد کنفرانس را شرح میدهند.
منبع participants با فیلد user ادغام میشود. یک user میتواند فقط یکی از اشیاء زیر باشد:
یک
signedinUserیکی از موارد زیر است:فردی که از طریق رایانه شخصی، دستگاه تلفن همراه یا از طریق حالت همراه (Companion mode) به سیستم متصل میشود.
یک حساب کاربری ربات که توسط دستگاههای اتاق کنفرانس استفاده میشود.
کاربر
anonymousUserکاربری ناشناس است که به حساب گوگل خود وارد نشده است.phoneUserکاربری است که از تلفنی که هویتش ناشناخته است تماس میگیرد زیرا با حساب گوگل وارد نشده است.
توجه داشته باشید که اگرچه هر سه شیء یک displayName برمیگردانند، signedinUser همچنین یک شناسه user منحصر به فرد را برمیگرداند که با Admin SDK API و People API قابل تعامل است. فرمت: users/{user} . برای اطلاعات بیشتر در مورد استفاده از شناسه user با People API، به بخش بازیابی جزئیات شرکتکننده با People API مراجعه کنید.
دریافت جزئیات مربوط به یک شرکتکننده
برای دریافت جزئیات مربوط به یک شرکتکننده خاص، از متد get() روی منبع participants به همراه پارامتر name path استفاده کنید. اگر نام شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() نام تمام شرکتکنندگان را لیست کنید .
این متد، دادههای یک شرکتکننده را به عنوان نمونهای از منبع participants برمیگرداند.
نمونه کد زیر نحوه بازیابی یک شرکتکننده خاص را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه شرکتکننده خاص در یک رکورد کنفرانس جایگزین کنید.
فهرست همه شرکتکنندگان
برای فهرست کردن جزئیات مربوط به همه شرکتکنندگان در یک رکورد کنفرانس، از متد list() روی منبع participants به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord} .
این متد لیستی از شرکتکنندگان کنفرانس را که بر اساس earliestStartTime به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participants برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به سفارشیسازی صفحهبندی یا فیلتر کردن لیست شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن همه شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد شرکتکنندگان برای بازگشت. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ شرکتکننده برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
earliestStartTimeیاlatestEndTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن عضو شدهاند استفاده کنید. هر دو فیلد از قالب Timestamp در RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
earliestStartTime < 2023-10-01T15:01:23Z -
latestEndTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام شرکتکنندگان فعال در یک کنفرانس موجود،
latestEndTime IS NULLاستفاده کنید.-
جزئیات شرکتکنندگان را با People API بازیابی کنید
برای بازیابی جزئیات مربوط به یک شرکتکننده، از متد get() روی منبع people در People API استفاده کنید.
شناسه شخص را از منبع
participantبا استفاده از مؤلفه انتهایی مسیر استخراج کنید. برای مثال، اگر مقدار منبعparticipantconferenceRecords/abc-123/participants/12345باشد، شناسه برای API People12345است.READ_SOURCE_TYPE_PROFILE،READ_SOURCE_TYPE_CONTACTوREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceTypeوارد کنید. این کار تضمین میکند که هم کاربران داخلی سازمان Google Workspace و هم مخاطبین خارجی در پاسخ گنجانده شدهاند.
نمونه کد زیر نحوه جستجوی پروفایلهای سازمانی و مخاطبین یک شخص را نشان میدهد:
حلقه
curl \
'https://people.googleapis.com/v1/people/PERSON_ID?personFields=names%2CemailAddresses&sources=READ_SOURCE_TYPE_OTHER_CONTACT&sources=READ_SOURCE_TYPE_PROFILE&sources=READ_SOURCE_TYPE_CONTACT' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
موارد زیر را جایگزین کنید:
- PERSON_ID : شناسهی شخصی که قرار است پیدا شود.
- ACCESS_TOKEN : توکن دسترسی که دسترسی به چندین API را اعطا میکند.
جلسات شرکت کنندگان
بخشهای بعدی نحوهی دریافت اطلاعات مربوط به جلسات شرکتکنندگان یک شرکتکننده در یک رکورد کنفرانس را شرح میدهند.
جزئیات مربوط به جلسه شرکتکننده را دریافت کنید
برای دریافت جزئیات مربوط به یک جلسهی خاص از شرکتکنندگان، از متد get() در منبع participantSessions به همراه پارامتر name path استفاده کنید. اگر نام جلسهی شرکتکننده را نمیدانید، میتوانید با استفاده از متد list() تمام جلسات شرکتکنندهی یک شرکتکننده را فهرست کنید .
این متد نام یک شرکتکننده را به عنوان نمونهای از منبع participantSessions برمیگرداند.
نمونه کد زیر نحوه بازیابی یک جلسه خاص از شرکتکنندگان را نشان میدهد:
جاوا
نود جی اس
پایتون
نام شرکتکننده را با نام شناسه جلسه شرکتکننده خاص در یک جلسه شرکتکننده جایگزین کنید.
فهرست تمام جلسات شرکتکنندگان
برای فهرست کردن جزئیات مربوط به تمام جلسات یک شرکتکننده در یک رکورد کنفرانس، از متد list() در منبع participantSessions به همراه پارامتر مسیر parent استفاده کنید. فرمت: conferenceRecords/{conferenceRecord}/participants/{participant} .
این متد لیستی از جلسات شرکتکنندگان را که بر اساس startTime و به صورت نزولی مرتب شدهاند، به عنوان نمونهای از منبع participantSession برمیگرداند. برای تنظیم اندازه صفحه و فیلتر کردن نتایج پرس و جو، به بخش سفارشیسازی صفحهبندی یا فیلتر کردن لیست جلسات شرکتکنندگان مراجعه کنید.
نمونه کد زیر نحوه فهرست کردن تمام جلسات شرکتکنندگان در یک رکورد کنفرانس را نشان میدهد:
جاوا
نود جی اس
پایتون
مقدار والد را با نام جلسات شرکتکنندهی یک شرکتکننده در یک رکورد کنفرانس جایگزین کنید.
صفحهبندی را سفارشی کنید یا لیست جلسات شرکتکنندگان را فیلتر کنید
پارامترهای پرس و جوی اختیاری زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن جلسات شرکتکنندگان ارسال کنید:
pageSize: حداکثر تعداد جلسات شرکتکنندگان برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ جلسه شرکتکنندگان برگردانده میشود. حداکثر مقدار ۲۵۰ است؛ مقادیر بیش از ۲۵۰ به طور خودکار به ۲۵۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی لیست قبلی دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.filter: اختیاری. یک فیلتر پرسوجو برای بازیابی موارد خاص در نتایج منابعparticipants.شما میتوانید از فیلدهای
startTimeیاendTimeبرای فیلتر کردن کاربرانی که قبل از زمان مشخصی عضو شدهاند یا بعد از آن خارج شدهاند، استفاده کنید. هر دو فیلد از قالب Timestamp در RFC 3339 UTC "Zulu" با وضوح نانوثانیه و حداکثر نه رقم کسری استفاده میکنند:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. برای مثال:-
startTime < 2023-10-01T15:01:23Z -
endTime < 2023-10-01T15:01:23Z
برای فهرست کردن تمام جلسات شرکتکنندگان فعال در رکورد کنفرانس،
endTime IS NULLاستفاده کنید.-