تكون طرق واجهات برمجة التطبيقات في برامج استخدام المنتج قبل إطلاقه أو برامج المعاينة الخاصة خاصة، ما يعني أنّ بحيث لا يتم الكشف عنها في مكتبات العملاء القياسية وقد لا يتم قابلة للوصول إليها بشكل افتراضي عبر HTTP. توضّح هذه الصفحة كيفية الوصول إلى هذه ومعاينة البيانات.
يناقش هذا المستند أربعة خيارات لاستخدام واجهة برمجة تطبيقات المعاينة:
- مكتبات العملاء الثابتة التي توفّرها Google
- مكتبات العملاء التي تم إنشاؤها ديناميكيًا
- طلبات HTTP المباشرة
- مكتبة البرامج المخصّصة الخاصة بك
استخدام المكتبات الثابتة أو التي تم إنشاؤها ديناميكيًا والتي توفرها Google والطريقة الموصى بها لاستخدام واجهة برمجة التطبيقات.
المكتبات الثابتة
يجب إنشاء مكتبات البرامج باللغات مثل Java وNode.js وPHP وC# من المصدر. تتوفّر هذه المكتبات في عمليات تنزيل مكتبات البرامج. وأن تحتوي على طرق المعاينة بالفعل.
قد تحتاج إلى تعديل تكوين التبعيات النموذجية لاستخدام هذه المكتبات المحلية بدلاً من استيراد مكتبات العملاء القياسية، والتي لا تحتوي على طرق المعاينة.
على سبيل المثال، إذا كنت تستخدم 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-addons": "file:./googleapis-classroom-1.0.4.tgz"
}
}
بعد ذلك، يمكنك في تطبيقك أن تطلب استخدام وحدة classroom-with-addons بالإضافة إلى ذلك.
إلى الموارد التابعة العادية، وإنشاء مثيل لخدمة classroom من ذلك
الوحدة:
const {authenticate} = require('@google-cloud/local-auth');
const {google} = require('googleapis');
const classroomWithAddons = require('classroom-with-addons');
...
const classroom = classroomWithAddons.classroom({
version: 'v1',
auth: auth,
});
...
المكتبات الديناميكية
تنشئ المكتبات بلغات مثل بايثون مكتبة البرامج في وقت التشغيل باستخدام مستند استكشاف من خدمة Discovery
مستند Discovery هو مواصفات يمكن للآلة قراءتها لوصف استهلاك واجهات برمجة تطبيقات REST. يتمّ استخدامها لإنشاء مكتبات برامج والمكوّنات الإضافية لـ IDE الأدوات الأخرى التي تتفاعل مع Google APIs. قد تقدم خدمة واحدة عدة خدمات مستندات Discovery.
المستندات أثناء الرصد لخدمة Classroom API
(classroom.googleapis.com) يمكن العثور عليها عند نقطة النهاية التالية:
- https://classroom.googleapis.com/$Discover/rest?labels=<PREVIEW_LABEL>&version=v1&key=<PREVIEW_LABEL>
لإنشاء مكتبة بايثون وإنشاء مثيل لخدمة Classroom باستخدام يمكنك تحديد عنوان URL لـ Discovery باستخدام الخدمة المناسبة، وبيانات الاعتماد والتصنيف:
classroom_service_with_rubrics = googleapiclient.discovery.build(
serviceName="classroom",
version="v1",
credentials=credentials,
static_discovery=False,
discoveryServiceUrl=f"https://classroom.googleapis.com/$discovery/rest?labels=ADD_ONS_ALPHA&key=ABCXYZ")
اطّلِع على مستندات مكتبة برامج Google API الفردية للحصول على تفاصيل حول كل منها.
. يتمثل الاختلاف المهم للعمل باستخدام واجهات برمجة تطبيقات المعاينة في تحديد
label المناسبة. في هذه المعاينة، هذا التصنيف هو ADD_ONS_ALPHA.
طلبات HTTP
في حال إرسال طلبات HTTP بدون مكتبة برامج، تأكَّد من تضمين التصنيف
(ADD_ONS_ALPHA) كرأس X-Goog-Visibilities.
على سبيل المثال، لعرض جميع المرفقات التي تم إنشاؤها بواسطة إضافة ضمن مشاركة، استخدم طلب curl التالي:
curl \
'https://classroom.googleapis.com/v1/courses/[courseId]/courseWork/[itemId]/addOnAttachments?key=[YOUR_API_KEY]' \
--header 'X-Goog-Visibilities: ADD_ONS_ALPHA' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressedيتم توضيح واجهة برمجة التطبيقات لكل طلب HTTP في وثائق REST.
مكتبات العملاء المخصصة
راجع إنشاء مكتبات العملاء إذا كنت بحاجة إلى إنشاء مكتبتك الخاصة. قيد الإنشاء مكتبتك الخاصة خارج نطاق هذا الدليل، ولكن يجب عليك مراجعة قسم المكتبات الديناميكية للتعرّف على تصنيفات المعاينة ودورها في الاستكشاف: