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

क्विकस्टार्ट में, Google Workspace API को कॉल करने वाले ऐप्लिकेशन को सेट अप और चलाने का तरीका बताया गया है.

Google Workspace के क्विकस्टार्ट, पुष्टि करने और अनुमति देने की प्रोसेस की कुछ जानकारी को मैनेज करने के लिए, एपीआई क्लाइंट लाइब्रेरी का इस्तेमाल करते हैं. हमारा सुझाव है कि आप अपने ऐप्लिकेशन के लिए क्लाइंट लाइब्रेरी का इस्तेमाल करें. इस क्विकस्टार्ट में, पुष्टि करने के लिए आसान तरीके का इस्तेमाल किया गया है. यह तरीका, टेस्टिंग एनवायरमेंट के लिए सही है. हमारा सुझाव है कि प्रोडक्शन एनवायरमेंट के लिए, अपने ऐप्लिकेशन के लिए सही ऐक्सेस क्रेडेंशियल चुनने से पहले, पुष्टि और अनुमति के बारे में जानें.

Google Keep API को अनुरोध करने वाला Java कमांड-लाइन ऐप्लिकेशन बनाएं.

मकसद

• अपना एनवायरमेंट सेट अप करें.
• सैंपल सेट अप करें.
• सैंपल चलाएं.

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

• Java 1.8 या इसके बाद का वर्शन.
• Gradle 7.0 या इसके बाद का वर्शन.
• Google Cloud प्रोजेक्ट.

• Google Keep की सुविधा वाला Google खाता.

अपना एनवायरमेंट सेट अप करने का तरीका

यह शुरुआती लेख पूरा करने के लिए, अपना एनवायरमेंट सेट अप करें.

एपीआई चालू करना

Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. किसी एक Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.

• Google Cloud Console में, Google Keep API को चालू करें.

  एपीआई को चालू करना

सेवा खाता बनाना

सेवा खाता एक खास तरह का खाता होता है. इसका इस्तेमाल, किसी व्यक्ति के बजाय ऐप्लिकेशन करता है. रोबोट खाते से डेटा ऐक्सेस करने या कार्रवाइयां करने के लिए, सेवा खाते का इस्तेमाल किया जा सकता है. इसके अलावा, Google Workspace या Cloud Identity के उपयोगकर्ताओं की ओर से डेटा ऐक्सेस करने के लिए भी, सेवा खाते का इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, सेवा खातों को समझना लेख पढ़ें.

Google Cloud कंसोल

1. Google Cloud console में, मेन्यू > आईएएम और एडमिन > सेवा खाते पर जाएं.

   सेवा खातों पर जाएं

2. सेवा खाता बनाएं पर क्लिक करें.
3. सेवा खाते की जानकारी भरें. इसके बाद, बनाएं और जारी रखें पर क्लिक करें.
   ध्यान दें: Google डिफ़ॉल्ट रूप से एक यूनीक सेवा खाता आईडी बनाता है. अगर आपको आईडी बदलना है, तो सेवा खाते के आईडी वाले फ़ील्ड में जाकर आईडी में बदलाव करें.
4. ज़रूरी नहीं: अपने Google Cloud प्रोजेक्ट के संसाधनों का ऐक्सेस देने के लिए, अपने सेवा खाते को भूमिकाएं असाइन करें. ज़्यादा जानकारी के लिए, संसाधनों का ऐक्सेस देना, उसमें बदलाव करना, और उसे वापस लेना लेख पढ़ें.
5. जारी रखें पर क्लिक करें.
6. ज़रूरी नहीं: ऐसे उपयोगकर्ता या ग्रुप डालें जो इस सेवा खाते को मैनेज कर सकते हैं और उससे कार्रवाइयां कर सकते हैं. ज़्यादा जानकारी के लिए, सेवा खाते के डुप्लीकेट को मैनेज करना लेख पढ़ें.
7. हो गया पर क्लिक करें. सेवा खाते के ईमेल पते को नोट करें.

gcloud सीएलआई

1. सेवा खाता बनाएं:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
     --display-name="SERVICE_ACCOUNT_NAME"

2. ज़रूरी नहीं: अपने Google Cloud प्रोजेक्ट के संसाधनों का ऐक्सेस देने के लिए, अपने सेवा खाते को भूमिकाएं असाइन करें. ज़्यादा जानकारी के लिए, संसाधनों का ऐक्सेस देना, उसमें बदलाव करना, और उसे वापस लेना लेख पढ़ें.

सेवा खाते के लिए क्रेडेंशियल बनाना

आपको सार्वजनिक/निजी पासकोड के जोड़े के तौर पर क्रेडेंशियल पाने होंगे. आपके कोड में इन क्रेडेंशियल का इस्तेमाल, आपके ऐप्लिकेशन में सेवा खाते की कार्रवाइयों को अनुमति देने के लिए किया जाता है.

1. Google Cloud console में, मेन्यू > आईएएम और एडमिन > सेवा खाते पर जाएं.

   सेवा खातों पर जाएं

2. अपना सेवा खाता चुनें.
3. कुंजियां > कुंजी जोड़ें > नई कुंजी बनाएं पर क्लिक करें.
4. JSON चुनें. इसके बाद, बनाएं पर क्लिक करें.

   आपकी नई सार्वजनिक/निजी कुंजी की जोड़ी जनरेट करके, आपकी मशीन पर डाउनलोड की जाती है. यह एक नई फ़ाइल के तौर पर डाउनलोड की जाती है. डाउनलोड की गई JSON फ़ाइल को अपनी वर्किंग डायरेक्ट्री में credentials.json के तौर पर सेव करें. इस कुंजी की सिर्फ़ एक कॉपी होती है. अपनी कुंजी को सुरक्षित तरीके से सेव करने के तरीके के बारे में जानने के लिए, सेवा खाते की कुंजियों को मैनेज करना लेख पढ़ें.

5. Close पर क्लिक करें.

किसी सेवा खाते के लिए, पूरे डोमेन के लिए डेटा का ऐक्सेस देने की सुविधा सेट अप करना

Google Workspace के किसी संगठन के उपयोगकर्ताओं की ओर से एपीआई को कॉल करने के लिए, आपके सेवा खाते को Google Workspace Admin console में, सुपर एडमिन खाते से डोमेन-वाइड अधिकार देना होगा. ज़्यादा जानकारी के लिए, सेवा खाते को डोमेन के लिए अधिकार देना लेख पढ़ें.

1. Google Cloud console में, मेन्यू > आईएएम और एडमिन > सेवा खाते पर जाएं.

   सेवा खातों पर जाएं

2. अपना सेवा खाता चुनें.
3. ऐडवांस सेटिंग दिखाएं पर क्लिक करें.
4. "डोमेन के लिए एजेंट सेट करना" में जाकर, अपने सेवा खाते का "क्लाइंट आईडी" ढूंढें. क्लाइंट आईडी की वैल्यू को क्लिपबोर्ड पर कॉपी करने के लिए, कॉपी करें पर क्लिक करें.

5. अगर आपके पास उस Google Workspace खाते का सुपर एडमिन ऐक्सेस है, तो Google Workspace Admin console देखें पर क्लिक करें. इसके बाद, सुपर एडमिन उपयोगकर्ता खाते का इस्तेमाल करके साइन इन करें और यह तरीका अपनाएं.

   अगर आपके पास उस Google Workspace खाते का सुपर एडमिन ऐक्सेस नहीं है, तो उस खाते के सुपर एडमिन से संपर्क करें और उन्हें अपने सेवा खाते का क्लाइंट आईडी और OAuth स्कोप की सूची भेजें, ताकि वे Admin console में ये चरण पूरे कर सकें.

1. Google Admin console में, मेन्यू > सुरक्षा > ऐक्सेस और डेटा कंट्रोल > एपीआई कंट्रोल पर जाएं.

   एपीआई कंट्रोल पर जाएं

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

फ़ाइल फ़ोल्डर तैयार करना

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

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

2. src/main/resources/ डायरेक्ट्री में, credentials.json फ़ाइल को कॉपी करें, जिसे आपने पहले डाउनलोड किया था.

3. डिफ़ॉल्ट build.gradle फ़ाइल खोलें और उसके कॉन्टेंट को यहां दिए गए कोड से बदलें:

     apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'KeepQuickstart'
   sourceCompatibility = 1.8
   targetCompatibility = 1.8
   version = '1.0'
   
   sourceCompatibility = 1.8
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:1.23.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
       implementation 'com.google.apis:google-api-services-keep:v1-rev20210528-1.31.0'
   }
   

सैंपल सेट अप करना

1. src/main/java/ डायरेक्ट्री में, एक नई Java फ़ाइल बनाएं. इसका नाम, build.gradle फ़ाइल में मौजूद mainClassName वैल्यू से मेल खाना चाहिए.

2. अपनी नई Java फ़ाइल में यह कोड शामिल करें:

   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.javanet.NetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.keep.v1.Keep;
   import com.google.api.services.keep.v1.model.Note;
   import com.google.api.services.keep.v1.model.Section;
   import com.google.api.services.keep.v1.model.TextContent;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Collections;
   import java.util.List;
   
   public class KeepQuickstart {
   
     private static final String APPLICATION_NAME = "Google Keep API Java Quickstart";
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
   
     /**
      * Global instance of the scopes required by this quickstart. If modifying these scopes, delete
      * your previously saved tokens/ folder.
      */
     private static final List<String> KEEP_SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/keep");
   
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Creates an authorized Credential object.
      *
      * @param HTTP_TRANSPORT The network HTTP Transport.
      * @return An authorized Credential object.
      * @throws IOException
      */
     private static Credential getOAuthCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = KeepQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (in == null) {
         throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
   
       // Build flow and trigger user authorization request.
       GoogleAuthorizationCodeFlow flow =
           new GoogleAuthorizationCodeFlow.Builder(
                   HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, KEEP_SCOPES)
               .setDataStoreFactory(new FileDataStoreFactory(new java.io.File("tokens")))
               .setAccessType("offline")
               .build();
       LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
       return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
     }
   
     public static void main(String... args) throws IOException, GeneralSecurityException {
       // Build a new authorized API client service.
       final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
       Keep service =
           new Keep.Builder(HTTP_TRANSPORT, JSON_FACTORY, getOAuthCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
   
       Section noteBody =
           new Section().setText(new TextContent().setText("Finish preparations by tomorrow!"));
       Note newNote = new Note().setTitle("Customer call next week").setBody(noteBody);
   
       // Creates a new text note.
       service.notes().create(newNote).execute();
     }
   }
   
   

सैंपल चलाना

1. सैंपल चलाने के लिए:

   gradle run
   

2. सैंपल को पहली बार चलाने पर, आपको ऐक्सेस की अनुमति देने के लिए कहा जाएगा:
   1. अगर आपने Google खाते में पहले से साइन इन नहीं किया है, तो कहा जाने पर साइन इन करें. अगर आपने एक से ज़्यादा खातों में साइन इन किया है, तो अनुमति देने के लिए कोई एक खाता चुनें.
   2. स्वीकार करें पर क्लिक करें.

   आपका Java ऐप्लिकेशन, Google Keep API को चलाता है और उसे कॉल करता है.

   अनुमति की जानकारी फ़ाइल सिस्टम में सेव होती है. इसलिए, अगली बार सैंपल कोड चलाने पर, आपसे अनुमति नहीं मांगी जाती.

अगले चरण

• पुष्टि करने और अनुमति देने से जुड़ी समस्याएं हल करना
• Google Keep API का रेफ़रंस दस्तावेज़
• Java के लिए Google APIs क्लाइंट का दस्तावेज़
• Google Keep API का Javadoc दस्तावेज़