बैच अनुरोध भेजें

इस दस्तावेज़ में बताया गया है कि आपके क्लाइंट के कनेक्शन की संख्या को कम करने के लिए, एपीआई कॉल को एक साथ कैसे बैच किया जा सकता है.

यह दस्तावेज़ खास तौर पर Java क्लाइंट लाइब्रेरी का इस्तेमाल करके, बैच में अनुरोध करने के बारे में है. इसका एक सामान्य उदाहरण .NET के लिए Google API क्लाइंट लाइब्रेरी में भी उपलब्ध है. Google Play EMM API के लिए बैच सिस्टम, OData बैच प्रोसेसिंग सिस्टम के लिए इस्तेमाल होने वाले एचटीटीपी सिंटैक्स का ही इस्तेमाल करता है.

खास जानकारी

Google Play EMM API के ज़रिए आपके क्लाइंट के हर अनुरोध की वजह से, ओवरहेड की एक तय रकम बढ़ जाती है. Google Play EMM API बैच में शामिल किया जा सकता है, ताकि आपके क्लाइंट कई एपीआई कॉल को एक ही अनुरोध में रख सकें.

यहां उन स्थितियों के कुछ उदाहरण दिए गए हैं जिनमें आपको बैच बनाने की सुविधा का इस्तेमाल करना चाहिए:

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

इस तरह के मामलों में, हर कॉल को अलग-अलग भेजने के बजाय, उन्हें एक ही अनुरोध में ग्रुप किया जा सकता है. यहां तक कि एक से ज़्यादा उपयोगकर्ताओं के लिए या एक से ज़्यादा Google API के लिए, अनुरोधों को ग्रुप में बांटा जा सकता है.

हालांकि, एक ही बैच में ज़्यादा से ज़्यादा 1, 000 कॉल ही किए जा सकते हैं. अगर आपको इससे ज़्यादा कॉल करने हैं, तो एक से ज़्यादा बैच रिक्वेस्ट भेजें.

बैच के विवरण

एक बैच अनुरोध में कई API कॉल शामिल होते हैं, जिन्हें एक JSON-RPC अनुरोध में जोड़ दिया जाता है. यह सेक्शन नीचे दिए गए सेक्शन में उदाहरण के साथ, बैच रिक्वेस्ट सिंटैक्स की पूरी जानकारी देता है.

ध्यान दें: एक साथ बैच किए गए n अनुरोधों के सेट को, n अनुरोध के तौर पर गिना जाता है. इसे एक अनुरोध के तौर पर नहीं गिना जाता. बैच अनुरोध को प्रोसेस करने से पहले, अनुरोधों के एक सेट में शामिल कर दिया जाता है.

एक बैच अनुरोध का फ़ॉर्मैट

Java क्लाइंट लाइब्रेरी में, हर Google Play EMM API कॉल के लिए अनुरोध बनाने के लिए कॉल मौजूद होता है. उदाहरण के लिए, किसी डिवाइस पर इंस्टॉल किए गए सभी ऐप्लिकेशन की सूची बनाने के लिए, आपको यह तरीका अपनाना होगा:

AndroidEnterprise enterprise = ...;
InstallsListResponse response = enterprise.installs().list(enterpriseId, userId, deviceId)
  .execute();

एक और batch() कॉल है, जो कई अनुरोधों को सूची में जोड़ सकता है, जैसा कि यहां दिखाया गया है:

AndroidEnterprise enterprise = ...;
BatchRequest batchRequest = enterprise.batch();
enterprise.installs().list(enterpriseId, userId, deviceId1).queue(batchRequest, callback1);
enterprise.installs().list(enterpriseId, userId, deviceId2).queue(batchRequest, callback2);
enterprise.installs().list(enterpriseId, userId, deviceId3).queue(batchRequest, callback3);
batchRequest.execute();

जब batchRequest.execute() को कॉल किया जाता है, तो सूची में मौजूद सभी अनुरोधों को एक साथ सर्वर पर, JSON कलेक्शन के तौर पर भेजा जाता है. सर्वर हर हिस्से पर बाहरी अनुरोध के क्वेरी पैरामीटर और हेडर (जैसा सही हो) लागू करता है. इसके बाद, हर हिस्से को एक अलग JSON अनुरोध के तौर पर देखता है.

एक बैच अनुरोध का जवाब

सर्वर हर अलग अनुरोध को एक्ज़ीक्यूट करता है और नतीजे को किसी एक श्रेणी से बने एक रिस्पॉन्स में ग्रुप करता है. क्लाइंट लाइब्रेरी इस जवाब को अलग-अलग जवाबों में बांट देती है. साथ ही, हर रिस्पॉन्स, queue() को भेजे गए कॉलबैक फ़ंक्शन पर भेजा जाता है. कॉलबैक एक इंटरफ़ेस है, जो असफलता की विधि और सफलता की विधि को परिभाषित करता है. उदाहरण के लिए, callback1 को नीचे दिए गए उदाहरण के रूप में लागू किया जाएगा:

private class InstallsCallback implements JsonBatchCallback<InstallsListResponse> {

  @Override
  public void onSuccess(InstallsListResponse response, HttpHeaders responseHeaders) {
    ...
  }

  @Override
  public void onFailure(GoogleJsonError e, HttpHeaders responseHeaders) {
    ...
  }
}

ध्यान दें: सर्वर आपके कॉल को किसी भी क्रम में कर सकता है, इसलिए अपने अनुरोध में बताए गए क्रम में नतीजे पाने के लिए भरोसा न करें. अगर आपको यह पक्का करना है कि किसी ऑर्डर में दो कॉल करें, तो उन्हें एक ही अनुरोध में नहीं भेजा जा सकता. इसके बजाय, खुद पहला अनुरोध भेजें और दूसरा अनुरोध भेजने से पहले, जवाब का इंतज़ार करें.

एक साथ कई अनुरोध भेजने का उदाहरण

नीचे दिए गए उदाहरण में, उपयोगकर्ता के सभी डिवाइसों पर इंस्टॉल किए गए सभी ऐप्लिकेशन की सूची बनाने का तरीका बताया गया है. पहले कॉल का इस्तेमाल एंटरप्राइज़ और उपयोगकर्ता के आईडी को पाने के लिए किया जाता है. साथ ही, इसे क्रम में किया जाना चाहिए. enterprise.devices().list() के ज़रिए सभी डिवाइस आईडी मिलने के बाद, हम एक साथ उपयोगकर्ता के सभी डिवाइसों पर मौजूद सभी ऐप्लिकेशन को पाने का बैच अनुरोध कर सकते हैं.

package com.google.playenterprise.example;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.batch.BatchRequest;
import com.google.api.client.googleapis.batch.json.JsonBatchCallback;
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.http.HttpHeaders;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson.JacksonFactory;
import com.google.api.services.androidenterprise.AndroidEnterprise;
import com.google.api.services.androidenterprise.AndroidEnterprise.Installs;
import com.google.api.services.androidenterprise.AndroidEnterpriseScopes;
import com.google.api.services.androidenterprise.model.Device;
import com.google.api.services.androidenterprise.model.DevicesListResponse;
import com.google.api.services.androidenterprise.model.Enterprise;
import com.google.api.services.androidenterprise.model.Install;
import com.google.api.services.androidenterprise.model.InstallsListResponse;

import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * Lists all the apps installed on all devices of a given user.
 */
public class ListAllInstalls {
  private AndroidEnterprise enterprise;
  private final List<String> installList = new ArrayList<>();

  public static void main(String[] argv) throws Exception {
    if (argv.length != 2) {
      throw new IllegalArgumentException("Usage: ListAllInstalls email jsonFilename");
    } else if (!argv[0].contains("@")) {
      throw new IllegalArgumentException("First parameter should be a valid email.");
    }
    new ListAllInstalls().run(argv[0], argv[1]);
  }

  private void run(String userEmail, String jsonKeyPath) throws IOException {
    enterprise = createAndroidEnterprise(jsonKeyPath);

    // Get the enterprise id, user id, and user devices.
    String domain = userEmail.split("@")[1];
    List<Enterprise> results = enterprise.enterprises().list(domain).execute().getEnterprise();
    if (results.isEmpty()) {
      throw new RuntimeException("No enterprise found.");
    }
    String enterpriseId = results.get(0).getId();
    String userId = enterprise
        .users()
        .list(enterpriseId, userEmail)
        .execute()
        .getUser()
        .get(0)
        .getId();
    List<Device> devices = getAllDevices(enterpriseId, userId);

    // Batch all calls to get installs on all user devices.
    gatherAllInstalls(enterpriseId, userId, devices);

    for (String entry : installList) {
      // Do something.
      System.out.println(entry);
    }
  }

  private List<Device> getAllDevices(String enterpriseId, String userId) throws IOException {
    DevicesListResponse devices = enterprise.devices().list(enterpriseId, userId).execute();
    return devices.getDevice();
  }

  private void gatherAllInstalls(String enterpriseId, String userId, List<Device> devices)
      throws IOException {
    BatchRequest batchRequest = enterprise.batch();
    for (Device device : devices) {
      Installs.List list = enterprise
          .installs().list(enterpriseId, userId, device.getAndroidId());
      // Each callback can take the specifics of the associated request in its constructor.
      list.queue(batchRequest, new InstallsCallback(device.getAndroidId()));
    }
    // Executes all the queued requests and their callbacks, single-threaded.
    batchRequest.execute();
  }

  private class InstallsCallback extends JsonBatchCallback<InstallsListResponse> {
    private final String androidId;

    InstallsCallback(String androidId) {
      this.androidId = androidId;
    }

    @Override
    public void onSuccess(InstallsListResponse response, HttpHeaders responseHeaders) {
      for (Install install : response.getInstall()) {
        installList.add(androidId + "," + install.getProductId());
      }
    }

    @Override
    public void onFailure(GoogleJsonError e, HttpHeaders responseHeaders) {
      throw new RuntimeException("Error fetching a device");
    }
  }

  private AndroidEnterprise createAndroidEnterprise(String jsonKeyPath) throws IOException {
    HttpTransport httpTransport = new NetHttpTransport();
    JsonFactory jsonFactory = new JacksonFactory();

    InputStream is = new BufferedInputStream(new FileInputStream(jsonKeyPath));
    final Credential credential = GoogleCredential.fromStream(is, httpTransport, jsonFactory)
        .createScoped(AndroidEnterpriseScopes.all());

    HttpRequestInitializer httpRequestInitializer = new HttpRequestInitializer() {
      @Override
      public void initialize(HttpRequest request) throws IOException {
        credential.initialize(request);
      }
    };
    return new AndroidEnterprise.Builder(httpTransport, jsonFactory, httpRequestInitializer)
        .build();
  }
}