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

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

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

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

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

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

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 खोलें और उसमें जानकारी भरें.

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

  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. "आम तौर पर इस्तेमाल के उदाहरण" सेक्शन में, टेबल में मौजूद तीसरी लिस्टिंग के लिए, कोड के सिंबल पर क्लिक करें. यह इस्तेमाल का उदाहरण, "मेरा चैनल" के लिए 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 पर प्रिंट की जानी चाहिए.

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