इस गाइड में, YouTube Data API को अनुरोध करने वाले आसान Android ऐप्लिकेशन को सेट अप करने का तरीका बताया गया है.
ज़रूरी शर्तें
यह क्विकस्टार्ट चलाने के लिए, आपको इन चीज़ों की ज़रूरत होगी:
- Android Studio SDK 1.2 या इसके बाद का वर्शन.
- एपीआई 23 या उसके बाद के वर्शन के लिए Android SDK टूल के पैकेज. इनमें Google रिपॉज़िटरी, Android सहायता लाइब्रेरी, और Google Play services के नए वर्शन शामिल हैं.
- आपके पास टेस्ट डिवाइस पर इंटरनेट कनेक्शन हो.
- Google खाता.
इस शुरुआती लेख में यह माना गया है कि आपने स्टैंडअलोन SDK टूल के बजाय, Android Studio IDE का इस्तेमाल किया है. साथ ही, आपको Studio प्रोजेक्ट में फ़ाइलें खोजने, बनाने, और उनमें बदलाव करने में कोई परेशानी नहीं होती.
पहला चरण: SHA1 फ़िंगरप्रिंट पाना
SHA1 फ़िंगरप्रिंट पाने के लिए, टर्मिनल में यह Keytool उपयोगिता कमांड चलाएं. इसका इस्तेमाल, एपीआई को चालू करने के लिए किया जाएगा.
keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -list -v
पासवर्ड डालने के लिए कहा जाने पर, "android" डालें.
Keytool, फ़िंगरप्रिंट को शेल पर प्रिंट करता है. उदाहरण के लिए:
$ keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -list -v Enter keystore password: Type "android" if using debug.keystore Alias name: androiddebugkey Creation date: Dec 4, 2014 Entry type: PrivateKeyEntry Certificate chain length: 1 Certificate[1]: Owner: CN=Android Debug, O=Android, C=US Issuer: CN=Android Debug, O=Android, C=US Serial number: 503bd581 Valid from: Mon Aug 27 13:16:01 PDT 2012 until: Wed Aug 20 13:16:01 PDT 2042 Certificate fingerprints: MD5: 1B:2B:2D:37:E1:CE:06:8B:A0:F0:73:05:3C:A3:63:DD SHA1: D8:AA:43:97:59:EE:C5:95:26:6A:07:EE:1C:37:8E:F4:F0:C8:05:C8 SHA256: F3:6F:98:51:9A:DF:C3:15:4E:48:4B:0F:91:E3:3C:6A:A0:97:DC:0A:3F:B2:D2:E1:FE:23:57:F5:EB:AC:13:30 Signature algorithm name: SHA1withRSA Version: 3
SHA1 फ़िंगरप्रिंट कॉपी करें. इसे ऊपर दिए गए उदाहरण में हाइलाइट किया गया है.
दूसरा चरण: YouTube Data API को चालू करना
-
Google Developers Console में प्रोजेक्ट बनाने या चुनने के लिए, इस विज़र्ड का इस्तेमाल करें. साथ ही, एपीआई को अपने-आप चालू करें. जारी रखें पर क्लिक करें. इसके बाद, क्रेडेंशियल पर जाएं.
-
क्रेडेंशियल बनाएं पेज पर, रद्द करें बटन पर क्लिक करें.
-
पेज पर सबसे ऊपर, OAuth सहमति वाली स्क्रीन टैब चुनें. कोई ईमेल पता चुनें. अगर प्रॉडक्ट का नाम पहले से सेट नहीं है, तो उसे डालें. इसके बाद, सेव करें बटन पर क्लिक करें.
-
क्रेडेंशियल टैब चुनें. इसके बाद, क्रेडेंशियल बनाएं बटन पर क्लिक करें और OAuth क्लाइंट आईडी चुनें.
- ऐप्लिकेशन का टाइप Android चुनें.
- पहले चरण में मौजूद SHA1 फ़िंगरप्रिंट को साइनिंग-सर्टिफ़िकेट फ़िंगरप्रिंट फ़ील्ड में कॉपी करें.
- पैकेज का नाम
फ़ील्ड में,
com.example.quickstart
डालें. - बनाएं बटन पर क्लिक करें.
तीसरा चरण: नया Android प्रोजेक्ट बनाना
- Android Studio खोलें और नया Android Studio प्रोजेक्ट शुरू करें.
- नया प्रोजेक्ट स्क्रीन में, ऐप्लिकेशन का नाम "क्विकस्टार्ट" रखें.
- कंपनी का डोमेन "example.com" पर सेट करें और पुष्टि करें कि पैकेज का नाम अपने-आप जनरेट हुआ है या नहीं. यह नाम, दूसरे चरण में Developer Console में डाले गए नाम से मेल खाना चाहिए. आगे बढ़ें पर क्लिक करें.
- टारगेट किए गए Android डिवाइस स्क्रीन पर, फ़ोन और टैबलेट चेकबॉक्स को चुनें. इसके बाद, "एपीआई 14: Android 4.0 (IceCreamSandwich)" का कम से कम एसडीके चुनें. अन्य चेकबॉक्स से सही का निशान हटाएं. आगे बढ़ें पर क्लिक करें.
- मोबाइल पर कोई गतिविधि जोड़ें स्क्रीन पर, कोई गतिविधि नहीं जोड़ें पर क्लिक करें.
- पूरा करें पर क्लिक करें.
इसके बाद, Android Studio प्रोजेक्ट बनाता है और उसे खोलता है.
चौथा चरण: प्रोजेक्ट तैयार करना
प्रोजेक्ट साइडबार, Android Studio से बनाई गई डिफ़ॉल्ट प्रोजेक्ट फ़ाइलों की एक ऐसी सूची है जिसे बड़ा किया जा सकता है. उस सूची में, Gradle स्क्रिप्ट की सूची को बड़ा करें और "ऐप्लिकेशन" मॉड्यूल से जुड़ी build.gradle
फ़ाइल खोलें, न कि प्रोजेक्ट से जुड़ी फ़ाइल.
- ऐप्लिकेशन
build.gradle
फ़ाइल खोलें और उसके कॉन्टेंट को इनके साथ बदलें: - टूलबार में, टूल > Android > Gradle फ़ाइलों के साथ प्रोजेक्ट सिंक करें को चुनें. इससे आपके प्रोजेक्ट के लिए ज़रूरी लाइब्रेरी हासिल हो जाएंगी और उन्हें उपलब्ध कराया जा सकेगा.
- डिफ़ॉल्ट
src/main/AndroidManifest.xml
फ़ाइल ढूंढें और खोलें. प्रोजेक्ट के साइडबार में, यह फ़ाइलapp
और फिरmanifests
के नीचे नेस्ट की गई है. फ़ाइल के कॉन्टेंट को इस कोड से बदलें:<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.quickstart"> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.GET_ACCOUNTS" /> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="YouTube Data API Android Quickstart" android:theme="@style/AppTheme" > <activity android:name=".MainActivity" android:label="YouTube Data API Android Quickstart" > <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest>
पांचवां चरण: सैंपल सेट अप करना
नई Java क्लास बनाएं. ऐसा करने के लिए, सबसे पहले प्रोजेक्ट साइडबार में java
फ़ोल्डर चुनें. यह फ़ोल्डर, app
फ़ाइलों के ग्रुप में दिखता है. फ़ोल्डर पर क्लिक करने के बाद, मेन्यू बार से .../app/src/main/java
चुनें.
क्लास को "MainActivity" नाम दें और ठीक है पर क्लिक करें. नई फ़ाइल के कॉन्टेंट को, यहां दिए गए कोड से बदलें.
package com.example.quickstart; import com.google.android.gms.common.ConnectionResult; import com.google.android.gms.common.GoogleApiAvailability; import com.google.api.client.extensions.android.http.AndroidHttp; import com.google.api.client.googleapis.extensions.android.gms.auth.GoogleAccountCredential; import com.google.api.client.googleapis.extensions.android.gms.auth.GooglePlayServicesAvailabilityIOException; import com.google.api.client.googleapis.extensions.android.gms.auth.UserRecoverableAuthIOException; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.JsonFactory; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.client.util.ExponentialBackOff; import com.google.api.services.youtube.YouTubeScopes; import com.google.api.services.youtube.model.*; import android.Manifest; import android.accounts.AccountManager; import android.app.Activity; import android.app.Dialog; import android.app.ProgressDialog; import android.content.Context; import android.content.Intent; import android.content.SharedPreferences; import android.net.ConnectivityManager; import android.net.NetworkInfo; import android.os.AsyncTask; import android.os.Bundle; import android.support.annotation.NonNull; import android.text.TextUtils; import android.text.method.ScrollingMovementMethod; import android.view.View; import android.view.ViewGroup; import android.widget.Button; import android.widget.LinearLayout; import android.widget.TextView; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.List; import pub.devrel.easypermissions.AfterPermissionGranted; import pub.devrel.easypermissions.EasyPermissions; public class MainActivity extends Activity implements EasyPermissions.PermissionCallbacks { GoogleAccountCredential mCredential; private TextView mOutputText; private Button mCallApiButton; ProgressDialog mProgress; static final int REQUEST_ACCOUNT_PICKER = 1000; static final int REQUEST_AUTHORIZATION = 1001; static final int REQUEST_GOOGLE_PLAY_SERVICES = 1002; static final int REQUEST_PERMISSION_GET_ACCOUNTS = 1003; private static final String BUTTON_TEXT = "Call YouTube Data API"; private static final String PREF_ACCOUNT_NAME = "accountName"; private static final String[] SCOPES = { YouTubeScopes.YOUTUBE_READONLY }; /** * Create the main activity. * @param savedInstanceState previously saved instance data. */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); LinearLayout activityLayout = new LinearLayout(this); LinearLayout.LayoutParams lp = new LinearLayout.LayoutParams( LinearLayout.LayoutParams.MATCH_PARENT, LinearLayout.LayoutParams.MATCH_PARENT); activityLayout.setLayoutParams(lp); activityLayout.setOrientation(LinearLayout.VERTICAL); activityLayout.setPadding(16, 16, 16, 16); ViewGroup.LayoutParams tlp = new ViewGroup.LayoutParams( ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT); mCallApiButton = new Button(this); mCallApiButton.setText(BUTTON_TEXT); mCallApiButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { mCallApiButton.setEnabled(false); mOutputText.setText(""); getResultsFromApi(); mCallApiButton.setEnabled(true); } }); activityLayout.addView(mCallApiButton); mOutputText = new TextView(this); mOutputText.setLayoutParams(tlp); mOutputText.setPadding(16, 16, 16, 16); mOutputText.setVerticalScrollBarEnabled(true); mOutputText.setMovementMethod(new ScrollingMovementMethod()); mOutputText.setText( "Click the \'" + BUTTON_TEXT +"\' button to test the API."); activityLayout.addView(mOutputText); mProgress = new ProgressDialog(this); mProgress.setMessage("Calling YouTube Data API ..."); setContentView(activityLayout); // Initialize credentials and service object. mCredential = GoogleAccountCredential.usingOAuth2( getApplicationContext(), Arrays.asList(SCOPES)) .setBackOff(new ExponentialBackOff()); } /** * Attempt to call the API, after verifying that all the preconditions are * satisfied. The preconditions are: Google Play Services installed, an * account was selected and the device currently has online access. If any * of the preconditions are not satisfied, the app will prompt the user as * appropriate. */ private void getResultsFromApi() { if (! isGooglePlayServicesAvailable()) { acquireGooglePlayServices(); } else if (mCredential.getSelectedAccountName() == null) { chooseAccount(); } else if (! isDeviceOnline()) { mOutputText.setText("No network connection available."); } else { new MakeRequestTask(mCredential).execute(); } } /** * Attempts to set the account used with the API credentials. If an account * name was previously saved it will use that one; otherwise an account * picker dialog will be shown to the user. Note that the setting the * account to use with the credentials object requires the app to have the * GET_ACCOUNTS permission, which is requested here if it is not already * present. The AfterPermissionGranted annotation indicates that this * function will be rerun automatically whenever the GET_ACCOUNTS permission * is granted. */ @AfterPermissionGranted(REQUEST_PERMISSION_GET_ACCOUNTS) private void chooseAccount() { if (EasyPermissions.hasPermissions( this, Manifest.permission.GET_ACCOUNTS)) { String accountName = getPreferences(Context.MODE_PRIVATE) .getString(PREF_ACCOUNT_NAME, null); if (accountName != null) { mCredential.setSelectedAccountName(accountName); getResultsFromApi(); } else { // Start a dialog from which the user can choose an account startActivityForResult( mCredential.newChooseAccountIntent(), REQUEST_ACCOUNT_PICKER); } } else { // Request the GET_ACCOUNTS permission via a user dialog EasyPermissions.requestPermissions( this, "This app needs to access your Google account (via Contacts).", REQUEST_PERMISSION_GET_ACCOUNTS, Manifest.permission.GET_ACCOUNTS); } } /** * Called when an activity launched here (specifically, AccountPicker * and authorization) exits, giving you the requestCode you started it with, * the resultCode it returned, and any additional data from it. * @param requestCode code indicating which activity result is incoming. * @param resultCode code indicating the result of the incoming * activity result. * @param data Intent (containing result data) returned by incoming * activity result. */ @Override protected void onActivityResult( int requestCode, int resultCode, Intent data) { super.onActivityResult(requestCode, resultCode, data); switch(requestCode) { case REQUEST_GOOGLE_PLAY_SERVICES: if (resultCode != RESULT_OK) { mOutputText.setText( "This app requires Google Play Services. Please install " + "Google Play Services on your device and relaunch this app."); } else { getResultsFromApi(); } break; case REQUEST_ACCOUNT_PICKER: if (resultCode == RESULT_OK && data != null && data.getExtras() != null) { String accountName = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME); if (accountName != null) { SharedPreferences settings = getPreferences(Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); editor.putString(PREF_ACCOUNT_NAME, accountName); editor.apply(); mCredential.setSelectedAccountName(accountName); getResultsFromApi(); } } break; case REQUEST_AUTHORIZATION: if (resultCode == RESULT_OK) { getResultsFromApi(); } break; } } /** * Respond to requests for permissions at runtime for API 23 and above. * @param requestCode The request code passed in * requestPermissions(android.app.Activity, String, int, String[]) * @param permissions The requested permissions. Never null. * @param grantResults The grant results for the corresponding permissions * which is either PERMISSION_GRANTED or PERMISSION_DENIED. Never null. */ @Override public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) { super.onRequestPermissionsResult(requestCode, permissions, grantResults); EasyPermissions.onRequestPermissionsResult( requestCode, permissions, grantResults, this); } /** * Callback for when a permission is granted using the EasyPermissions * library. * @param requestCode The request code associated with the requested * permission * @param list The requested permission list. Never null. */ @Override public void onPermissionsGranted(int requestCode, List<String> list) { // Do nothing. } /** * Callback for when a permission is denied using the EasyPermissions * library. * @param requestCode The request code associated with the requested * permission * @param list The requested permission list. Never null. */ @Override public void onPermissionsDenied(int requestCode, List<String> list) { // Do nothing. } /** * Checks whether the device currently has a network connection. * @return true if the device has a network connection, false otherwise. */ private boolean isDeviceOnline() { ConnectivityManager connMgr = (ConnectivityManager) getSystemService(Context.CONNECTIVITY_SERVICE); NetworkInfo networkInfo = connMgr.getActiveNetworkInfo(); return (networkInfo != null && networkInfo.isConnected()); } /** * Check that Google Play services APK is installed and up to date. * @return true if Google Play Services is available and up to * date on this device; false otherwise. */ private boolean isGooglePlayServicesAvailable() { GoogleApiAvailability apiAvailability = GoogleApiAvailability.getInstance(); final int connectionStatusCode = apiAvailability.isGooglePlayServicesAvailable(this); return connectionStatusCode == ConnectionResult.SUCCESS; } /** * Attempt to resolve a missing, out-of-date, invalid or disabled Google * Play Services installation via a user dialog, if possible. */ private void acquireGooglePlayServices() { GoogleApiAvailability apiAvailability = GoogleApiAvailability.getInstance(); final int connectionStatusCode = apiAvailability.isGooglePlayServicesAvailable(this); if (apiAvailability.isUserResolvableError(connectionStatusCode)) { showGooglePlayServicesAvailabilityErrorDialog(connectionStatusCode); } } /** * Display an error dialog showing that Google Play Services is missing * or out of date. * @param connectionStatusCode code describing the presence (or lack of) * Google Play Services on this device. */ void showGooglePlayServicesAvailabilityErrorDialog( final int connectionStatusCode) { GoogleApiAvailability apiAvailability = GoogleApiAvailability.getInstance(); Dialog dialog = apiAvailability.getErrorDialog( MainActivity.this, connectionStatusCode, REQUEST_GOOGLE_PLAY_SERVICES); dialog.show(); } /** * An asynchronous task that handles the YouTube Data API call. * Placing the API calls in their own task ensures the UI stays responsive. */ private class MakeRequestTask extends AsyncTask<Void, Void, List<String>> { private com.google.api.services.youtube.YouTube mService = null; private Exception mLastError = null; MakeRequestTask(GoogleAccountCredential credential) { HttpTransport transport = AndroidHttp.newCompatibleTransport(); JsonFactory jsonFactory = JacksonFactory.getDefaultInstance(); mService = new com.google.api.services.youtube.YouTube.Builder( transport, jsonFactory, credential) .setApplicationName("YouTube Data API Android Quickstart") .build(); } /** * Background task to call YouTube Data API. * @param params no parameters needed for this task. */ @Override protected List<String> doInBackground(Void... params) { try { return getDataFromApi(); } catch (Exception e) { mLastError = e; cancel(true); return null; } } /** * Fetch information about the "GoogleDevelopers" YouTube channel. * @return List of Strings containing information about the channel. * @throws IOException */ private List<String> getDataFromApi() throws IOException { // Get a list of up to 10 files. List<String> channelInfo = new ArrayList<String>(); ChannelListResponse result = mService.channels().list("snippet,contentDetails,statistics") .setForUsername("GoogleDevelopers") .execute(); List<Channel> channels = result.getItems(); if (channels != null) { Channel channel = channels.get(0); channelInfo.add("This channel's ID is " + channel.getId() + ". " + "Its title is '" + channel.getSnippet().getTitle() + ", " + "and it has " + channel.getStatistics().getViewCount() + " views."); } return channelInfo; } @Override protected void onPreExecute() { mOutputText.setText(""); mProgress.show(); } @Override protected void onPostExecute(List<String> output) { mProgress.hide(); if (output == null || output.size() == 0) { mOutputText.setText("No results returned."); } else { output.add(0, "Data retrieved using the YouTube Data API:"); mOutputText.setText(TextUtils.join("\n", output)); } } @Override protected void onCancelled() { mProgress.hide(); if (mLastError != null) { if (mLastError instanceof GooglePlayServicesAvailabilityIOException) { showGooglePlayServicesAvailabilityErrorDialog( ((GooglePlayServicesAvailabilityIOException) mLastError) .getConnectionStatusCode()); } else if (mLastError instanceof UserRecoverableAuthIOException) { startActivityForResult( ((UserRecoverableAuthIOException) mLastError).getIntent(), MainActivity.REQUEST_AUTHORIZATION); } else { mOutputText.setText("The following error occurred:\n" + mLastError.getMessage()); } } else { mOutputText.setText("Request cancelled."); } } } }
छठा चरण: ऐप्लिकेशन चलाना
- ऐप्लिकेशन की जांच करने के लिए, चालू करें > ऐप्लिकेशन चलाएं मेन्यू आइटम पर क्लिक करें.
- आपको ऐप्लिकेशन चलाने के लिए, कनेक्ट किया गया डिवाइस (सुझाया गया) या एमुलेटर चुनने के लिए कहा जाएगा. अगर एमुलेटर का इस्तेमाल किया जा रहा है, तो पक्का करें कि इसे Google API के साथ काम करने वाली सिस्टम इमेज में से किसी एक का इस्तेमाल करने के लिए कॉन्फ़िगर किया गया हो. अगर आपने तुरंत शुरू करने की सुविधा को ऐसे डिवाइस पर चलाने की कोशिश की है जिस पर फ़िलहाल Google Play services इंस्टॉल नहीं है, तो तुरंत शुरू करने की सुविधा एक डायलॉग बॉक्स दिखाएगी. इस डायलॉग बॉक्स से, Google Play services को इंस्टॉल किया जा सकता है.
- अगर एम्युलेटर पर चलाया जा रहा है, तो उसे पूरी तरह से शुरू होने और नेटवर्क कनेक्शन सेट अप करने दें.
- अगर पहली बार एमुलेटर शुरू किया जा रहा है, तो आपको उसकी स्क्रीन अनलॉक करनी पड़ सकती है. इसके बावजूद, तुरंत शुरू होने वाला ऐप्लिकेशन अपने-आप शुरू हो जाना चाहिए.
- पहली बार ऐप्लिकेशन चलाने पर, आपसे कोई खाता चुनने के लिए कहा जाएगा. कनेक्ट करने के लिए कोई खाता चुनने के लिए, साइन इन फ़्लो पूरा करें.
- कोई खाता चुनने के बाद, ऐप्लिकेशन आपको ऐक्सेस की अनुमति देने के लिए कहता है. अनुमति देने के लिए, ठीक है पर क्लिक करें.
नोट
- अनुमति की जानकारी ऐप्लिकेशन में सेव की जाती है, ताकि बाद में इसे दोबारा इस्तेमाल करने पर, अनुमति के लिए फिर से कहा न जाए.
इसके बारे में और पढ़ें
- Google Developers Console से जुड़ा सहायता दस्तावेज़
- Java के लिए Google APIs क्लाइंट का दस्तावेज़
- Android एपीआई गाइड
- Google Play services
- YouTube Data API का रेफ़रंस दस्तावेज़
समस्या का हल
अपंजीकृत Android ऐप्लिकेशन
जब OAuth डायलॉग में "रजिस्ट्रेशन नहीं किया गया Android ऐप्लिकेशन" वाली एंट्री दिखती है, तो इसका मतलब है कि आपने दूसरे चरण में जो OAuth2 क्लाइंट आईडी बनाया था वह नहीं मिला और Android डिफ़ॉल्ट क्लाइंट का इस्तेमाल कर रहा है. डिफ़ॉल्ट क्लाइंट को इस एपीआई का इस्तेमाल करने के लिए कॉन्फ़िगर नहीं किया जाएगा. इसलिए, अनुरोधों को accessNotConfigured.
जैसी गड़बड़ियों की वजह से अस्वीकार कर दिया जाएगा. इन गड़बड़ियों में डिफ़ॉल्ट प्रोजेक्ट नंबर 608941808256
का भी ज़िक्र हो सकता है.
समस्या को ठीक करने के लिए, पक्का करें कि पहले चरण में हासिल किया गया SHA1 फ़िंगरप्रिंट और आपकी build.gradle
फ़ाइल में मौजूद applicationId
, Google Developers Console में सेट की गई वैल्यू से पूरी तरह मैच करते हों.