ادغام نظرات درون برنامه ای (بومی)

این راهنما نحوه ادغام نظرات درون برنامه ای را با استفاده از کد بومی (C یا C++) در برنامه خود توضیح می دهد. اگر از Kotlin یا Java یا Unity استفاده می کنید، راهنماهای ادغام جداگانه ای وجود دارد.

نمای کلی SDK بومی

Play Core Native SDK بخشی از خانواده کتابخانه‌های Google Play Core است. Play Core Native SDK شامل یک فایل هدر C به review.h است که ReviewManager از کتابخانه‌های Java Play In-App Review می‌پیچد. این فایل هدر به برنامه شما اجازه می دهد تا مستقیماً از کد اصلی شما با API تماس بگیرد. برای یک نمای کلی از عملکردهای عمومی موجود، به مستندات ماژول بومی Play Review مراجعه کنید.

ReviewManager_requestReviewFlow درخواستی را شروع می‌کند که اطلاعات مورد نیاز برای راه‌اندازی جریان بررسی درون‌برنامه را بعداً جمع‌آوری می‌کند. می توانید نتیجه درخواست را با استفاده از ReviewManager_getReviewStatus ردیابی کنید. برای اطلاعات بیشتر در مورد تمام وضعیت هایی که ReviewManager_getReviewStatus می تواند برگرداند، به ReviewErrorCode مراجعه کنید.

هر دو تابع درخواست و راه‌اندازی در صورت موفقیت‌آمیز بودن عملکرد، REVIEW_NO_ERROR برمی‌گردانند.

محیط توسعه خود را تنظیم کنید

Download Play Core Native SDK

Before downloading, you must agree to the following terms and conditions.

Terms and Conditions

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.
Download Play Core Native SDK

play-core-native-sdk-1.15.3.zip

  1. یکی از موارد زیر را انجام دهید:

    • Android Studio نسخه 4.0 یا بالاتر را نصب کنید. از رابط کاربری SDK Manager برای نصب Android SDK Platform نسخه 10.0 (سطح API 29) استفاده کنید.
    • ابزارهای خط فرمان Android SDK را نصب کنید و از sdkmanager برای نصب Android SDK Platform نسخه 10.0 (سطح API 29) استفاده کنید.
  2. Android Studio را برای توسعه بومی با استفاده از مدیر SDK برای نصب جدیدترین کیت توسعه CMake و Android Native (NDK) آماده کنید. برای اطلاعات بیشتر در مورد ایجاد یا وارد کردن پروژه های بومی، به شروع با NDK مراجعه کنید.

  3. فایل فشرده را دانلود کرده و در کنار پروژه خود استخراج کنید.

    لینک دانلود اندازه SHA-256 Checksum
    37.8 مگابایت 9db60185185342f28d2c278b60222333608c67bc022e458a25224eaea8c4c4b7
  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.2.2'
            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")
            ...
        }
        
    // 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.2.2")
        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 اجازه دهد محصول را بهبود بخشد، از جمله:

  • نام بسته برنامه
  • نسخه بسته برنامه
  • نسخه Core Native SDK را بازی کنید

وقتی بسته برنامه خود را در Play Console آپلود می کنید، این داده ها جمع آوری می شود. برای انصراف از این فرآیند جمع‌آوری داده، وارد کردن $playcoreDir/playcore-native-metadata.jar در فایل build.gradle حذف کنید.

توجه داشته باشید، این مجموعه داده‌های مربوط به استفاده شما از Play Core Native SDK و استفاده Google از داده‌های جمع‌آوری‌شده مجزا و مستقل از مجموعه وابستگی‌های کتابخانه Google است که در Gradle هنگام آپلود بسته برنامه خود در Play Console اعلام شده است.

پس از اینکه Play Core Native SDK را در پروژه خود ادغام کردید، خط زیر را در فایل‌هایی که حاوی فراخوان‌های API هستند قرار دهید:

شامل بررسی.h

پس از ادغام Play Core Native SDK در پروژه خود، خط زیر را در فایل‌هایی که حاوی فراخوان‌های API هستند قرار دهید:

#include "play/review.h"

API Review را راه اندازی کنید

هر زمان که می خواهید از API استفاده کنید، باید ابتدا آن را با فراخوانی تابع 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_getReviewStatus ، پیشرفت عملیات ReviewManager_requestReviewFlow را کنترل کنید. این ممکن است تا چند ثانیه طول بکشد، بنابراین باید قبل از اینکه برنامه شما به نقطه ای برسد که می خواهید جریان بررسی درون برنامه را نشان دهید، این فرآیند را شروع کنید.

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 بررسی کنید. این به شما امکان می دهد تا منطق را بسته به وضعیت API تعریف کنید. یکی از راه‌های نزدیک شدن به این موضوع این است که وضعیت را به‌عنوان یک متغیر سراسری نگه‌دارید و بررسی کنید که آیا وضعیت 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 پس از اتمام استفاده از API (به عنوان مثال، پس از تکمیل جریان بررسی درون برنامه)، منابع را آزاد کنید.

void ReviewManager_destroy();

مراحل بعدی

جریان بررسی درون برنامه ای برنامه خود را آزمایش کنید تا مطمئن شوید که یکپارچه سازی شما به درستی کار می کند.