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

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

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

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

मकसद

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

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

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

• Google खाता.

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

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

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

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

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

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

उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है

अगर इस क्विकस्टार्ट को पूरा करने के लिए, किसी नए Google Cloud प्रोजेक्ट का इस्तेमाल किया जा रहा है, तो कॉन्फ़िगर करें OAuth के लिए सहमति देने वाली स्क्रीन पर जाएं और खुद को टेस्ट उपयोगकर्ता के तौर पर जोड़ें. अगर आपने पहले आपने अपने Cloud प्रोजेक्ट के लिए यह चरण पूरा किया है, तो अगले सेक्शन पर जाएं.

1. Google Cloud Console में, मेन्यू menu पर जाएं > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन.

   उस स्क्रीन पर जाएं जहां OAuth के लिए सहमति दी जाती है

2. उपयोगकर्ता टाइप के लिए इंटरनल चुनें. इसके बाद, बनाएं पर क्लिक करें.
3. ऐप्लिकेशन रजिस्ट्रेशन फ़ॉर्म भरें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.

4. फ़िलहाल, दायरों को जोड़ना स्किप किया जा सकता है. इसके बाद, सेव करें और जारी रखें पर क्लिक करें. भविष्य में, जब आप अपने अगर आपका संगठन Google Workspace का इस्तेमाल करता है, तो आपको उपयोगकर्ता टाइप को बदलकर बाहरी करना होगा. इसके बाद, अनुमति के वे दायरे जोड़ें जो आपके ऐप्लिकेशन के लिए ज़रूरी हैं.

5. अपने ऐप्लिकेशन रजिस्ट्रेशन की खास जानकारी देखें. बदलाव करने के लिए, बदलाव करें पर क्लिक करें. अगर ऐप्लिकेशन पंजीकरण के लिए ठीक लगता है, तो डैशबोर्ड पर वापस जाएं पर क्लिक करें.

डेस्कटॉप ऐप्लिकेशन के लिए क्रेडेंशियल को अनुमति दें

असली उपयोगकर्ताओं की पुष्टि करने और अपने ऐप्लिकेशन में उपयोगकर्ता का डेटा ऐक्सेस करने के लिए, आपको ये काम करने होंगे एक या उससे ज़्यादा OAuth 2.0 क्लाइंट आईडी बनाएं. Client-ID का इस्तेमाल, के लिए एक ऐप्लिकेशन बनाया है. अगर आपका ऐप्लिकेशन एक से ज़्यादा प्लैटफ़ॉर्म पर चलता है, आपको हर प्लैटफ़ॉर्म के लिए एक अलग क्लाइंट आईडी बनाना होगा.

1. Google Cloud Console में, मेन्यू menu > एपीआई और सेवाएं > क्रेडेंशियल.

   क्रेडेंशियल पर जाएं

2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
3. ऐप्लिकेशन टाइप > डेस्कटॉप ऐप्लिकेशन पर क्लिक करें.
4. नाम फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम लिखें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
5. बनाएं पर क्लिक करें. OAuth क्लाइंट की बनाई गई स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट सीक्रेट दिखेगा.
6. ठीक है पर क्लिक करें. नया क्रेडेंशियल, OAuth 2.0 क्लाइंट आईडी के तहत दिखता है.
7. डाउनलोड की गई JSON फ़ाइल को credentials.json के तौर पर सेव करें और फ़ाइल को अपनी वर्किंग डायरेक्ट्री में सेव कर सकते हैं.

वर्कस्पेस तैयार करना

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

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

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

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

   vault/quickstart/build.gradle

   GitHub पर देखें

   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'Quickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:2.0.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
       implementation 'com.google.apis:google-api-services-vault:v1-rev20220423-2.0.0'
   }
   

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

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

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

   vault/quickstart/src/main/java/Quickstart.java

   GitHub पर देखें

   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.HttpTransport;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.vault.v1.VaultScopes;
   import com.google.api.services.vault.v1.model.*;
   import com.google.api.services.vault.v1.Vault;
   
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.util.Arrays;
   import java.util.List;
   
   public class Quickstart {
     /**
      * Application name.
      */
     private static final String APPLICATION_NAME =
         "Google Vault API Java Quickstart";
   
     /**
      * Directory to store authorization tokens for this application.
      */
     private static final java.io.File DATA_STORE_DIR = new java.io.File("tokens");
     /**
      * Global instance of the JSON factory.
      */
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
     /**
      * Global instance of the scopes required by this quickstart.
      * <p>
      * If modifying these scopes, delete your previously saved credentials
      * at ~/.credentials/vault.googleapis.com-java-quickstart
      */
     private static final List<String> SCOPES =
         Arrays.asList(VaultScopes.EDISCOVERY_READONLY);
     /**
      * Global instance of the {@link FileDataStoreFactory}.
      */
     private static FileDataStoreFactory DATA_STORE_FACTORY;
     /**
      * Global instance of the HTTP transport.
      */
     private static HttpTransport HTTP_TRANSPORT;
   
     static {
       try {
         HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
         DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
       } catch (Throwable t) {
         t.printStackTrace();
         System.exit(1);
       }
     }
   
     /**
      * Creates an authorized Credential object.
      *
      * @return an authorized Credential object.
      * @throws IOException
      */
     public static Credential authorize() throws IOException {
       // Load client secrets.
       InputStream in =
           Quickstart.class.getResourceAsStream("/credentials.json");
       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, SCOPES)
               .setDataStoreFactory(DATA_STORE_FACTORY)
               .setAccessType("offline")
               .build();
       Credential credential = new AuthorizationCodeInstalledApp(
           flow, new LocalServerReceiver()).authorize("user");
       System.out.println(
           "Credentials saved to " + DATA_STORE_DIR.getAbsolutePath());
       return credential;
     }
   
     /**
      * Build and return an authorized Vault client service.
      *
      * @return an authorized Vault client service
      * @throws IOException
      */
     public static Vault getVaultService() throws IOException {
       Credential credential = authorize();
       return new Vault.Builder(HTTP_TRANSPORT, JSON_FACTORY, credential)
           .setApplicationName(APPLICATION_NAME)
           .build();
     }
   
     public static void main(String[] args) throws IOException {
       // Build a new authorized API client service.
       Vault service = getVaultService();
   
       // List the first 10 matters.
       ListMattersResponse response = service.matters().list()
           .setPageSize(10)
           .execute();
       List<Matter> matters = response.getMatters();
       if (matters == null || matters.size() == 0) {
         System.out.println("No matters found.");
         return;
       }
       System.out.println("Matters:");
       for (Matter matter : matters) {
         System.out.printf("%s (%s)\n", matter.getName(),
             matter.getMatterId());
       }
     }
   }

सैंपल चलाएं

1. सैंपल चलाएं:

   gradle run
   

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

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

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

अगले चरण

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