التشغيل السريع لـ Java

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

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

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

لتشغيل دليل البدء السريع هذا، ستحتاج إلى ما يلي:

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

أنشِئ مشروعًا في Cloud Console أو اختَر مشروعًا حاليًا. أكمِل المهام التالية في Cloud Console لمشروعك:

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

  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 API، مكان ظهور المتغيّرَين على الصفحة.

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

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

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

  1. افتح مستندات طريقة channels.list في واجهة برمجة التطبيقات.

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

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

    صورة تحدّد موضع رابط رمز التعليمات البرمجية في الجدول الذي يسرد حالات استخدام مستندات channels.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 بدلاً من استرداد معلومات عن قناة GoogleDevelopers على YouTube. يتطلّب هذا الطلب تفويض المستخدم.

  1. ارجِع إلى مستندات طريقة channels.list في واجهة برمجة التطبيقات.

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

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

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

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

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

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

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

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

    gradle -q run

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

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

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

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

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

محتوى إضافي للقراءة