دسترسی به API های پیش نمایش

این صفحه نحوه دسترسی به ویژگی‌های پیش‌نمایش API Classroom و تعیین نسخه‌های پیش‌نمایش را توضیح می‌دهد.

سه نکته در هنگام استفاده از ویژگی های پیش نمایش در مقایسه با API پایدار v1 عبارتند از:

1. پروژه فراخوانی Google Cloud باید در برنامه پیش‌نمایش برنامه‌نویس Google Workspace ثبت‌شده باشد و توسط Google فهرست شود.
2. ویژگی‌های API در برنامه‌های دسترسی اولیه یا پیش‌نمایش در کتابخانه‌های سرویس گیرنده استاندارد نمایش داده نمی‌شوند و ممکن است به‌طور پیش‌فرض از طریق HTTP در دسترس نباشند.
3. در هر زمان ممکن است چندین حالت یا نسخه API در پیش نمایش وجود داشته باشد.

ویژگی های پیش نمایش را در کتابخانه های سرویس گیرنده فعال کنید

یک گزینه رایج برای مصرف API Classroom با کتابخانه مشتری است. سه نوع کتابخانه مشتری وجود دارد:

1. کتابخانه های مشتری ایجاد شده به صورت پویا
2. کتابخانه های مشتری ثابت ارائه شده توسط Google
3. کتابخانه مشتری سفارشی شما

استفاده از کتابخانه های ایستا که به صورت پویا تولید شده یا ارائه شده توسط Google، روش توصیه شده برای استفاده از API است. اگر نیاز به ساخت کتابخانه خود دارید ، به ساخت کتابخانه های مشتری مراجعه کنید. ایجاد کتابخانه خود خارج از محدوده این راهنما است، اما باید بخش کتابخانه‌های پویا را مرور کنید تا با برچسب‌های پیش‌نمایش و نقش آن‌ها در Discovery آشنا شوید.

کتابخانه های پویا

کتابخانه‌های زبان‌هایی مانند پایتون، کتابخانه مشتری را در زمان اجرا با استفاده از یک سند کشف از سرویس Discovery تولید می‌کنند.

Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده ، افزونه های IDE و سایر ابزارهایی که با API های Google تعامل دارند، استفاده می شود. یک سرویس ممکن است چندین سند کشف را ارائه دهد.

اسناد کشف برای سرویس API Classroom ( classroom.googleapis.com ) را می‌توانید در نقطه پایانی زیر پیدا کنید:

https://classroom.googleapis.com/$discovery/rest?labels=PREVIEW_LABEL&version=v1&key=API_KEY

تمایز مهم برای کار با API های پیش نمایش، تعیین label مناسب است. برای پیش‌نمایش‌های عمومی Classroom، این برچسب DEVELOPER_PREVIEW است.

برای تولید کتابخانه Python و نمونه سازی سرویس Classroom با روش های پیش نمایش، می توانید URL Discovery را با سرویس، اعتبار و برچسب مناسب مشخص کنید:

classroom_service_with_preview_features = googleapiclient.discovery.build(
  serviceName='classroom',
  version='v1',
  credentials=credentials,
  static_discovery=False,
  discoveryServiceUrl='https://classroom.googleapis.com/$discovery/rest?labels=DEVELOPER_PREVIEW&key=API_KEY)'

برای جزئیات بیشتر در مورد هر زبان، اسناد کتابخانه مشتری Google API را مشاهده کنید.

کتابخانه های استاتیک

کتابخانه های کلاینت در زبان هایی مانند Java، Node.js، PHP، C# و Go باید از منبع ساخته شوند. این کتابخانه ها برای شما ارائه شده اند و دارای ویژگی های پیش نمایش هستند.

برای پیش‌نمایش‌های عمومی، کتابخانه‌های سرویس گیرنده Classroom را می‌توان با سایر کتابخانه‌های سرویس‌گیرنده برنامه پیش‌نمایش برنامه‌نویس Workspace پیدا کرد. برای پیش‌نمایش‌های خصوصی، اگر نیاز به ایجاد کتابخانه‌های ثابت دارید، با مخاطب Google خود تماس بگیرید.

شاید لازم باشد پیکربندی وابستگی‌های معمولی خود را برای استفاده از این کتابخانه‌های محلی به جای وارد کردن کتابخانه‌های مشتری استاندارد، که ویژگی‌های پیش‌نمایش ندارند، تغییر دهید.

به عنوان مثال، برای استفاده از کتابخانه سرویس گیرنده Go، باید از دستور replace در فایل go.mod خود استفاده کنید تا به یک ماژول از یک فهرست محلی نیاز داشته باشید :

module example.com/app

go 1.21.1

require (
    golang.org/x/oauth2 v0.12.0
    google.golang.org/api v0.139.0 // Classroom library is in here.
)

require (
  ...
)

// Use a local copy of the Go client library.
replace google.golang.org/api v0.139.0 => ../google-api-go-client

به عنوان مثال دیگر، اگر از Node.js و npm استفاده می کنید، دانلود کتابخانه مشتری Node.js ( googleapis-classroom-1.0.4.tgz ) را به عنوان یک وابستگی محلی در package.json اضافه کنید:

{
  "name": "nodejs-classroom-example",
  "version": "1.0.0",
  ...
  "dependencies": {
    "@google-cloud/local-auth": "^2.1.0",
    "googleapis": "^95.0.0",
    "classroom-with-preview-features": "file:./googleapis-classroom-1.0.4.tgz"
  }
}

سپس در برنامه خود، علاوه بر وابستگی های معمولی، ماژول classroom-with-preview-features را نیز بخواهید و سرویس classroom را از آن ماژول نمونه سازی کنید:

const {authenticate} = require('@google-cloud/local-auth');
const {google} = require('googleapis');
const classroomWithPreviewFeatures = require('classroom-with-preview-features');

...

const classroom = classroomWithPreviewFeatures.classroom({
  version: 'v1',
  auth: auth,
});

...

یک نسخه API پیش نمایش را مشخص کنید

صرف نظر از اینکه از کتابخانه ایستا یا پویا استفاده می کنید، باید نسخه پیش نمایش را هنگام برقراری فراخوانی API با روش هایی با قابلیت پیش نمایش مشخص کنید.

نسخه‌های مختلف موجود و ویژگی‌هایی که شامل می‌شوند، در نقشه راه Classroom API مستند شده‌اند. اسناد مرجع برای روش‌ها و فیلدها همچنین توضیح می‌دهند که روش یا فیلد در کدام نسخه (های) موجود است.

تعیین یک نسخه با تنظیم فیلد PreviewVersion در درخواست ها انجام می شود. به عنوان مثال، برای ایجاد یک روبریک با Rubrics CRUD preview API، در درخواست CREATE، previewVersion روی V1_20231110_PREVIEW تنظیم کنید:

rubric = service.courses().courseWork().rubrics().create(
            courseId=course_id,
            courseWorkId=coursework_id,
            # Specify the preview version. Rubrics CRUD capabilities are
            # supported in V1_20231110_PREVIEW and later.
            previewVersion="V1_20231110_PREVIEW",
            body=body
).execute()

منابع مرتبط با فراخوانی روش پیش‌نمایش همچنین حاوی previewVersion مورد استفاده در تماس به‌عنوان یک فیلد فقط خواندنی است تا به شما کمک کند بفهمید از کدام نسخه استفاده می‌کنید. به عنوان مثال، پاسخ از تماس قبلی CREATE حاوی مقدار V1_20231110_PREVIEW است:

print(json.dumps(rubric, indent=4))
{
  "courseId": "123",
  "courseWorkId": "456",
  "creationTime": "2023-10-23T18:18:29.932Z",
  "updateTime": "2023-10-23T18:18:29.932Z",
  "id": "789",
  "criteria": [...],
  # The preview version used in the call that returned this resource.
  "previewVersion": "V1_20231110_PREVIEW",
  ...
}

درخواست های HTTP

همچنین امکان مصرف مستقیم API Classroom با HTTP وجود دارد.

اگر درخواست‌های HTTP را بدون کتابخانه مشتری انجام می‌دهید، همچنان باید ویژگی‌های پیش‌نمایش را فعال کنید تا یک نسخه پیش‌نمایش را مشخص کنید. این کار با تنظیم یک label با هدر X-Goog-Visibilities و نسخه پیش نمایش فوق الذکر به عنوان پارامتر پرس و جو یا فیلد بدنه POST انجام می شود (به مستندات مرجع API منفرد مراجعه کنید). برای پیش‌نمایش‌های عمومی، برچسب DEVELOPER_PREVIEW است.

به عنوان مثال، درخواست curl زیر یک تماس LIST با سرویس Rubrics با برچسب دید مناسب و نسخه پیش نمایش برقرار می کند:

curl \
  'https://classroom.googleapis.com/v1/courses/COURSE_ID/courseWork/COURSE_WORK_ID/rubrics?key=API_KEY&previewVersion=V1_20231110_PREVIEW' \
  --header 'X-Goog-Visibilities: DEVELOPER_PREVIEW' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --compressed

همچنین می‌توانید نسخه پیش‌نمایش را در بدنه درخواست مشخص کنید، برای مثال هنگام درخواست POST:

curl --request PATCH \
  'https://classroom.googleapis.com/v1/courses/COURSE_ID/courseWork/COURSE_WORK_ID/rubrics/RUBRIC_ID?updateMask=criteria&key=API_KEY&previewVersion=V1_20231110_PREVIEW' \
  --header 'X-Goog-Visibilities: DEVELOPER_PREVIEW' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"criteria":"[...]"}' \
  --compressed

API برای هر درخواست HTTP در مستندات REST توضیح داده شده است.

اسکریپت Google Apps

امکان فراخوانی APIهای پیش‌نمایش از Google Apps Script وجود دارد. با این حال، چند تفاوت با استفاده معمولی از Apps Script وجود دارد.

1. باید اسکریپت خود را برای استفاده از هر پروژه Google Cloud که در برنامه پیش‌نمایش برنامه‌نویس ثبت‌نام کرده‌اید، پیکربندی کنید.
2. سرویس‌های پیشرفته از روش‌های پیش‌نمایش پشتیبانی نمی‌کنند، بنابراین باید مستقیماً با HTTP درخواست ارسال کنید.
3. همانطور که در بخش HTTP قبلی توضیح داده شد، باید یک برچسب و نسخه پیش نمایش ارائه کنید.

برای آشنایی با Apps Script و راه اندازی یک پروژه اولیه، شروع سریع مربوطه را ببینید. سپس این دستورالعمل ها را دنبال کنید تا شروع به فراخوانی API های پیش نمایش کنید:

پروژه Cloud مورد استفاده اسکریپت را تغییر دهید

در تنظیمات پروژه ، روی تغییر پروژه کلیک کنید و شناسه پروژه Cloud هر پروژه ای را که در برنامه پیش نمایش برنامه نویس ثبت نام کرده اید، وارد کنید (به طور پیش فرض، اسکریپت های Apps Script از یک پروژه عمومی استفاده می کنند). فقط پروژه های ثبت نام شده می توانند روش های پیش نمایش را فراخوانی کنند.

درخواست های HTTP را پیکربندی کنید

در مرحله بعد، درخواست HTTP هر روشی را که می‌خواهید دوباره فراخوانی کنید در ویرایشگر پیکربندی کنید. برای مثال، در شروع سریع ، فهرست دوره‌ها با سرویس Classroom به این شکل است:

function listCourses() {
  try {
    const response = Classroom.Courses.list();
    const courses = response.courses;
    if (!courses || courses.length === 0) {
      console.log('No courses found.');
      return;
    }
    for (const course of courses) {
      console.log('%s (%s)', course.name, course.id);
    }
  } catch (err) {
    // TODO: Developer to handle.
    console.log(err.message);
  }
}

عملیات معادل با استفاده مستقیم از HTTP عبارت است از:

function listCourses() {
  const response = UrlFetchApp.fetch(
        'https://classroom.googleapis.com/v1/courses', {
        method: 'GET',
        headers: {'Authorization': 'Bearer ' + ScriptApp.getOAuthToken()},
        contentType: 'application/json',
      });
  const data = JSON.parse(response.getContentText());
  if (data.error) {
    // TODO: Developer to handle.
    console.log(err.message);
    return;
  }
  if (!data.courses || !data.courses.length) {
    console.log('No courses found.');
    return;
  }
  for (const course of data.courses) {
    console.log('%s (%s)', course.name, course.id);
  }
}

هنگام استفاده از سرویس‌های پیشرفته، محدوده‌های OAuth مورد نیاز استنباط می‌شوند، اما برای برقراری تماس مستقیم HTTP با APIهای Google در Apps Script، باید به صورت دستی دامنه‌های مناسب را اضافه کنید.

در تنظیمات پروژه ، نمایش فایل مانیفست «appsscript.json» در ویرایشگر را فعال کنید. در ویرایشگر ، oauthScopes به فایل appscript.json برای هر دامنه‌ای که نیاز دارید اضافه کنید. دامنه های یک روش معین در صفحه مرجع فهرست شده است. برای مثال، صفحه روش لیست courses.courseWork.rubrics را ببینید.

فایل appscript.json آپدیت شده ممکن است به شکل زیر باشد:

{
  "timeZone": "America/Los_Angeles",
  "dependencies": {
  },
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/classroom.coursework.students",
    "https://www.googleapis.com/auth/classroom.courses",
    "https://www.googleapis.com/auth/spreadsheets.readonly",
    "https://www.googleapis.com/auth/spreadsheets"
  ]
}

یک برچسب و نسخه پیش نمایش ارائه کنید

به اسکریپت خود برگردید، اطمینان حاصل کنید که برچسب و نسخه پیش نمایش مناسب را همانطور که در بخش HTTP قبلی توضیح داده شده اضافه کرده اید. مثال فراخوانی LIST به سرویس Rubrics به شکل زیر است:

function listRubrics() {
  const courseId = COURSE_ID;
  const courseWorkId = COURSE_WORK_ID;
  const response = UrlFetchApp.fetch(
         `https://classroom.googleapis.com/v1/courses/${courseId}/courseWork/${courseWorkId}/rubrics?previewVersion=V1_20231110_PREVIEW`, {
        method: 'GET',
        headers: {
          'Authorization': 'Bearer ' + ScriptApp.getOAuthToken(),
          'X-Goog-Visibilities': 'DEVELOPER_PREVIEW'
        },
        contentType: 'application/json',
        muteHttpExceptions: true
      });
  const data = JSON.parse(response.getContentText());
  console.log(data)
  if (data.error) {
    // TODO: Developer to handle.
    console.log(error.message);
    return;
  }
  if (!data.rubrics || !data.rubrics.length) {
    console.log('No rubrics for this coursework!');
    return;
  }
  console.log(data.rubrics);
}