این راهنما نحوه ایجاد، دریافت و بهروزرسانی یک فضای جلسه و همچنین پایان دادن به یک کنفرانس فعال در منبع spaces API REST گوگل میت را توضیح میدهد.
ایجاد فضای جلسه
برای ایجاد یک فضای جلسه ، از متد create روی منبع spaces استفاده کنید.
این متد نمونهای از منبع spaces را برمیگرداند که شامل شیء SpaceConfig است که پیکربندی فضای جلسه است. همچنین شامل شیء ActiveConference است که پیوندی به منبع conferenceRecords فعلی در فضای جلسه است.
نمونه کد زیر نحوه ایجاد یک فضای جلسه را نشان میدهد:
جاوا
نود جی اس
پایتون
اسکریپت برنامهها
function createMeetingSpace() {
const response = UrlFetchApp.fetch(
'https://meet.googleapis.com/v2/spaces',
{
method: 'post',
contentType: 'application/json',
headers: {
Authorization: 'Bearer ' + ScriptApp.getOAuthToken(),
},
payload: JSON.stringify({}),
}
);
const space = JSON.parse(response.getContentText());
Logger.log('Space name: ' + space.name);
Logger.log('Meeting URI: ' + space.meetingUri);
return space;
}
حلقه
curl -X POST "https://meet.googleapis.com/v2/spaces" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
ACCESS_TOKEN با توکن دسترسی که دسترسی به API را اعطا میکند، جایگزین کنید.
یک فضای جلسه دریافت کنید
برای دریافت جزئیات مربوط به یک فضای جلسه فعال و تنظیمات آن، از متد get در منبع spaces استفاده کنید. پارامتر name path را با استفاده از فرمت spaces/{space} یا spaces/{meetingCode} تنظیم کنید. برای اطلاعات بیشتر، به نحوه شناسایی یک فضای جلسه توسط Meet مراجعه کنید.
این متد یک فضای جلسه را به عنوان نمونهای از منبع spaces برمیگرداند. برای تعیین اینکه آیا یک کنفرانس فعال وجود دارد، فیلد activeConference را بررسی کنید.
نمونه کد زیر نحوه بازیابی فضای جلسه را نشان میدهد:
جاوا
نود جی اس
پایتون
اسکریپت برنامهها
function getMeetingSpace(spaceName) {
// spaceName format: "spaces/{space}" or "spaces/{meetingCode}"
const response = UrlFetchApp.fetch(
`https://meet.googleapis.com/v2/${spaceName}`,
{
method: 'get',
headers: {
Authorization: 'Bearer ' + ScriptApp.getOAuthToken(),
},
}
);
const space = JSON.parse(response.getContentText());
Logger.log('Space name: ' + space.name);
Logger.log('Meeting URI: ' + space.meetingUri);
if (space.activeConference) {
Logger.log('Active conference: ' +
space.activeConference.conferenceRecord);
}
return space;
}
حلقه
curl -X GET "https://meet.googleapis.com/v2/spaces/SPACE_NAME" \
-H "Authorization: Bearer ACCESS_TOKEN"
ACCESS_TOKEN با توکن دسترسی که دسترسی به API را اعطا میکند، جایگزین کنید.
مقدار نام فضا را با شناسه منحصر به فرد تولید شده توسط سرور برای فضای جلسه جایگزین کنید.
بهروزرسانی فضای جلسه
برای بهروزرسانی جزئیات یک فضای جلسه، از متد patch روی منبع spaces استفاده کنید. پارامتر مسیر space.name را با استفاده از فرمت spaces/{space} تنظیم کنید. برای اطلاعات بیشتر، به نحوه شناسایی یک فضای جلسه توسط Meet مراجعه کنید.
متد patch همچنین یک پارامتر کوئری اختیاری updateMask میگیرد. این فیلد از نوع FieldMask است. این یک لیست جدا شده با کاما از فیلدهایی است که میخواهید در فضای خالی بهروزرسانی کنید.
این متد یک فضای جلسه را به عنوان نمونهای از منبع spaces برمیگرداند.
نمونه کد زیر نحوه بهروزرسانی یک فضای جلسه را نشان میدهد:
جاوا
نود جی اس
پایتون
اسکریپت برنامهها
function updateMeetingSpace(spaceName) {
// spaceName format: "spaces/{space}"
const baseUrl = 'https://meet.googleapis.com/v2/';
const mask = 'updateMask=config.accessType';
const url = `${baseUrl}${spaceName}?${mask}`;
const response = UrlFetchApp.fetch(url, {
method: 'patch',
contentType: 'application/json',
headers: {
Authorization: 'Bearer ' + ScriptApp.getOAuthToken(),
},
payload: JSON.stringify({
config: {
accessType: 'RESTRICTED',
},
}),
});
const space = JSON.parse(response.getContentText());
Logger.log('Updated space: ' + space.name);
return space;
}
حلقه
curl -X PATCH "https://meet.googleapis.com/v2/spaces/SPACE_NAME?updateMask=config.accessType" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"config": {
"accessType": "RESTRICTED"
}
}'
ACCESS_TOKEN با توکن دسترسی که دسترسی به API را اعطا میکند، جایگزین کنید.
مقدار نام فضا را با شناسه منحصر به فرد تولید شده توسط سرور برای فضای جلسه جایگزین کنید.
پایان دادن به یک کنفرانس فعال
برای پایان دادن به یک کنفرانس فعال در یک فضای جلسه (در صورت وجود)، از متد endActiveConference در منبع spaces استفاده کنید. پارامتر name path را با استفاده از فرمت spaces/{space} تنظیم کنید. بدنه درخواست و پاسخ هر دو خالی هستند. برای اطلاعات بیشتر، به نحوه شناسایی یک فضای جلسه توسط Meet مراجعه کنید.
نمونه کد زیر نحوه پایان دادن به یک کنفرانس فعال را نشان میدهد:
جاوا
نود جی اس
پایتون
اسکریپت برنامهها
function endActiveConference(spaceName) {
// spaceName format: "spaces/{space}"
const url =
`https://meet.googleapis.com/v2/${spaceName}:endActiveConference`;
UrlFetchApp.fetch(url, {
method: 'post',
contentType: 'application/json',
headers: {
Authorization: 'Bearer ' + ScriptApp.getOAuthToken(),
},
payload: JSON.stringify({}),
});
Logger.log(`Ended active conference in ${spaceName}`);
}
حلقه
curl -X POST "https://meet.googleapis.com/v2/spaces/SPACE_NAME:endActiveConference" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
ACCESS_TOKEN با توکن دسترسی که دسترسی به API را اعطا میکند، جایگزین کنید.
مقدار نام فضا را با شناسه منحصر به فرد تولید شده توسط سرور برای فضای جلسه جایگزین کنید.
مباحث مرتبط
- نمای کلی فضاهای جلسه گوگل میت
- تنظیمات فضای جلسه را پیکربندی کنید
- مدیریت اعضای فضای جلسه
- با کنفرانسها کار کنید