इन-ऐप्लिकेशन अपडेट का समर्थन (मूल)

इस गाइड में, नेटिव कोड (C या C++) का इस्तेमाल करके, अपने ऐप्लिकेशन में इन-ऐप्लिकेशन अपडेट की सुविधा को चालू करने का तरीका बताया गया है. Kotlin प्रोग्रामिंग लैंग्वेज या Java प्रोग्रामिंग लैंग्वेज का इस्तेमाल करने पर, एक अलग गाइड उपलब्ध है. इसके अलावा, Unity या Unreal Engine का इस्तेमाल करने पर, एक अलग गाइड उपलब्ध है.

नेटिव SDK टूल के बारे में खास जानकारी

Play Core नेटिव SDK टूल, Play Core SDK फ़ैमिली का हिस्सा है. नेटिव SDK टूल में एक C हेडर फ़ाइल, app_update.h शामिल होती है. यह Java Play In-App Update Library से AppUpdateManager को रैप करती है. इस हेडर फ़ाइल की मदद से, आपके ऐप्लिकेशन को सीधे अपने नेटिव कोड से, इन-ऐप्लिकेशन अपडेट के लिए एपीआई को कॉल करने की अनुमति मिलती है.

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

डाउनलोड करें Play Core Native SDK

डाउनलोड करने से पहले, आपको नीचे दी गई शर्तों को स्वीकार करना होगा.

नियम और शर्तें

Last modified: September 24, 2020
  1. By using the Play Core Software Development Kit, you agree to these terms in addition to the Google APIs Terms of Service ("API ToS"). If these terms are ever in conflict, these terms will take precedence over the API ToS. Please read these terms and the API ToS carefully.
  2. For purposes of these terms, "APIs" means Google's APIs, other developer services, and associated software, including any Redistributable Code.
  3. “Redistributable Code” means Google-provided object code or header files that call the APIs.
  4. Subject to these terms and the terms of the API ToS, you may copy and distribute Redistributable Code solely for inclusion as part of your API Client. Google and its licensors own all right, title and interest, including any and all intellectual property and other proprietary rights, in and to Redistributable Code. You will not modify, translate, or create derivative works of Redistributable Code.
  5. Google may make changes to these terms at any time with notice and the opportunity to decline further use of the Play Core Software Development Kit. Google will post notice of modifications to the terms at https://developer.android.com/guide/playcore/license. Changes will not be retroactive.

  1. इनमें से कोई एक काम करें:

    • Android Studio का 4.0 या इसके बाद का वर्शन इंस्टॉल करें. Android SDK Platform का वर्शन 10.0 (एपीआई लेवल 29) इंस्टॉल करने के लिए, SDK मैनेजर के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करें.
    • Android SDK के कमांड-लाइन टूल इंस्टॉल करें और Android SDK प्लैटफ़ॉर्म का वर्शन 10.0 (एपीआई लेवल 29) इंस्टॉल करने के लिए, sdkmanager का इस्तेमाल करें.

  2. CMake और Android नेटिव डेवलपमेंट किट (NDK) का नया वर्शन इंस्टॉल करने के लिए, SDK मैनेजर का इस्तेमाल करके, Android Studio को नेटिव डेवलपमेंट के लिए तैयार करें. नेटिव प्रोजेक्ट बनाने या इंपोर्ट करने के बारे में ज़्यादा जानने के लिए, NDK का इस्तेमाल शुरू करना लेख पढ़ें.

  3. ZIP फ़ाइल डाउनलोड करें और उसे अपने प्रोजेक्ट के साथ एक्स्ट्रैक्ट करें.

    डाउनलोड करने का लिंक साइज़ SHA-256 चेकसम
    37.8 MiB 9db60185185342f28d2c278b60222333608c67bc022e458a25224eaea8c4c4b7

  4. अपने ऐप्लिकेशन की build.gradle फ़ाइल को यहां दिखाए गए तरीके से अपडेट करें:

    Groovy

        // App build.gradle

    plugins {
      id 'com.android.application'
    }

    // Define a path to the extracted Play Core SDK files.
    // If using a relative path, wrap it with file() since CMake requires absolute paths.
    def playcoreDir = file('../path/to/playcore-native-sdk')

    android {
        defaultConfig {
            ...
            externalNativeBuild {
                cmake {
                    // Define the PLAYCORE_LOCATION directive.
                    arguments "-DANDROID_STL=c++_static",
                              "-DPLAYCORE_LOCATION=$playcoreDir"
                }
            }
            ndk {
                // Skip deprecated ABIs. Only required when using NDK 16 or earlier.
                abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
            }
        }
        buildTypes {
            release {
                // Include Play Core Library proguard config files to strip unused code while retaining the Java symbols needed for JNI.
                proguardFile '$playcoreDir/proguard/common.pgcfg'
                proguardFile '$playcoreDir/proguard/gms_task.pgcfg'
                proguardFile '$playcoreDir/proguard/per-feature-proguard-files'
                ...
            }
            debug {
                ...
            }
        }
        externalNativeBuild {
            cmake {
                path 'src/main/CMakeLists.txt'
            }
        }
    }

    dependencies {
        // Import these feature-specific AARs for each Google Play Core library.
        implementation 'com.google.android.play:app-update:2.1.0'
        implementation 'com.google.android.play:asset-delivery:2.3.0'
        implementation 'com.google.android.play:integrity:1.4.0'
        implementation 'com.google.android.play:review:2.0.2'

        // Import these common dependencies.
        implementation 'com.google.android.gms:play-services-tasks:18.0.2'
        implementation files("$playcoreDir/playcore-native-metadata.jar")
        ...
    }

    Kotlin

    // App build.gradle

plugins {
    id("com.android.application")
}

// Define a path to the extracted Play Core SDK files.
// If using a relative path, wrap it with file() since CMake requires absolute paths.
val playcoreDir = file("../path/to/playcore-native-sdk")

android {
    defaultConfig {
        ...
        externalNativeBuild {
            cmake {
                // Define the PLAYCORE_LOCATION directive.
                arguments += listOf("-DANDROID_STL=c++_static", "-DPLAYCORE_LOCATION=$playcoreDir")
            }
        }
        ndk {
            // Skip deprecated ABIs. Only required when using NDK 16 or earlier.
            abiFilters.clear()
            abiFilters += listOf("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
        }
    }
    buildTypes {
        release {
            // Include Play Core Library proguard config files to strip unused code while retaining the Java symbols needed for JNI.
            proguardFile("$playcoreDir/proguard/common.pgcfg")
            proguardFile("$playcoreDir/proguard/gms_task.pgcfg")
            proguardFile("$playcoreDir/proguard/per-feature-proguard-files")
            ...
        }
        debug {
            ...
        }
    }
    externalNativeBuild {
        cmake {
            path = "src/main/CMakeLists.txt"
        }
    }
}

dependencies {
    // Import these feature-specific AARs for each Google Play Core library.
    implementation("com.google.android.play:app-update:2.1.0")
    implementation("com.google.android.play:asset-delivery:2.3.0")
    implementation("com.google.android.play:integrity:1.4.0")
    implementation("com.google.android.play:review:2.0.2")

    // Import these common dependencies.
    implementation("com.google.android.gms:play-services-tasks:18.0.2")
    implementation(files("$playcoreDir/playcore-native-metadata.jar"))
    ...
}

  5. अपने ऐप्लिकेशन की CMakeLists.txt फ़ाइलों को यहां दिखाए गए तरीके से अपडेट करें:

    cmake_minimum_required(VERSION 3.6)

...

# Add a static library called “playcore” built with the c++_static STL.
include(${PLAYCORE_LOCATION}/playcore.cmake)
add_playcore_static_library()

// In this example “main” is your native code library, i.e. libmain.so.
add_library(main SHARED
        ...)

target_include_directories(main PRIVATE
        ${PLAYCORE_LOCATION}/include
        ...)

target_link_libraries(main
        android
        playcore
        ...)

डेटा का संग्रह

Play Core नेटिव SDK टूल, वर्शन से जुड़ा डेटा इकट्ठा कर सकता है, ताकि Google प्रॉडक्ट को बेहतर बना सके. इसमें यह डेटा शामिल है:

  • ऐप्लिकेशन के पैकेज का नाम
  • ऐप्लिकेशन के पैकेज का वर्शन
  • Play Core के नेटिव SDK टूल का वर्शन

यह डेटा तब इकट्ठा किया जाएगा, जब Play Console में आपका ऐप्लिकेशन पैकेज अपलोड किया जाएगा. डेटा इकट्ठा करने की इस प्रोसेस से ऑप्ट-आउट करने के लिए, $playcoreDir/playcore-native-metadata.jar build.gradle फ़ाइल में इंपोर्ट को हटाएं.

ध्यान दें, Play Core नेटिव SDK टूल के इस्तेमाल से जुड़ा यह डेटा इकट्ठा करने का तरीका और इकट्ठा किए गए डेटा का इस्तेमाल करने का तरीका, दोनों अलग-अलग हैं. साथ ही, यह तरीका, Google के उस डेटा इकट्ठा करने के तरीके से भी अलग है जो Play Console पर ऐप्लिकेशन पैकेज अपलोड करते समय, Gradle में बताई गई लाइब्रेरी डिपेंडेंसी से इकट्ठा किया जाता है.

अपने प्रोजेक्ट में Play Core Native SDK टूल को इंटिग्रेट करने के बाद, एपीआई कॉल वाली फ़ाइलों में यह लाइन शामिल करें:

#include "play/app_update.h"

इन-ऐप्लिकेशन अपडेट एपीआई को शुरू करना

जब भी इन-ऐप्लिकेशन अपडेट एपीआई का इस्तेमाल किया जाता है, तो सबसे पहले AppUpdateManager_init() फ़ंक्शन को कॉल करके उसे शुरू करें. जैसा कि android_native_app_glue.h के साथ बनाए गए नीचे दिए गए उदाहरण में दिखाया गया है:

void android_main(android_app* app) {
  app->onInputEvent = HandleInputEvent;

  AppUpdateErrorCode error_code =
    AppUpdateManager_init(app->activity->vm, app->activity->clazz);
  if (error_code == APP_UPDATE_NO_ERROR) {
    // You can use the API.
  }
}

देखना कि अपडेट उपलब्ध है या नहीं

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

AppUpdateErrorCode error_code = AppUpdateManager_requestInfo()

if (error_code == APP_UPDATE_NO_ERROR) {
    // The request has successfully started, check the result using
    // AppUpdateManager_getInfo.
}

AppUpdateManager_getInfo() का इस्तेमाल करके, अनुरोध की प्रोसेस और नतीजे को ट्रैक किया जा सकता है. गड़बड़ी के कोड के अलावा, यह फ़ंक्शन एक AppUpdateInfo ऑपैक स्ट्रक्चर दिखाता है. इसका इस्तेमाल, अपडेट के अनुरोध के बारे में जानकारी पाने के लिए किया जा सकता है. उदाहरण के लिए, हो सकता है कि आप हर गेम लूप में इस फ़ंक्शन को तब तक कॉल करना चाहें, जब तक कि यह info के लिए कोई नॉन-नल नतीजा न दिखा दे:

AppUpdateInfo* info;
GameUpdate() {

   // Keep calling this in every game loop until info != nullptr
   AppUpdateErrorCode error_code = AppUpdateManager_getInfo(&info);

   if (error_code == APP_UPDATE_NO_ERROR && info != nullptr) {
       // Successfully started, check the result in the following functions
   }
...
}

देखें कि अपडेट पुराना है या नहीं

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

Play Store पर अपडेट उपलब्ध होने के बाद से, बीत चुके दिनों की संख्या देखने के लिए, AppUpdateInfo_getClientVersionStalenessDays() का इस्तेमाल करें:

int32_t staleness_days = AppUpdateInfo_getClientVersionStalenessDays(info);

अपडेट की प्राथमिकता देखना

Google Play Developer API की मदद से, हर अपडेट की प्राथमिकता सेट की जा सकती है. इससे, आपके ऐप्लिकेशन को यह तय करने में मदद मिलती है कि उपयोगकर्ता को अपडेट का सुझाव कितना ज़ोरदार तरीके से देना है. उदाहरण के लिए, अपडेट की प्राथमिकता सेट करने के लिए, यह रणनीति अपनाएं:

  • यूज़र इंटरफ़ेस (यूआई) में छोटे सुधार: कम प्राथमिकता वाला अपडेट; न तो ज़रूरत के मुताबिक अपडेट का अनुरोध करें और न ही तुरंत अपडेट का. सिर्फ़ तब अपडेट करें, जब उपयोगकर्ता आपके ऐप्लिकेशन के साथ इंटरैक्ट न कर रहा हो.
  • परफ़ॉर्मेंस में सुधार: मध्यम प्राथमिकता वाला अपडेट; ज़रूरत के मुताबिक अपडेट का अनुरोध करें.
  • सुरक्षा से जुड़ा अहम अपडेट: ज़्यादा प्राथमिकता वाला अपडेट; तुरंत अपडेट करने का अनुरोध करें.

प्राथमिकता तय करने के लिए, Google Play 0 से 5 के बीच की किसी पूर्णांक वैल्यू का इस्तेमाल करता है. इसमें 0 डिफ़ॉल्ट वैल्यू होती है और 5 सबसे ज़्यादा प्राथमिकता होती है. किसी अपडेट की प्राथमिकता सेट करने के लिए, Google Play Developer API में Edits.tracks.releases में जाकर inAppUpdatePriority फ़ील्ड का इस्तेमाल करें. रिलीज़ में जोड़े गए सभी नए वर्शन को, रिलीज़ के बराबर प्राथमिकता दी जाती है. प्राथमिकता सिर्फ़ नई रिलीज़ को रोल आउट करते समय सेट की जा सकती है. इसे बाद में बदला नहीं जा सकता.

Play Developer API के दस्तावेज़ में बताए गए तरीके के मुताबिक, Google Play Developer API का इस्तेमाल करके प्राथमिकता सेट करें. Edit.tracks: update तरीके में पास किए गए Edit.tracks संसाधन में, इन-ऐप्लिकेशन अपडेट की प्राथमिकता बताएं. यहां दिए गए उदाहरण में, वर्शन कोड 88 और inAppUpdatePriority 5 वाले ऐप्लिकेशन को रिलीज़ करने का तरीका बताया गया है:

{
  "releases": [{
      "versionCodes": ["88"],
      "inAppUpdatePriority": 5,
      "status": "completed"
  }]
}

अपने ऐप्लिकेशन के कोड में, किसी अपडेट के लिए प्राथमिकता का लेवल देखने के लिए, AppUpdateInfo_getPriority() का इस्तेमाल करें:

int32_t priority = AppUpdateInfo_getPriority(info);

अपडेट शुरू करना

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

नीचे दिए गए उदाहरण में, अपडेट के फ़्लो को आसान बनाने के लिए AppUpdateOptions ऑब्जेक्ट बनाया गया है:

// Creates an AppUpdateOptions configuring a flexible in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_FLEXIBLE, &options);

यहां दिए गए उदाहरण में, तुरंत अपडेट होने वाले फ़्लो के लिए AppUpdateOptions ऑब्जेक्ट बनाया गया है:

// Creates an AppUpdateOptions configuring an immediate in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_IMMEDIATE, &options);

AppUpdateOptions ऑब्जेक्ट में एक AllowAssetPackDeletion फ़ील्ड भी होता है, जिससे यह तय होता है कि डिवाइस के स्टोरेज के सीमित होने पर, अपडेट को एसेट पैक मिटाने की अनुमति है या नहीं. यह फ़ील्ड डिफ़ॉल्ट रूप से false पर सेट होता है. हालांकि, इसे true पर सेट करने के लिए, AppUpdateOptions_setAssetPackDeletionAllowed() तरीके का इस्तेमाल किया जा सकता है:

bool allow = true;
AppUpdateErrorCode error_code = AppUpdateOptions_setAssetPackDeletionAllowed(options, allow);

अप-टू-डेट AppUpdateInfo ऑब्जेक्ट और सही तरीके से कॉन्फ़िगर किया गया AppUpdateOptions ऑब्जेक्ट मिलने के बाद, अपडेट फ़्लो का अनुरोध करने के लिए AppUpdateManager_requestStartUpdate() को कॉल करें. साथ ही, आखिरी पैरामीटर के लिए Android गतिविधि jobject को पास करें.

AppUpdateErrorCode request_error_code =
AppUpdateManager_requestStartUpdate(info, options, app->activity->clazz);

संसाधनों को खाली करने के लिए, AppUpdateInfo और AppUpdateOptions के उन इंस्टेंस को रिलीज़ करें जिनकी अब आपको ज़रूरत नहीं है. इसके लिए, AppUpdateInfo_destroy() और AppUpdateOptions_destroy() को कॉल करें.

AppUpdateInfo_destroy(info);
AppUpdateOptions_destroy(options);

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

अपडेट के फ़्लो को आसान बनाने के लिए, अपडेट के मौजूदा स्टेटस को ट्रैक करने के लिए, अप-टू-डेट AppUpdateInfo ऑब्जेक्ट का अनुरोध किया जा सकता है. ऐसा तब किया जा सकता है, जब उपयोगकर्ता ऐप्लिकेशन का इस्तेमाल करता रहे. डाउनलोड पूरा होने के बाद, आपको AppUpdateManager_requestCompleteUpdate() को कॉल करके, अपडेट पूरा होने की प्रोसेस को ट्रिगर करना होगा. इसका उदाहरण यहां दिया गया है:

AppUpdateStatus status = AppUpdateInfo_getStatus(info);
if (status == APP_UPDATE_DOWNLOADED) {
    AppUpdateErrorCode error_code = AppUpdateManager_requestCompleteUpdate();
    if (error_code != APP_UPDATE_NO_ERROR)
    {
      // There was an error while completing the update flow.
    }
}

अपने ऐप्लिकेशन के एपीआई का इस्तेमाल खत्म करने के बाद, AppUpdateManager_destroy() फ़ंक्शन को कॉल करके संसाधनों को खाली करें.

गड़बड़ी ठीक करना

इस सेक्शन में, उन सामान्य गड़बड़ियों को ठीक करने के तरीके बताए गए हैं जिनकी जानकारी AppUpdateErrorCode वैल्यू से मिलती है:

  • -110, APP_UPDATE_INITIALIZATION_NEEDED गड़बड़ी कोड से पता चलता है कि एपीआई को शुरू नहीं किया जा सका. एपीआई को शुरू करने के लिए, AppUpdateManager_init() को कॉल करें.
  • -4, APP_UPDATE_INVALID_REQUEST गड़बड़ी कोड से पता चलता है कि अपडेट फ़्लो के अनुरोध के कुछ पैरामीटर गलत हैं. पक्का करें कि AppUpdateInfo और AppUpdateOptions ऑब्जेक्ट, शून्य न हों और उन्हें सही तरीके से फ़ॉर्मैट किया गया हो.
  • गड़बड़ी का कोड -5, APP_UPDATE_UNAVAILABLE यह दिखाता है कि आपके डिवाइस के लिए कोई अपडेट उपलब्ध नहीं है. पक्का करें कि टारगेट वर्शन में वही पैकेज का नाम, ऐप्लिकेशन आईडी, और साइनिंग पासकोड हो. अगर कोई अपडेट उपलब्ध है, तो ऐप्लिकेशन का कैश मेमोरी मिटाएं और AppUpdateInfo को रीफ़्रेश करने के लिए, AppUpdateManager_requestAppUpdateInfo() को फिर से कॉल करें.
  • -6, APP_UPDATE_NOT_ALLOWED गड़बड़ी कोड से पता चलता है कि AppUpdateOption ऑब्जेक्ट से दिखाए गए अपडेट टाइप की अनुमति नहीं है. अपडेट फ़्लो शुरू करने से पहले, देखें कि AppUpdateInfo ऑब्जेक्ट से यह पता चलता है कि अपडेट टाइप की अनुमति है या नहीं.

अगले चरण

अपने ऐप्लिकेशन के इन-ऐप्लिकेशन अपडेट की जांच करें, ताकि यह पुष्टि की जा सके कि आपका इंटिग्रेशन सही तरीके से काम कर रहा है या नहीं.