ผสานรวมรีวิวในแอป (เนทีฟ)

คู่มือนี้อธิบายวิธีผสานรวมรีวิวในแอปโดยใช้โค้ดเนทีฟ (C หรือ C++) เรามีคู่มือการผสานรวมแยกต่างหากหากคุณใช้ Kotlin หรือ Java หรือ Unity

ภาพรวมของ Native 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. เลือกดำเนินการอย่างหนึ่งดังต่อไปนี้

  2. เตรียม Android Studio สําหรับการพัฒนาแบบเนทีฟโดยใช้ SDK Manager เพื่อติดตั้ง CMake และ Android Native Development Kit (NDK) เวอร์ชันล่าสุด ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างหรือนําเข้าโปรเจ็กต์เนทีฟได้ที่การเริ่มต้นใช้งาน 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.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")
            ...
        }
        

    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.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 ปรับปรุงผลิตภัณฑ์ได้ ซึ่งรวมถึงข้อมูลต่อไปนี้

  • ชื่อแพ็กเกจของแอป
  • เวอร์ชันแพ็กเกจของแอป
  • เวอร์ชันของ Play Core Native SDK

ระบบจะรวบรวมข้อมูลนี้เมื่อคุณอัปโหลดแพ็กเกจแอปไปยัง Play Console หากต้องการเลือกไม่ใช้กระบวนการรวบรวมข้อมูลนี้ ให้นําการนําเข้า $playcoreDir/playcore-native-metadata.jar ออกในไฟล์ build.gradle

โปรดทราบว่าการเก็บรวบรวมข้อมูลนี้เกี่ยวข้องกับการใช้ Play Core Native SDK และการใช้ข้อมูลที่เก็บรวบรวมของ Google นั้นแยกจากกันและไม่ได้ขึ้นอยู่กับการเก็บรวบรวมทรัพยากร Dependency ของไลบรารีที่ Google ประกาศไว้ใน Gradle เมื่อคุณอัปโหลดแพ็กเกจแอปไปยัง Play Console

หลังจากผสานรวม Play Core Native SDK เข้ากับโปรเจ็กต์แล้ว ให้ใส่บรรทัดต่อไปนี้ในไฟล์ที่มีการเรียก API

รวม review.h

หลังจากผสานรวม Play Core Native SDK เข้ากับโปรเจ็กต์แล้ว ให้ใส่บรรทัดต่อไปนี้ในไฟล์ที่จะมีการเรียก API

#include "play/review.h"

เริ่มต้นใช้งาน Review API

เมื่อใดก็ตามที่ต้องการใช้ 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_requestReviewFlow โดยเรียกใช้ ReviewManager_getReviewStatus เช่น ทุกๆ เฟรม ซึ่งอาจใช้เวลา 2-3 วินาที คุณจึงควรเริ่มกระบวนการนี้ก่อนที่แอปจะถึงจุดที่ต้องการแสดงขั้นตอนการรีวิวในแอป

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

หลังจากเริ่มขั้นตอนการตรวจสอบในแอปแล้ว ให้ตรวจสอบสถานะจนกว่าจะเสร็จสมบูรณ์ แล้วดำเนินการตามขั้นตอนการส่งแอปต่อ วิธีทั่วไปในการจัดการกับปัญหานี้คือการทำตามรูปแบบ Game Loop

แหล่งข้อมูลฟรี

อย่าลืมเพิ่มพื้นที่ว่างโดยเรียกใช้ฟังก์ชัน ReviewManager_destroy เมื่อแอปของคุณใช้ API เสร็จแล้ว (เช่น หลังจากขั้นตอนการตรวจสอบในแอปเสร็จสมบูรณ์)

void ReviewManager_destroy();

ขั้นตอนถัดไป

ทดสอบขั้นตอนการรีวิวในแอปของแอปเพื่อยืนยันว่าการผสานรวมทำงานได้อย่างถูกต้อง