Öğe teslimini entegre etme (Kotlin ve Java)

Java kodunuzdan uygulamanızın öğe paketlerine erişmek için bu kılavuzda yer alan adımları uygulayın.

Kotlin ve Java için derleme

Play Asset Delivery'i projenizin Android uygulama paketine eklemek için aşağıdaki adımları uygulayın. Bu adımları gerçekleştirmek için Android Studio'yu kullanmanız gerekmez.

1. Projenizin build.gradle dosyasında Android Gradle eklentisinin sürümünü 4.0.0 veya daha yeni bir sürüme güncelleyin.

2. Projenizin üst düzey dizininde öğe paketi için bir dizin oluşturun. Bu dizin adı, öğe paketi adı olarak kullanılır. Öğe paketi adları harfle başlamalıdır ve yalnızca harf, rakam ve alt çizgi içerebilir.

3. Öğe paketi dizininde bir build.gradle dosyası oluşturun ve aşağıdaki kodu ekleyin. Öğe paketinin adını ve yalnızca bir yayınlama türünü belirttiğinizden emin olun:

   Groovy

   // 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. Projenin uygulama build.gradle dosyasına, projenizdeki her öğe paketinin adını aşağıdaki gibi ekleyin:

   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. Projenin settings.gradle dosyasına, projenizdeki tüm öğe paketlerini aşağıda gösterildiği gibi ekleyin:

   Groovy

   // 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. Öğe paketi dizininde aşağıdaki alt dizini oluşturun: src/main/assets.

7. Öğeleri src/main/assets dizinine yerleştirin. Burada da alt dizinler oluşturabilirsiniz. Uygulamanızın dizin yapısı şu şekilde görünmelidir:

   • build.gradle
   • settings.gradle
   • app/
   • asset-pack-name/build.gradle
   • asset-pack-name/src/main/assets/your-asset-directories

8. Android App Bundle'ı Gradle ile derleyin. Oluşturulan uygulama paketinde, kök düzeyindeki dizin artık şunları içerir:

   • asset-pack-name/manifest/AndroidManifest.xml: Öğe paketinin tanımlayıcısını ve yayınlama modunu yapılandırır
   • asset-pack-name/assets/your-asset-directories: Öğe paketinin bir parçası olarak yayınlanan tüm öğeleri içeren dizin

   Gradle, her öğe paketi için manifest dosyasını oluşturur ve assets/ dizinini sizin için oluşturur.

9. (İsteğe bağlı) Hızlı takip ve isteğe bağlı yayınlamayı kullanmayı planlıyorsanız Play Asset Delivery Library'yi ekleyin

   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. (İsteğe bağlı) Uygulama paketinizi farklı doku sıkıştırma biçimlerini destekleyecek şekilde yapılandırın.

Play Asset Delivery API ile entegrasyon

Play Asset Delivery Java API, öğe paketleri istemek, indirmeleri yönetmek ve öğelere erişmek için AssetPackManager sınıfını sağlar. Öncelikle projenize Play Asset Delivery kitaplığını eklediğinizden emin olun.

Bu API'yi, erişmek istediğiniz öğe paketinin yayınlama türüne göre uygularsınız. Bu adımlar aşağıdaki akış şemasında gösterilmektedir.

Şekil 1. Öğe paketlerine erişme akış diyagramı

Yükleme sırasında yayınlama

install-time olarak yapılandırılmış öğe paketleri, uygulama başlatıldıktan hemen sonra kullanılabilir. Bu modda sunulan öğelere erişmek için Java AssetManager API'yi kullanın:

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")

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

Hızlı takip ve isteğe bağlı yayınlama

Aşağıdaki bölümlerde, öğe paketlerini indirmeden önce öğe paketleri hakkında nasıl bilgi edineceğiniz, indirme işlemini başlatmak için API'yi nasıl çağıracağınız ve indirilen paketlere nasıl erişeceğiniz gösterilmektedir. Bu bölümler fast-follow ve on-demand öğe paketleri için geçerlidir.

Durumu denetle

Her öğe paketi, uygulamanın dahili depolama alanında ayrı bir klasörde depolanır. Bir öğe paketinin kök klasörünü belirlemek için getPackLocation() yöntemini kullanın. Bu yöntem aşağıdaki değerleri döndürür:

Öğe paketleriyle ilgili indirme bilgilerini alma

Uygulamaların, öğe paketini getirmeden önce indirme boyutunu belirtmesi gerekir. İndirme boyutunu ve paketin indirilip indirilmediğini belirlemek için requestPackStates() veya getPackStates() yöntemini kullanın.

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

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

requestPackStates(), AssetPackStates nesnesi döndüren bir askıya alma işlevidir. getPackStates() ise Task<AssetPackStates> döndüren eşzamansız bir yöntemdir. AssetPackStates nesnesinin packStates() yöntemi bir Map<String, AssetPackState> döndürür. Bu harita, istenen her öğe paketinin durumunu adını temel alan bir anahtarla içerir:

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

Map<String, AssetPackState> AssetPackStates#packStates()

Nihai istek aşağıdaki şekilde gösterilir:

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)
  }
}

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;
            })

Aşağıdaki AssetPackState yöntemleri, öğe paketinin boyutunu, o ana kadar indirilen miktarı (isterseniz) ve uygulamaya aktarılan miktarı sağlar:

• totalBytesToDownload()
• bytesDownloaded()
• transferProgressPercentage()

Bir öğe paketinin durumunu almak için status() yöntemini kullanın. Bu yöntem, durumu AssetPackStatus sınıfındaki sabit bir alana karşılık gelen bir tam sayı olarak döndürür. Henüz yüklenmemiş öğe paketlerinin durumu AssetPackStatus.NOT_INSTALLED olur.

Bir istek başarısız olursa dönüş değeri AssetPackErrorCode sınıfındaki sabit bir alana karşılık gelen errorCode() yöntemini kullanın.

Yükle

Bir öğe paketini ilk kez indirmek veya öğe paketinin güncellemesini tamamlamak için requestFetch() veya fetch() yöntemini kullanın:

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

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

Bu yöntem, paketlerin listesini ve ilk indirme durumlarını ve boyutlarını içeren bir AssetPackStates nesnesi döndürür. requestFetch() veya fetch() üzerinden istenen bir öğe paketi zaten indiriliyorsa indirme durumu döndürülür ve ek indirme işlemi başlatılmaz.

İndirme durumlarını izleme

Öğe paketlerinin yükleme durumunu izlemek için bir AssetPackStateUpdatedListener uygulamanız gerekir. Durum güncellemeleri, bağımsız öğe paketlerinin durumunu izlemeyi desteklemek için paket başına ayrılır. İsteğinizle ilgili diğer tüm indirmeler tamamlanmadan önce mevcut öğe paketlerini kullanmaya başlayabilirsiniz.

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

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

Büyük boyutlu indirmeler

İndirme 200 MB'tan büyükse ve kullanıcı kablosuz ağa bağlı değilse kullanıcı mobil veri bağlantısı kullanarak indirme işlemine devam etmek için açıkça izin verene kadar indirme işlemi başlamaz. Benzer şekilde, indirme işlemi büyükse ve kullanıcının kablosuz bağlantısı kesilirse indirme duraklatılır ve mobil veri bağlantısı kullanılarak devam etmek için açık izin gerekir. Duraklatılmış paketin durumu WAITING_FOR_WIFI olur. Kullanıcıdan izin isteğinde bulunmasını sağlamak için kullanıcı arayüzü akışını tetiklemek üzere showConfirmationDialog() yöntemini kullanın.

Uygulama bu yöntemi çağırmazsa indirme işleminin duraklatıldığını ve yalnızca kullanıcı tekrar kablosuz ağa bağlandığında otomatik olarak devam edeceğini unutmayın.

Kullanıcı onayı gerekli

Bir paketin durumu REQUIRES_USER_CONFIRMATION ise kullanıcı showConfirmationDialog() ile gösterilen iletişim kutusunu kabul edene kadar indirme işlemi devam etmez. Bu durum, uygulama Play tarafından tanınmadığında (ör. uygulama başka cihazdan yüklendiğinde) ortaya çıkabilir. Bu durumda showConfirmationDialog() çağrısının uygulamanın güncellenmesine neden olacağını unutmayın. Güncelleme yapıldıktan sonra öğeleri tekrar istemeniz gerekir.

Aşağıda, bir dinleyicinin örnek uygulaması verilmiştir:

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")
    }
  }
}

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;
      }
    }
}

Alternatif olarak, mevcut indirmelerin durumunu almak için getPackStates() yöntemini de kullanabilirsiniz. AssetPackStates indirme ilerleme durumunu, indirme durumunu ve tüm hata kodlarını içerir.

Öğe paketlerine erişme

İndirme isteği COMPLETED durumuna ulaştıktan sonra dosya sistemi çağrılarını kullanarak bir öğe paketine erişebilirsiniz. Öğe paketinin kök klasörünü almak için getPackLocation() yöntemini kullanın.

Öğeler, öğe paketi kök dizininde assets dizininde saklanır. assetsPath() kolaylık yöntemini kullanarak assets dizininin yolunu alabilirsiniz. Belirli bir öğenin yolunu almak için aşağıdaki yöntemi kullanın:

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)
}

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;
}

Diğer Play Asset Delivery API yöntemleri

Uygulamanızda kullanmak isteyebileceğiniz bazı ek API yöntemleri aşağıda verilmiştir.

İsteği iptal et

Etkin bir öğe paketi isteğini iptal etmek için cancel() simgesini kullanın. Bu isteğin mümkün olan en iyi şekilde işlendiğini unutmayın.

Öğe paketini kaldırma

Bir öğe paketinin kaldırılmasını planlamak için requestRemovePack() veya removePack() simgesini kullanın.

Birden fazla öğe paketinin konumunu alma

Birden fazla öğe paketinin durumunu toplu olarak sorgulamak için getPackLocations() değerini kullanın. Bu değer, öğe paketlerinin ve konumlarının haritasını döndürür. getPackLocations() tarafından döndürülen harita, şu anda indirilmiş ve güncel olan her paket için bir giriş içerir.

Sonraki adım

Play Asset Delivery'yi yerel olarak ve Google Play'den test edin.