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

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

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

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

मकसद

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

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

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

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

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

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

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

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

• Google Cloud Console में, 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. "पूरे डोमेन के लोगों को डेटा का ऐक्सेस दें" में जाकर, अपने सेवा खाते का "क्लाइंट आईडी" ढूंढें. क्लाइंट आईडी की वैल्यू को क्लिपबोर्ड पर कॉपी करने के लिए, को कॉपी करें पर क्लिक करें.

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

   अगर आपके पास संबंधित Google Workspace खाते का सुपर एडमिन ऐक्सेस नहीं है, तो उस खाते के सुपर उपयोगकर्ता से संपर्क करें और उन्हें अपने सेवा खाते का क्लाइंट आईडी भेजें को भी देखें, ताकि वे 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 दस्तावेज़