Java क्विकस्टार्ट

इस क्विकस्टार्ट गाइड में, एक सामान्य Java कमांड-लाइन ऐप्लिकेशन सेट अप करने का तरीका बताया गया है. यह ऐप्लिकेशन, YouTube Data API को अनुरोध भेजता है. इस क्विकस्टार्ट में, दो एपीआई अनुरोध करने का तरीका बताया गया है:

  1. GoogleDevelopers YouTube चैनल के बारे में जानकारी पाने के लिए, आपको एक एपीआई कुंजी का इस्तेमाल करना होगा. इससे आपके ऐप्लिकेशन की पहचान होती है.
  2. आपको OAuth 2.0 क्लाइंट आईडी का इस्तेमाल करके, अनुमति दिया गया अनुरोध सबमिट करना होगा. इससे आपको अपने YouTube चैनल के बारे में जानकारी मिलेगी.

ज़रूरी शर्तें

इस क्विकस्टार्ट को चलाने के लिए, आपको इनकी ज़रूरत होगी:

पहला चरण: अपना प्रोजेक्ट और क्रेडेंशियल सेट अप करना

Cloud Console में कोई प्रोजेक्ट बनाएं या चुनें. अपने प्रोजेक्ट के लिए, Cloud Console में ये टास्क पूरे करें:

  1. लाइब्रेरी पैनल में जाकर, YouTube Data API v3 खोजें. उस एपीआई की लिस्टिंग पर क्लिक करें और पक्का करें कि आपके प्रोजेक्ट के लिए एपीआई चालू हो.

  2. क्रेडेंशियल पैनल में जाकर, दो क्रेडेंशियल बनाएं:

    1. एपीआई पासकोड बनाएं एपीआई पासकोड का इस्तेमाल, ऐसे एपीआई अनुरोध करने के लिए किया जाएगा जिनके लिए उपयोगकर्ता की अनुमति की ज़रूरत नहीं होती. उदाहरण के लिए, किसी सार्वजनिक YouTube चैनल के बारे में जानकारी पाने के लिए, आपको उपयोगकर्ता की अनुमति की ज़रूरत नहीं है.

    2. OAuth 2.0 क्लाइंट आईडी बनाएं ऐप्लिकेशन टाइप को डेस्कटॉप ऐप्लिकेशन पर सेट करें. आपको उन अनुरोधों के लिए OAuth 2.0 क्रेडेंशियल का इस्तेमाल करना होगा जिनके लिए उपयोगकर्ता की अनुमति ज़रूरी है. उदाहरण के लिए, आपको फ़िलहाल पुष्टि किए गए उपयोगकर्ता के YouTube चैनल के बारे में जानकारी पाने के लिए, उपयोगकर्ता की अनुमति चाहिए.

      OAuth 2.0 क्रेडेंशियल वाली JSON फ़ाइल डाउनलोड करें. फ़ाइल का नाम client_secret_CLIENTID.json जैसा होता है. इसमें CLIENTID आपके प्रोजेक्ट का क्लाइंट आईडी होता है.

दूसरा चरण: प्रोजेक्ट तैयार करना

अपने Gradle प्रोजेक्ट को तैयार करने के लिए, यह तरीका अपनाएं:

  1. अपनी वर्किंग डायरेक्ट्री में, नया प्रोजेक्ट स्ट्रक्चर बनाने के लिए ये कमांड चलाएं:

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

  2. OAuth 2.0 क्लाइंट आईडी बनाने के बाद डाउनलोड की गई JSON फ़ाइल को अपनी वर्किंग डायरेक्ट्री के नीचे मौजूद 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' वैरिएबल की वैल्यू ढूंढने का तरीका दिखाया गया है

तीसरा चरण: सैंपल सेट अप करना और उसे चलाना

GoogleDevelopers YouTube चैनल के बारे में जानकारी पाने के लिए, साइड पैनल में मौजूद APIs Explorer विजेट का इस्तेमाल करें. इस अनुरोध में, आपके ऐप्लिकेशन की पहचान करने के लिए एपीआई कुंजी का इस्तेमाल किया जाता है. इसके लिए, उपयोगकर्ता की अनुमति या सैंपल चलाने वाले उपयोगकर्ता से किसी खास अनुमति की ज़रूरत नहीं होती.

  1. एपीआई के channels.list तरीके से जुड़ा दस्तावेज़ खोलें.

  2. उस पेज पर, "इस्तेमाल के सामान्य उदाहरण" सेक्शन में एक टेबल दी गई है. इसमें इस तरीके के इस्तेमाल के कई सामान्य तरीके बताए गए हैं. टेबल में पहली लिस्टिंग, चैनल आईडी के हिसाब से लिस्टिंग के नतीजों के लिए है.

    पहली लिस्टिंग के लिए कोड सिंबल पर क्लिक करें, ताकि फ़ुलस्क्रीन APIs explorer खुल जाए और उसमें जानकारी भर जाए.

    ऐसी इमेज जिसमें कोड सिंबल लिंक की जगह की पहचान की गई हो.यह इमेज, चैनलों की सूची वाले दस्तावेज़ के इस्तेमाल के उदाहरणों की सूची वाली टेबल में मौजूद है. उस इमेज के वैकल्पिक टेक्स्ट से, इमेज की पहचान कोड सिंबल के तौर पर होती है. साथ ही, उस लिंक से जुड़े इस्तेमाल के उदाहरण के बारे में पता चलता है.

  3. फ़ुलस्क्रीन APIs explorer की बाईं ओर यह जानकारी दिखती है:

    1. अनुरोध पैरामीटर हेडर के नीचे, उन पैरामीटर की सूची दी गई है जिन्हें यह तरीका इस्तेमाल कर सकता है. part और id पैरामीटर की वैल्यू सेट होनी चाहिए. id पैरामीटर वैल्यू, UC_x5XG1OV2P6uZZ5FSM9Ttw, GoogleDevelopers YouTube चैनल का आईडी है.

    2. पैरामीटर के नीचे, क्रेडेंशियल नाम का सेक्शन होता है. उस सेक्शन में मौजूद पुलडाउन मेन्यू में, एपीआई पासकोड वैल्यू दिखनी चाहिए. एपीआई एक्सप्लोरर, डिफ़ॉल्ट रूप से डेमो क्रेडेंशियल का इस्तेमाल करता है, ताकि आपको इसे इस्तेमाल करने में आसानी हो. हालांकि, सैंपल को स्थानीय तौर पर चलाने के लिए, आपको अपनी एपीआई कुंजी का इस्तेमाल करना होगा.

      इस इमेज में, फ़ुलस्क्रीन APIs explorer में 'क्रेडेंशियल' और 'एपीआई कुंजी' विकल्प चुना गया पुलडाउन मेन्यू दिखाया गया है.

  4. फ़ुलस्क्रीन APIs explorer की दाईं ओर, अलग-अलग भाषाओं में कोड सैंपल वाले टैब दिखते हैं. Java टैब चुनें.

  5. कोड का सैंपल कॉपी करें और इसे src/main/java/ApiExample.java नाम की फ़ाइल में सेव करें. हर सैंपल में एक ही क्लास का नाम (ApiExample) इस्तेमाल किया जाता है, ताकि अलग-अलग सैंपल चलाने के लिए आपको build.gradle फ़ाइल में बदलाव न करना पड़े.

  6. डाउनलोड किए गए सैंपल में, YOUR_API_KEY स्ट्रिंग ढूंढें और उसे उस एपीआई पासकोड से बदलें जिसे आपने इस क्विकस्टार्ट के पहले चरण में बनाया था.

  7. कमांड लाइन से सैंपल चलाएं. अपनी वर्किंग डायरेक्ट्री में जाकर, यह कमांड चलाएं:

    gradle -q run

  8. सैंपल में अनुरोध को पूरा किया जाना चाहिए और STDOUT में जवाब प्रिंट किया जाना चाहिए.

चौथा चरण: अनुमति वाला अनुरोध चलाना

इस चरण में, आपको अपने कोड सैंपल में बदलाव करना होगा, ताकि वह GoogleDevelopers YouTube चैनल की जानकारी के बजाय, आपके YouTube चैनल की जानकारी को वापस पा सके. इस अनुरोध के लिए, उपयोगकर्ता की अनुमति ज़रूरी है.

  1. एपीआई के channels.list तरीके के दस्तावेज़ पर वापस जाएं.

  2. "सामान्य इस्तेमाल के उदाहरण" सेक्शन में, टेबल में मौजूद तीसरी लिस्टिंग के लिए कोड सिंबल पर क्लिक करें. इस्तेमाल के इस उदाहरण में, "my channel" के लिए list तरीके को कॉल किया गया है.

  3. फ़ुलस्क्रीन APIs explorer की बाईं ओर, आपको पैरामीटर की सूची दिखेगी. इसके बाद, क्रेडेंशियल सेक्शन दिखेगा. हालांकि, उदाहरण में दो बदलाव किए गए हैं. इनमें GoogleDevelopers चैनल के बारे में जानकारी वापस पाई गई है:

    1. पैरामीटर सेक्शन में, id पैरामीटर की वैल्यू सेट करने के बजाय, mine पैरामीटर की वैल्यू true पर सेट होनी चाहिए. इससे एपीआई सर्वर को, पुष्टि किए गए मौजूदा उपयोगकर्ता के चैनल की जानकारी वापस पाने का निर्देश मिलता है.

    2. क्रेडेंशियल सेक्शन में, पुलडाउन मेन्यू में Google OAuth 2.0 का विकल्प चुना जाना चाहिए.

      इसके अलावा, अगर आपने स्कोप दिखाएं लिंक पर क्लिक किया है, तो https://www.googleapis.com/auth/youtube.readonly स्कोप को चुना जाना चाहिए.

      ऐसी इमेज जिसमें APIs Explorer को फ़ुलस्क्रीन मोड में दिखाया गया हो. साथ ही, 'Google OAuth 2.0' क्रेडेंशियल इस्तेमाल करने का विकल्प चुना गया हो.

  4. पिछले उदाहरण की तरह, Java टैब चुनें, कोड सैंपल को कॉपी करें, और इसे src/main/java/ApiExample.java में सेव करें.

  5. कमांड लाइन से सैंपल चलाएं. अपनी वर्किंग डायरेक्ट्री में जाकर, यह कमांड चलाएं:

    gradle -q run

  6. सैंपल को आपके डिफ़ॉल्ट ब्राउज़र में एक नई विंडो या टैब खोलने की कोशिश करनी चाहिए. अगर ऐसा नहीं होता है, तो टर्मिनल से यूआरएल कॉपी करें और उसे अपने ब्राउज़र में मैन्युअल तरीके से खोलें.

    अगर आपने अपने Google खाते में पहले से लॉगिन नहीं किया है, तो आपको लॉगिन करने के लिए कहा जाएगा. अगर आपने एक से ज़्यादा Google खातों में लॉग इन किया है, तो आपको पुष्टि करने के लिए कोई एक खाता चुनने के लिए कहा जाएगा.

  7. अपने ऐप्लिकेशन को, कोड सैंपल में बताए गए स्कोप का ऐक्सेस देने के लिए, इस बटन पर क्लिक करें.

  8. सेंपल अपने-आप आगे बढ़ जाएगा. इसके बाद, पुष्टि करने के लिए इस्तेमाल किया गया ब्राउज़र टैब बंद किया जा सकता है.

    एपीआई के जवाब को फिर से STDOUT में प्रिंट किया जाना चाहिए.

इस बारे में और पढ़ें