ऐसेट डिलीवरी को इंटिग्रेट करना (Kotlin और Java)

अपने Java कोड से अपने ऐप्लिकेशन के एसेट पैक ऐक्सेस करने के लिए, इस गाइड में दिया गया तरीका अपनाएं.

Kotlin और Java के लिए बनाएं

अपने प्रोजेक्ट के Android ऐप्लिकेशन बंडल में Play एसेट डिलीवरी बनाने के लिए, यह तरीका अपनाएं. ये चरण पूरा करने के लिए, आपको Android Studio का इस्तेमाल करने की ज़रूरत नहीं है.

  1. अपने प्रोजेक्ट की build.gradle फ़ाइल में मौजूद 'Android Gradle प्लग इन' के वर्शन को, 4.0.0 या उसके बाद के वर्शन में अपडेट करें.

  2. अपने प्रोजेक्ट की टॉप-लेवल डायरेक्ट्री में, ऐसेट पैक के लिए एक डायरेक्ट्री बनाएं. डायरेक्ट्री के इस नाम का इस्तेमाल, ऐसेट पैक के नाम के तौर पर किया जाता है. ऐसेट पैक के नाम किसी अक्षर से शुरू होने चाहिए. साथ ही, इनमें सिर्फ़ अक्षर, नंबर, और अंडरस्कोर हो सकते हैं.

  3. ऐसेट पैक डायरेक्ट्री में, build.gradle फ़ाइल बनाएं और नीचे दिया गया कोड जोड़ें. पक्का करें कि आपने ऐसेट पैक का नाम और सिर्फ़ एक डिलीवरी टाइप बताया हो:

    ग्रूवी

    // In the asset pack's build.gradle file:
    plugins {
      id 'com.android.asset-pack'
    }
    
    assetPack {
        packName = "asset-pack-name" // Directory name for the asset pack
        dynamicDelivery {
            deliveryType = "[ install-time | fast-follow | on-demand ]"
        }
    }
    

    Kotlin

    // In the asset pack's build.gradle.kts file:
    plugins {
      id("com.android.asset-pack")
    }
    
    assetPack {
      packName.set("asset-pack-name") // Directory name for the asset pack
      dynamicDelivery {
        deliveryType.set("[ install-time | fast-follow | on-demand ]")
      }
    }
    
  4. प्रोजेक्ट के ऐप्लिकेशन की build.gradle फ़ाइल में, अपने प्रोजेक्ट के हर ऐसेट पैक का नाम इस तरह से जोड़ें:

    Groovy

    // In the app build.gradle file:
    android {
        ...
        assetPacks = [":asset-pack-name", ":asset-pack2-name"]
    }
    

    Kotlin

    // In the app build.gradle.kts file:
    android {
        ...
        assetPacks += listOf(":asset-pack-name", ":asset-pack2-name")
    }
    
  5. प्रोजेक्ट की settings.gradle फ़ाइल में, अपने प्रोजेक्ट में सभी ऐसेट पैक शामिल करें, जैसा कि यहां दिखाया गया है:

    ग्रूवी

    // In the settings.gradle file:
    include ':app'
    include ':asset-pack-name'
    include ':asset-pack2-name'
    

    Kotlin

    // In the settings.gradle.kts file:
    include(":app")
    include(":asset-pack-name")
    include(":asset-pack2-name")
    
  6. ऐसेट पैक की डायरेक्ट्री में, यह सबडायरेक्ट्री बनाएं: src/main/assets.

  7. एसेट को src/main/assets डायरेक्ट्री में रखें. यहां पर भी सबडायरेक्ट्री बनाई जा सकती हैं. आपके ऐप्लिकेशन का डायरेक्ट्री स्ट्रक्चर अब इस तरह दिखना चाहिए:

    • build.gradle
    • settings.gradle
    • app/
    • asset-pack-name/build.gradle
    • asset-pack-name/src/main/assets/your-asset-directories
  8. Gradle की मदद से Android ऐप्लिकेशन बंडल बनाएं. जनरेट किए गए ऐप्लिकेशन बंडल में, रूट-लेवल डायरेक्ट्री में अब ये शामिल हैं:

    • asset-pack-name/manifest/AndroidManifest.xml: ऐसेट पैक के आइडेंटिफ़ायर और डिलीवरी मोड को कॉन्फ़िगर करता है
    • asset-pack-name/assets/your-asset-directories: ऐसी डायरेक्ट्री जिसमें ऐसेट पैक के हिस्से के तौर पर डिलीवर की गई सभी ऐसेट शामिल हैं

    Gradle, हर ऐसेट पैक के लिए मेनिफ़ेस्ट जनरेट करता है और आपके लिए assets/ डायरेक्ट्री तैयार करता है.

  9. (ज़रूरी नहीं) अगर आपको फ़ास्ट-फ़ॉलो और मांग पर डिलीवरी की सुविधा इस्तेमाल करनी है, तो Play ऐसेट डिलीवरी लाइब्रेरी को शामिल करें

    Groovy

    implementation "com.google.android.play:asset-delivery:2.2.2"
    // For Kotlin use asset-delivery-ktx
    implementation "com.google.android.play:asset-delivery-ktx:2.2.2"
    

    Kotlin

    implementation("com.google.android.play:asset-delivery:2.2.2")
    // For Kotlin use core-ktx
    implementation("com.google.android.play:asset-delivery-ktx:2.2.2")
    

  10. (ज़रूरी नहीं) अपने ऐप्लिकेशन बंडल को अलग-अलग टेक्सचर कंप्रेस करने के फ़ॉर्मैट के साथ काम करने के लिए कॉन्फ़िगर करें.

Play Asset Delivery API के साथ इंटिग्रेट करना

Play Asset Delivery Java API AssetPackManager क्लास की सुविधा देता है. इसकी मदद से, ऐसेट पैक का अनुरोध करने, डाउनलोड मैनेज करने, और ऐसेट को ऐक्सेस करने की सुविधा मिलती है. सबसे पहले, अपने प्रोजेक्ट में Play की एसेट डिलीवरी लाइब्रेरी जोड़ें.

आपको जिस ऐसेट पैक को ऐक्सेस करना है उसके डिलीवरी टाइप के हिसाब से इस एपीआई को लागू किया जाता है. इन चरणों को नीचे दिए गए फ़्लोचार्ट में दिखाया गया है.

Java प्रोग्रामिंग भाषा के लिए एसेट पैक का फ़्लो डायग्राम

पहली इमेज. ऐसेट पैक को ऐक्सेस करने के लिए फ़्लो डायग्राम

ऐप्लिकेशन इंस्टॉल करते समय डिलीवरी पाएं

install-time के तौर पर कॉन्फ़िगर किए गए ऐसेट पैक, ऐप्लिकेशन लॉन्च करने के बाद तुरंत उपलब्ध हो जाते हैं. इस मोड में इस्तेमाल की जाने वाली ऐसेट ऐक्सेस करने के लिए, Java AssetManager API का इस्तेमाल करें:

Kotlin

import android.content.res.AssetManager
...
val context: Context = createPackageContext("com.example.app", 0)
val assetManager: AssetManager = context.assets
val stream: InputStream = assetManager.open("asset-name")

Java

import android.content.res.AssetManager;
...
Context context = createPackageContext("com.example.app", 0);
AssetManager assetManager = context.getAssets();
InputStream is = assetManager.open("asset-name");

तेज़ी से फ़ॉलो करें और मांग पर डिलीवरी पाएं

यहां दिए गए सेक्शन में, ऐसेट पैक डाउनलोड करने से पहले उनकी जानकारी पाने, डाउनलोड शुरू करने के लिए एपीआई को कॉल करने, और डाउनलोड किए गए पैक ऐक्सेस करने का तरीका बताया गया है. ये सेक्शन, fast-follow और on-demand एसेट पैक पर लागू होते हैं.

स्थिति देखें

हर ऐसेट पैक को ऐप्लिकेशन के इंटरनल स्टोरेज में एक अलग फ़ोल्डर में सेव किया जाता है. किसी ऐसेट पैक का रूट फ़ोल्डर पता करने के लिए, getPackLocation() तरीके का इस्तेमाल करें. इस तरीके से ये वैल्यू मिलती हैं:

रिटर्न वैल्यू स्थिति
मान्य AssetPackLocation ऑब्जेक्ट ऐसेट पैक का रूट फ़ोल्डर, assetsPath() पर तुरंत ऐक्सेस किया जा सकता है
null ऐसेट पैक या ऐसेट उपलब्ध नहीं हैं

एसेट पैक के बारे में डाउनलोड की जानकारी पाना

एसेट पैक को फ़ेच करने से पहले, ऐप्लिकेशन को डाउनलोड का साइज़ बताना होगा. डाउनलोड के साइज़ और पैक के पहले से डाउनलोड हो रहे होने का पता लगाने के लिए, requestPackStates() या getPackStates() का इस्तेमाल करें.

Kotlin

suspend fun requestPackStates(packNames: List<String>): AssetPackStates

Java

Task<AssetPackStates> getPackStates(List<String> packNames)

requestPackStates() एक सस्पेंड फ़ंक्शन है, जो AssetPackStates ऑब्जेक्ट दिखाता है. वहीं, getPackStates() एसिंक्रोनस तरीका है जो Task<AssetPackStates> दिखाता है. AssetPackStates ऑब्जेक्ट का packStates() तरीका, Map<String, AssetPackState> दिखाता है. इस मैप में, अनुरोध किए गए हर एसेट पैक की स्थिति दिखती है. इसकी जानकारी, नाम के हिसाब से दी गई है:

Kotlin

AssetPackStates#packStates(): Map<String, AssetPackState>

Java

Map<String, AssetPackState> AssetPackStates#packStates()

फ़ाइनल अनुरोध इनके हिसाब से दिखाया जाता है:

Kotlin

const val assetPackName = "assetPackName"
coroutineScope.launch {
  try {
    val assetPackStates: AssetPackStates =
      manager.requestPackStates(listOf(assetPackName))
    val assetPackState: AssetPackState =
      assetPackStates.packStates()[assetPackName]
  } catch (e: RuntimeExecutionException) {
    Log.d("MainActivity", e.message)
  }
}

Java

final String assetPackName = "myasset";

assetPackManager
    .getPackStates(Collections.singletonList(assetPackName))
    .addOnCompleteListener(new OnCompleteListener<AssetPackStates>() {
        @Override
        public void onComplete(Task<AssetPackStates> task) {
            AssetPackStates assetPackStates;
            try {
                assetPackStates = task.getResult();
                AssetPackState assetPackState =
                    assetPackStates.packStates().get(assetPackName);
            } catch (RuntimeExecutionException e) {
                Log.d("MainActivity", e.getMessage());
                return;
            })

यहां दिए गए AssetPackState तरीकों से, ऐसेट पैक का साइज़, अब तक डाउनलोड की गई रकम (अगर अनुरोध किया गया है), और ऐप्लिकेशन में पहले ही ट्रांसफ़र की गई रकम की जानकारी मिलती है:

ऐसेट पैक का स्टेटस जानने के लिए, status() मेथड का इस्तेमाल करें. इससे स्टेटस AssetPackStatus क्लास में, कॉन्स्टेंट फ़ील्ड से मेल खाने वाले पूर्णांक के तौर पर दिखता है. ऐसेट पैक के इंस्टॉल न होने पर, उसका स्टेटस AssetPackStatus.NOT_INSTALLED होता है.

अगर कोई अनुरोध पूरा नहीं होता है, तो errorCode() वाले तरीके का इस्तेमाल करें. इस तरीके से मिलने वाली वैल्यू, AssetPackErrorCode क्लास में मौजूद किसी कॉन्स्टेंट फ़ील्ड से मेल खाती है.

इंस्टॉल करें

पहली बार ऐसेट पैक डाउनलोड करने के लिए, requestFetch() या fetch() वाले तरीके का इस्तेमाल करें या ऐसेट पैक को अपडेट करने के लिए कॉल करें:

Kotlin

suspend fun AssetPackManager.requestFetch(packs: List<String>): AssetPackStates

Java

Task<AssetPackStates> fetch(List<String> packNames)

यह तरीका एक AssetPackStates ऑब्जेक्ट दिखाता है. इसमें पैक की सूची के साथ-साथ, डाउनलोड की शुरुआती स्थिति और साइज़ की जानकारी होती है. अगर requestFetch() या fetch() की मदद से अनुरोध किया गया कोई ऐसेट पैक पहले से डाउनलोड हो रहा है, तो डाउनलोड की स्थिति दिखेगी. साथ ही, अतिरिक्त डाउनलोड शुरू नहीं होगा.

डाउनलोड की स्थिति पर नज़र रखना

ऐसेट पैक इंस्टॉल होने की प्रोग्रेस को ट्रैक करने के लिए, आपको AssetPackStateUpdatedListener को लागू करना चाहिए. अलग-अलग ऐसेट पैक की स्थिति को ट्रैक करने के लिए, स्थिति के अपडेट को हर पैक के हिसाब से बांटा गया है. अनुरोध के लिए किए गए सभी डाउनलोड पूरे होने से पहले, उपलब्ध एसेट पैक का इस्तेमाल शुरू किया जा सकता है.

Kotlin

fun registerListener(listener: AssetPackStateUpdatedListener)
fun unregisterListener(listener: AssetPackStateUpdatedListener)

Java

void registerListener(AssetPackStateUpdatedListener listener)
void unregisterListener(AssetPackStateUpdatedListener listener)

बड़े डाउनलोड

अगर डाउनलोड 200 एमबी से ज़्यादा बड़ा है और उपयोगकर्ता वाई-फ़ाई से कनेक्ट नहीं है, तो डाउनलोड तब तक शुरू नहीं होता, जब तक उपयोगकर्ता, मोबाइल डेटा कनेक्शन का इस्तेमाल करके साफ़ तौर पर डाउनलोड करने की सहमति नहीं देता. इसी तरह, अगर डाउनलोड का साइज़ बड़ा है और उपयोगकर्ता का वाई-फ़ाई बंद हो जाता है, तो डाउनलोड रोक दिया जाएगा. साथ ही, मोबाइल डेटा कनेक्शन का इस्तेमाल करके आगे बढ़ने के लिए, साफ़ तौर पर सहमति लेनी होगी. रोके गए पैक का स्टेटस WAITING_FOR_WIFI होता है. उपयोगकर्ता से सहमति लेने का अनुरोध करने के लिए, यूज़र इंटरफ़ेस (यूआई) फ़्लो को ट्रिगर करने के लिए, showConfirmationDialog() तरीका इस्तेमाल करें.

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

उपयोगकर्ता की पुष्टि करना ज़रूरी है

अगर किसी पैक में REQUIRES_USER_CONFIRMATION स्थिति है, तो डाउनलोड तब तक नहीं होगा, जब तक कि उपयोगकर्ता showConfirmationDialog() के साथ दिखाए गए डायलॉग को स्वीकार नहीं कर लेता. यह स्टेटस तब दिख सकता है, जब Play को ऐप्लिकेशन की पहचान न हो. उदाहरण के लिए, अगर ऐप्लिकेशन को अलग से लोड किया गया हो. ध्यान दें कि ऐसे मामले में showConfirmationDialog() को कॉल करने से ऐप्लिकेशन अपडेट हो जाएगा. अपडेट करने के बाद, आपको ऐसेट का फिर से अनुरोध करना होगा.

यहां किसी लिसनर को लागू करने का उदाहरण दिया गया है:

Kotlin

private val activityResultLauncher = registerForActivityResult(
    ActivityResultContracts.StartIntentSenderForResult()
) { result ->
    if (result.resultCode == RESULT_OK) {
        Log.d(TAG, "Confirmation dialog has been accepted.")
    } else if (result.resultCode == RESULT_CANCELED) {
        Log.d(TAG, "Confirmation dialog has been denied by the user.")
    }
}

assetPackManager.registerListener { assetPackState ->
  when(assetPackState.status()) {
    AssetPackStatus.PENDING -> {
      Log.i(TAG, "Pending")
    }
    AssetPackStatus.DOWNLOADING -> {
      val downloaded = assetPackState.bytesDownloaded()
      val totalSize = assetPackState.totalBytesToDownload()
      val percent = 100.0 * downloaded / totalSize

      Log.i(TAG, "PercentDone=" + String.format("%.2f", percent))
    }
    AssetPackStatus.TRANSFERRING -> {
      // 100% downloaded and assets are being transferred.
      // Notify user to wait until transfer is complete.
    }
    AssetPackStatus.COMPLETED -> {
      // Asset pack is ready to use. Start the game.
    }
    AssetPackStatus.FAILED -> {
      // Request failed. Notify user.
      Log.e(TAG, assetPackState.errorCode())
    }
    AssetPackStatus.CANCELED -> {
      // Request canceled. Notify user.
    }
    AssetPackStatus.WAITING_FOR_WIFI,
    AssetPackStatus.REQUIRES_USER_CONFIRMATION -> {
      if (!confirmationDialogShown) {
        assetPackManager.showConfirmationDialog(activityResultLauncher);
        confirmationDialogShown = true
      }
    }
    AssetPackStatus.NOT_INSTALLED -> {
      // Asset pack is not downloaded yet.
    }
    AssetPackStatus.UNKNOWN -> {
      Log.wtf(TAG, "Asset pack status unknown")
    }
  }
}

Java

assetPackStateUpdateListener = new AssetPackStateUpdateListener() {
    private final ActivityResultLauncher<IntentSenderRequest> activityResultLauncher =
      registerForActivityResult(
          new ActivityResultContracts.StartIntentSenderForResult(),
          new ActivityResultCallback<ActivityResult>() {
            @Override
            public void onActivityResult(ActivityResult result) {
              if (result.getResultCode() == RESULT_OK) {
                Log.d(TAG, "Confirmation dialog has been accepted.");
              } else if (result.getResultCode() == RESULT_CANCELED) {
                Log.d(TAG, "Confirmation dialog has been denied by the user.");
              }
            }
          });

    @Override
    public void onStateUpdate(AssetPackState assetPackState) {
      switch (assetPackState.status()) {
        case AssetPackStatus.PENDING:
          Log.i(TAG, "Pending");
          break;

        case AssetPackStatus.DOWNLOADING:
          long downloaded = assetPackState.bytesDownloaded();
          long totalSize = assetPackState.totalBytesToDownload();
          double percent = 100.0 * downloaded / totalSize;

          Log.i(TAG, "PercentDone=" + String.format("%.2f", percent));
          break;

        case AssetPackStatus.TRANSFERRING:
          // 100% downloaded and assets are being transferred.
          // Notify user to wait until transfer is complete.
          break;

        case AssetPackStatus.COMPLETED:
          // Asset pack is ready to use. Start the game.
          break;

        case AssetPackStatus.FAILED:
          // Request failed. Notify user.
          Log.e(TAG, assetPackState.errorCode());
          break;

        case AssetPackStatus.CANCELED:
          // Request canceled. Notify user.
          break;

        case AssetPackStatus.WAITING_FOR_WIFI:
        case AssetPackStatus.REQUIRES_USER_CONFIRMATION:
          if (!confirmationDialogShown) {
            assetPackManager.showConfirmationDialog(activityResultLauncher);
            confirmationDialogShown = true;
          }
          break;

        case AssetPackStatus.NOT_INSTALLED:
          // Asset pack is not downloaded yet.
          break;
        case AssetPackStatus.UNKNOWN:
          Log.wtf(TAG, "Asset pack status unknown")
          break;
      }
    }
}

इसके अलावा, getPackStates() के तरीके का इस्तेमाल करके, मौजूदा डाउनलोड की स्थिति देखी जा सकती है. AssetPackStates इसमें डाउनलोड की प्रोग्रेस, डाउनलोड की स्थिति, और गड़बड़ी के कोड की जानकारी शामिल होती है.

ऐसेट पैक ऐक्सेस करना

डाउनलोड के अनुरोध के COMPLETED स्टेटस पर पहुंचने के बाद, फ़ाइल सिस्टम कॉल का इस्तेमाल करके ऐसेट पैक को ऐक्सेस किया जा सकता है. ऐसेट पैक का रूट फ़ोल्डर पाने के लिए, getPackLocation() तरीका इस्तेमाल करें.

ऐसेट, ऐसेट पैक की रूट डायरेक्ट्री में assets डायरेक्ट्री में सेव की जाती हैं. assets डायरेक्ट्री का पाथ पाने के लिए, assetsPath() के लिए उपलब्ध आसान तरीके का इस्तेमाल करें. किसी खास ऐसेट का पाथ पाने के लिए, यहां दिया गया तरीका अपनाएं:

Kotlin

private fun getAbsoluteAssetPath(assetPack: String, relativeAssetPath: String): String? {
    val assetPackPath: AssetPackLocation =
      assetPackManager.getPackLocation(assetPack)
      // asset pack is not ready
      ?: return null

    val assetsFolderPath = assetPackPath.assetsPath()
    // equivalent to: FilenameUtils.concat(assetPackPath.path(), "assets")
    return FilenameUtils.concat(assetsFolderPath, relativeAssetPath)
}

Java

private String getAbsoluteAssetPath(String assetPack, String relativeAssetPath) {
    AssetPackLocation assetPackPath = assetPackManager.getPackLocation(assetPack);

    if (assetPackPath == null) {
        // asset pack is not ready
        return null;
    }

    String assetsFolderPath = assetPackPath.assetsPath();
    // equivalent to: FilenameUtils.concat(assetPackPath.path(), "assets");
    String assetPath = FilenameUtils.concat(assetsFolderPath, relativeAssetPath);
    return assetPath;
}

Play ऐसेट डिलीवरी एपीआई के अन्य तरीके

नीचे एपीआई के कुछ अन्य तरीकों के बारे में बताया गया है, जिनका इस्तेमाल आपको अपने ऐप्लिकेशन में करना चाहिए.

अनुरोध रद्द करें

ऐसेट पैक के लिए मौजूदा अनुरोध को रद्द करने के लिए, cancel() का इस्तेमाल करें. ध्यान दें कि इस अनुरोध को बेहतर तरीके से करने की कोशिश की जा सकती है.

ऐसेट पैक हटाना

किसी ऐसेट पैक को हटाने का शेड्यूल सेट करने के लिए, requestRemovePack() या removePack() का इस्तेमाल करें.

एक से ज़्यादा ऐसेट पैक की जगहें पाना

एक साथ कई ऐसेट पैक की स्थिति के बारे में क्वेरी करने के लिए, getPackLocations() का इस्तेमाल करें. इससे ऐसेट पैक और उनकी जगहों का मैप दिखता है. getPackLocations() से मिले मैप में, हर उस पैक की एंट्री शामिल होती है जो फ़िलहाल डाउनलोड और अप-टू-डेट है.

अगला चरण

अपने डिवाइस पर और Google Play से Play ऐसेट डिलीवरी की जांच करना.