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

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

नेटिव एसडीके के बारे में खास जानकारी

Play Core Native SDK, Play Core 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.
डाउनलोड करें Play Core Native SDK

play-core-native-sdk-1.15.4.zip

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

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

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

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

    डाउनलोड करने का लिंक साइज़ SHA-256 चेकसम
    39.6 MiB 92b43246860d4ce4772a3a0786212d9b4781920e112d81b93ca1c5ebd8da89cb

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

    ग्रूवी

        // 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 Native SDK, वर्शन से जुड़ा डेटा इकट्ठा कर सकता है. इससे Google को प्रॉडक्ट को बेहतर बनाने में मदद मिलती है. इसमें यह डेटा शामिल है:

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

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

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

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 के ज़रिए उपयोगकर्ता को अपडेट के बारे में पिछली बार सूचना दिए हुए कितना समय हो गया है. इससे आपको यह तय करने में मदद मिलती है कि आपको फ़्लेक्सिबल अपडेट शुरू करना चाहिए या तुरंत अपडेट करना चाहिए. उदाहरण के लिए, ऐसा हो सकता है कि आपको फ़्लेक्सिबल अपडेट के बारे में उपयोगकर्ता को सूचना देने से पहले कुछ दिन इंतज़ार करना पड़े. इसके बाद, आपको तुरंत अपडेट करने की ज़रूरत हो.

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

int32_t staleness_days = AppUpdateInfo_getClientVersionStalenessDays(info);

अपडेट की प्राथमिकता की जांच करना

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

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

प्राथमिकता तय करने के लिए, 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);
false

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 का मतलब है कि कोई भी लागू होने वाला अपडेट उपलब्ध नहीं है. पक्का करें कि टारगेट वर्शन का पैकेज का नाम, ऐप्लिकेशन आईडी, और हस्ताक्षर करने की कुंजी एक जैसी हो. अगर कोई अपडेट उपलब्ध है, तो ऐप्लिकेशन की कैश मेमोरी मिटाएं और AppUpdateManager_requestAppUpdateInfo() को रीफ़्रेश करने के लिए, फिर से कॉल करें AppUpdateInfo.
  • -6, APP_UPDATE_NOT_ALLOWED गड़बड़ी कोड से पता चलता है कि AppUpdateOption ऑब्जेक्ट से पता चलने वाले अपडेट टाइप की अनुमति नहीं है. अपडेट फ़्लो शुरू करने से पहले, देखें कि AppUpdateInfo ऑब्जेक्ट से यह पता चलता है या नहीं कि अपडेट टाइप की अनुमति है.

अगले चरण

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