دمج المراجعات داخل التطبيق (أصلية)

يصف هذا الدليل كيفية دمج المراجعات داخل التطبيق في تطبيقك باستخدام رمز مدمج مع المحتوى (C أو C++ ). تتوفّر أدلة دمج منفصلة إذا كنت تستخدم Kotlin أو Java أو Unity.

نظرة عامة على حزمة تطوير البرامج (SDK) الأصلية

إنّ حزمة تطوير البرامج (SDK) الأصلية لمكتبة Play الأساسية هي جزء من مجموعة مكتبات Google Play الأساسية. تتضمّن حزمة تطوير البرامج (SDK) الأصلية لمكتبة Play Core ملف رأس C، اسمه review.h، يلتف ReviewManager من مكتبات المراجعات داخل التطبيق في Java Play. يتيح ملف الرأس هذا لتطبيقك استدعاء واجهة برمجة التطبيقات مباشرة من التعليمات البرمجية الأصلية. للحصول على نظرة عامة على الوظائف العامة المتاحة، يمكنك مراجعة مستندات الوحدة الأصلية لمراجعة Play.

يبدأ ReviewManager_requestReviewFlow طلبًا يجمع المعلومات المطلوبة لبدء مسار المراجعة داخل التطبيق لاحقًا. يمكنك تتبُّع نتيجة الطلب باستخدام ReviewManager_getReviewStatus. لمزيد من المعلومات عن جميع الحالات التي يمكن لـ "ReviewManager_getReviewStatus" عرضها، يمكنك الاطّلاع على ReviewErrorCode.

تعرض دالتا الطلب والإطلاق REVIEW_NO_ERROR إذا نجحت الدالة.

إعداد بيئة التطوير

تنزيل 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.14.0.zip

  1. عليك القيام بأي مما يلي:

  2. يمكنك إعداد "استوديو Android" لتطوير البرامج الأصلية باستخدام مدير SDK لتثبيت أحدث إصدار من CMake وAndroid Native Development Kit (NDK). لمزيد من المعلومات حول إنشاء مشاريع أصلية أو استيرادها، راجع بدء استخدام NDK.

  3. يمكنك تنزيل ملف ZIP واستخراجه بجانب مشروعك.

    رابط التنزيل حجم الملف المجموع الاختباري لخوارزمية SHA-256
    36 ميبيبايت 782a8522d937848c83a715c9a258b95a3ff2879a7cd71855d137b41c00786a5e
  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.0.0'
            implementation 'com.google.android.play:asset-delivery:2.0.0'
            implementation 'com.google.android.play:integrity:1.0.1'
            implementation 'com.google.android.play:review:2.0.0'
    
            // 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.0.0")
        implementation("com.google.android.play:asset-delivery:2.0.0")
        implementation("com.google.android.play:integrity:1.0.1")
        implementation("com.google.android.play:review:2.0.0")
    
        // 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
            ...)
    

جمع البيانات

قد تجمع حزمة تطوير البرامج (SDK) الأصلية لمكتبة Play الأساسية البيانات ذات الصلة بالإصدار للسماح لشركة Google بتحسين المنتج، بما في ذلك:

  • اسم حزمة التطبيق
  • إصدار حزمة التطبيق
  • إصدار Play Core Native SDK

سيتم جمع هذه البيانات عند تحميل حزمة تطبيقك على Play Console. لإيقاف عملية جمع البيانات هذه، عليك إزالة عملية استيراد $playcoreDir/playcore-native-metadata.jar في ملف create.gradle.

يُرجى العلم أنّ عملية جمع البيانات هذه المتعلّقة باستخدام حزمة تطوير البرامج (SDK) الأصلية لـ Play Core واستخدام Google للبيانات التي يتم جمعها هي عملية منفصلة ومستقلة عن مجموعة Google من العناصر التابعة للمكتبات والمعلَن عنها في أداة Gradle عند تحميل حزمة التطبيق إلى Play Console.

بعد دمج حزمة تطوير البرامج (SDK) الأصلية لمكتبة Play الأساسية في مشروعك، يمكنك تضمين السطر التالي في الملفات التي تحتوي على طلبات البيانات من واجهة برمجة التطبيقات:

تضمين Review.h

بعد دمج حزمة تطوير البرامج (SDK) الأصلية لمكتبة Play الأساسية في مشروعك، ضمِّن السطر التالي في الملفات التي ستحتوي على طلبات البيانات من واجهة برمجة التطبيقات:

#include "play/review.h"

إعداد واجهة برمجة التطبيقات الخاصة بالمراجعة

عندما تريد استخدام واجهة برمجة التطبيقات، عليك إعدادها أولاً من خلال استدعاء الدالة ReviewManager_init، كما هو موضّح في المثال التالي الذي تم إنشاؤه باستخدام android_native_app_glue.h:

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

  ReviewErrorCode error_code = ReviewManager_init(app->activity->vm, app->activity->clazz);
  if (error_code == REVIEW_NO_ERROR) {
    // You can use the API.
  }
}

طلب مسار المراجعة داخل التطبيق

يمكنك اتّباع الإرشادات المتعلقة بالوقت المناسب لطلب إجراء مراجعات داخل التطبيق لتحديد النقاط المناسبة في مسار مستخدم التطبيق، وذلك للطلب من المستخدم إجراء مراجعة (على سبيل المثال، بعد أن يغلق المستخدم شاشة الملخّص في نهاية مستوى في لعبة ما). عندما يقترب تطبيقك من إحدى هذه النقاط، يمكنك طلب ReviewManager_requestReviewFlow لطلب المعلومات التي يحتاجها التطبيق بشكل غير متزامن لبدء مسار مراجعة داخل التطبيق. راقِب تقدُّم عملية ReviewManager_requestReviewFlow من خلال استدعاء ReviewManager_getReviewStatus، مرة واحدة كل إطار على سبيل المثال. قد يستغرق ذلك ما يصل إلى بضع ثوانٍ، لذلك يجب أن تبدأ هذه العملية قبل أن يصل تطبيقك إلى النقطة التي تريد فيها إظهار تدفق المراجعة داخل التطبيق.

ReviewErrorCode error_code = ReviewManager_requestReviewFlow();
if (error_code == REVIEW_NO_ERROR) {
    // The request has successfully started, check the status using
    // ReviewManager_getReviewStatus.
} else {
    // Error such as REVIEW_PLAY_STORE_NOT_FOUND indicating that the in-app
    // review isn't currently possible.
}

التعامل مع الحالات وبدء عملية المراجعة داخل التطبيق

عند بدء طلب أو بدء عملية المراجعة داخل التطبيق، يمكنك التحقّق من حالته باستخدام ReviewManager_getReviewStatus. ويتيح لك ذلك تحديد المنطق استنادًا إلى حالة واجهة برمجة التطبيقات. يمكن التعامل مع هذا من خلال إبقاء الحالة كمتغيّر عمومي والتحقّق مما إذا كانت الحالة هي REVIEW_REQUEST_FLOW_COMPLETED عندما ينفِّذ المستخدم إجراءً معيّنًا (على سبيل المثال، النقر على زر "المستوى التالي" في لعبة)، كما هو موضّح في المثال التالي:

ReviewStatus status;
ReviewErrorCode error_code = ReviewManager_getReviewStatus(&status);
if (error_code != REVIEW_NO_ERROR) {
    // There was an error with the most recent operation.
    return;
}

switch (status) {
    case REVIEW_REQUEST_FLOW_PENDING:
        // Request is ongoing. The flow can't be launched yet.
        break;
    case REVIEW_REQUEST_FLOW_COMPLETED:
        // Request completed. The flow can be launched now.
        break;
    case REVIEW_LAUNCH_FLOW_PENDING:
        // The review flow is ongoing, meaning the dialog might be displayed.
        break;
    case REVIEW_LAUNCH_FLOW_COMPLETED:
        // The review flow has finished. Continue with your app flow (for
        // example, move to the next screen).
        break;
    default:
        // Unknown status.
        break;
}

عندما تكون الحالة "REVIEW_REQUEST_FLOW_COMPLETED" ويصبح تطبيقك جاهزًا، يمكنك بدء عملية المراجعة داخل التطبيق:

// This call uses android_native_app_glue.h.
ReviewErrorCode error_code = ReviewManager_launchReviewFlow(app->activity->clazz);
if (error_code != REVIEW_NO_ERROR) {
    // There was an error while launching the flow.
    return;
}

بعد بدء مسار المراجعة داخل التطبيق، استمر في التحقق من حالة اكتمال العملية واستمر في سير التطبيق. هناك طريقة شائعة للتعامل مع هذا الأمر، وهي اتباع نمط حلقة الألعاب.

مراجع مجانية

ولا تنسَ توفير الموارد من خلال طلب الوظيفة ReviewManager_destroy بعد انتهاء تطبيقك من استخدام واجهة برمجة التطبيقات (على سبيل المثال، بعد اكتمال عملية المراجعة داخل التطبيق).

void ReviewManager_destroy();

الخطوات التالية

يمكنك اختبار مسار المراجعة داخل التطبيق للتحقق من أن عملية الدمج تعمل بشكل صحيح.