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

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

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

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

मकसद

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

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

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

• आपके पास ऐसा Google खाता होना चाहिए जिसमें Google Keep चालू हो.

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

इस क्विकस्टार्ट को पूरा करने के लिए, अपना एनवायरमेंट सेट अप करें.

एपीआई चालू करें

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

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

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

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

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

Google Cloud कंसोल

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

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

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 में, मेन्यू > IAM और एडमिन > सेवा खाते पर जाएं.

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

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

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

5. बंद करें पर क्‍लिक करें.

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

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

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

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

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

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 API क्लाइंट
• Google Keep API Javadoc दस्तावेज़