Java Quickstart

يوضح دليل البدء السريع هذا كيفية إعداد تطبيق سطر أوامر Java بسيط يقدم طلبات إلى YouTube Data API. يشرح هذا التشغيل السريع بسرعة كيفية إجراء طلبي واجهة برمجة التطبيقات:

  1. وستستخدم مفتاح واجهة برمجة التطبيقات الذي يحدد تطبيقك، لاسترداد معلومات حول قناة مطوري برامج Google على YouTube.
  2. عليك استخدام معرّف عميل OAuth 2.0 لإرسال طلب مفوّض باسترداد معلومات حول قناتك على YouTube.

المتطلبات الأساسية

لتنفيذ هذا التشغيل السريع، ستحتاج إلى:

  • الإصدار 1.7 أو الإصدارات الأحدث من جافا.
  • Gradle 2.3 أو إصدار أحدث.
  • الدخول إلى الإنترنت ومتصفح الويب.
  • حساب Google.

الخطوة 1: إعداد مشروعك وبيانات الاعتماد

أنشئ مشروعًا أو حدّده في وحدة تحكم واجهة برمجة التطبيقات. أكمِل المهام التالية في وحدة تحكم واجهة برمجة التطبيقات لمشروعك:

  1. في لوحة المكتبة، ابحث عن الإصدار الثالث من YouTube Data API. انقر على قائمة واجهة برمجة التطبيقات هذه وتأكد من تمكين واجهة برمجة التطبيقات لمشروعك.

  2. في لوحة بيانات الاعتماد، أنشئ بيانات اعتماد:

    1. إنشاء مفتاح واجهة برمجة تطبيقات ستستخدم مفتاح واجهة برمجة التطبيقات لإجراء طلبات البيانات من واجهة برمجة التطبيقات التي لا تتطلب تفويض المستخدم. على سبيل المثال، لا تحتاج إلى تفويض المستخدم لاسترداد معلومات حول قناة YouTube عامة.

    2. إنشاء معرِّف عميل OAuth 2.0 اضبط نوع التطبيق على غير ذلك. تحتاج إلى استخدام بيانات اعتماد OAuth 2.0 للطلبات التي تتطلب تفويض المستخدم. على سبيل المثال، تحتاج إلى تفويض المستخدم لاسترداد معلومات حول قناة المستخدم التي تمت مصادقتها حاليًا على YouTube.

      نزِّل ملف JSON الذي يحتوي على بيانات اعتماد OAuth 2.0. يحتوي الملف على اسم مثل client_secret_CLIENTID.json، حيث CLIENTID هو معرّف العميل لمشروعك.

الخطوة 2: إعداد المشروع

أكمِل الخطوات التالية لإعداد مشروع Gradle:

  1. في دليل العمل، شغّل الأوامر التالية لإنشاء بنية مشروع جديدة:

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  2. انقل ملف JSON الذي نزّلته بعد إنشاء معرّف عميل OAuth 2.0 إلى دليل src/main/resources أسفل دليل العمل، وأعد تسمية الملف إلى client_secret.json.

  3. افتح الملف build.gradle في دليل العمل واستبدل محتوياته بما يلي:

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    compile 'com.google.apis:google-api-services-youtube:v3-revREVISION-CL_VERSION'
}

  4. في الملف build.gradle، يجب استبدال المتغيّرَين REVISION وCL_VERSION بقيمتَين من وثائق مكتبة العميل في YouTube Data API. توضح لقطة الشاشة أدناه، التي تعرض وثائق واجهة برمجة تطبيقات YouTube Analytics، مكان ظهور المتغيرين على الصفحة.

    لقطة شاشة لمرجع JavaDoc يوضح كيفية العثور على قيم لمتغير "REVISION" و"CL_VERSION"

الخطوة 3: إعداد النموذج وتشغيله

استخدم أداة مستكشف واجهات برمجة التطبيقات في اللوحة الجانبية للحصول على نموذج لشفرة لاسترداد معلومات حول قناة GoogleDevelopers على YouTube. يستخدم هذا الطلب مفتاح واجهة برمجة تطبيقات لتعريف تطبيقك، ولا يتطلب إذنًا من المستخدم أو أي أذونات خاصة من المستخدم الذي يشغّل النموذج.

  1. افتح وثائق طريقة channels.list لواجهة برمجة التطبيقات.

  2. وفي تلك الصفحة، يحتوي قسم "حالات الاستخدام الشائعة" على جدول يوضح عدة طرق شائعة لاستخدام هذه الطريقة. أول قائمة بيانات في الجدول هي لعرض النتائج بحسب معرّف القناة.

    انقر على رمز الرمز للقائمة الأولى لفتح وملء مستكشف واجهات برمجة التطبيقات بملء الشاشة.

    صورة تحدد موقع رابط رمز الرمز في الجدول الذي يدرج حالات الاستخدام لوثائق channel.list. يحدد النص البديل لهذه الصورة الصورة كرمز شفرة ويحدد حالة الاستخدام المقترنة بذلك الرابط.

  3. يعرض الجانب الأيمن من مستكشف واجهات برمجة التطبيقات في وضع ملء الشاشة ما يلي:

    1. أسفل العنوان معلمات الطلب، توجد قائمة بالمعلمات التي تتوافق معها هذه الطريقة. يجب تعيين قيم المعلمات part وid. إن قيمة المعلمة id، UC_x5XG1OV2P6uZZ5FSM9Ttw، هي معرف قناة GoogleDevelopers على YouTube.

    2. أسفل المعلّمات، يتوفّر قسم بعنوان بيانات الاعتماد. يجب أن تعرض القائمة المنسدلة في هذا القسم القيمة مفتاح واجهة برمجة التطبيقات. يستخدم مستكشف واجهات برمجة التطبيقات بيانات الاعتماد التجريبية بشكل افتراضي لتسهيل عملية البدء. ولكن ستستخدم مفتاح واجهة برمجة التطبيقات الخاص بك لتشغيل النموذج محليًا.

      صورة تعرض "بيانات الاعتماد" في مستكشف واجهات برمجة التطبيقات بملء الشاشة والقائمة المنسدلة مع تحديد خيار "مفتاح واجهة برمجة التطبيقات".

  4. يعرض الجانب الأيسر من مستكشف واجهات برمجة التطبيقات في وضع ملء الشاشة علامات تبويب بها نماذج شفرات في لغات مختلفة. اختَر علامة التبويب Java.

  5. انسخ نموذج الرمز واحفظه في ملف باسم src/main/java/ApiExample.java. يستخدم كل نموذج اسم الفئة نفسه (ApiExample) حتى لا تحتاج إلى تعديل ملف build.gradle لتشغيل نماذج مختلفة.

  6. في النموذج الذي نزّلته، ابحث عن سلسلة YOUR_API_KEY واستبدلها بمفتاح واجهة برمجة التطبيقات الذي أنشأته في الخطوة 1 من قائمة البدء السريع هذه.

  7. شغّل النموذج من سطر الأوامر. في دليل العمل، يمكنك تشغيل:

    gradle -q run

  8. يجب أن ينفذ النموذج الطلب ويطبع الرد على STDOUT.

الخطوة 4: تنفيذ طلب مصرّح به

في هذه الخطوة، ستعدّل نموذج الشفرة بحيث تسترد معلومات حول قناتك على YouTube بدلاً من جلب معلومات حول قناة Google Developers على YouTube. ويتطلب هذا الطلب تفويض المستخدم.

  1. ارجع إلى وثائق طريقة channels.list لواجهة برمجة التطبيقات.

  2. في القسم "حالات الاستخدام الشائعة"، انقر على رمز الرمز لبطاقة البيانات الثالثة في الجدول. حالة الاستخدام هذه هي استدعاء طريقة list لـ "قناتي".

  3. مرة أخرى، في الجانب الأيمن من مستكشف واجهات برمجة التطبيقات في وضع ملء الشاشة، سترى قائمة من المعلمات متبوعة بقسم بيانات الاعتماد. ومع ذلك، فهناك تغييران من المثال الذي استرددت من خلاله المعلومات حول قناة GoogleDevelopers:

    1. في قسم المعلّمات، بدلاً من ضبط قيمة المعلَمة id، يجب ضبط قيمة المعلَمة mine على true. يؤدي ذلك إلى توجيه خادم واجهة برمجة التطبيقات لاسترداد معلومات حول قناة المستخدم الذي تمت مصادقته حاليًا.

    2. في قسم بيانات الاعتماد، يجب أن تحدد القائمة المنسدلة خيار Google OAuth 2.0.

      بالإضافة إلى ذلك، إذا نقرت على الرابط عرض النطاقات، يجب التحقق من النطاق https://www.googleapis.com/auth/youtube.readonly.

      صورة تعرض النطاقات في مستكشف واجهات برمجة التطبيقات في وضع ملء الشاشة وخيار استخدام بيانات اعتماد "Google OAuth 2.0".

  4. كما في المثال السابق، حدد علامة التبويب Java، وانسخ نموذج الشفرة، واحفظه في src/main/java/ApiExample.java.

  5. شغّل النموذج من سطر الأوامر. في دليل العمل، يمكنك تشغيل:

    gradle -q run

  6. يجب أن يحاول النموذج فتح نافذة أو علامة تبويب جديدة في المتصفح الافتراضي. إذا أخفق ذلك، انسخ عنوان URL من الوحدة الطرفية وافتحه يدويًا في المتصفح.

    إذا لم تكن قد سجلت الدخول فعلاً إلى حسابك في Google، فستتم مطالبتك بتسجيل الدخول. إذا سجلت الدخول إلى حسابات متعددة في Google، فسيُطلب منك تحديد حساب واحد لاستخدامه للتفويض.

  7. انقر على الزر لمنح تطبيقك إمكانية الوصول إلى النطاقات المحددة في نموذج الشفرة.

  8. ستتم متابعة النموذج تلقائيًا، ويمكنك إغلاق علامة تبويب المتصفح المستخدمة في تدفق المصادقة.

    يجب طباعة استجابة واجهة برمجة التطبيقات مرة أخرى إلى STDOUT.

قراءات إضافية