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

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

ภาพรวมของ Native SDK

Play Core Native SDK เป็นส่วนหนึ่งของตระกูลไลบรารี Google Play Core Play Core Native SDK มีไฟล์ส่วนหัว C, review.h ซึ่งรวม ReviewManager จากไลบรารีการแจ้งขอรีวิวในแอปของ Play ใน Java ไฟล์ส่วนหัวนี้ ช่วยให้แอปเรียกใช้ API จากโค้ดเนทีฟได้โดยตรง หากต้องการดูภาพรวมของฟังก์ชันสาธารณะที่พร้อมใช้งาน โปรดดูเอกสารประกอบของโมดูลเนทีฟของรีวิวใน Play

ReviewManager_requestReviewFlow จะเริ่มคำขอที่รวบรวมข้อมูลที่จำเป็นต่อการเปิดตัวโฟลว์การแจ้งให้รีวิวในแอปในภายหลัง คุณติดตามผลลัพธ์ของคำขอได้โดยใช้ ReviewManager_getReviewStatus ดูข้อมูลเพิ่มเติมเกี่ยวกับสถานะทั้งหมดที่ ReviewManager_getReviewStatus สามารถ แสดงได้ที่ ReviewErrorCode

ทั้งฟังก์ชันคำขอและฟังก์ชันเปิดจะแสดงผล REVIEW_NO_ERROR หากฟังก์ชัน สำเร็จ

ตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์

1. เลือกดำเนินการอย่างหนึ่งดังต่อไปนี้

   • ติดตั้ง Android Studio เวอร์ชัน 4.0 ขึ้นไป ใช้ UI ของ SDK Manager เพื่อติดตั้ง Android SDK Platform เวอร์ชัน 10.0 (API ระดับ 29)
   • ติดตั้งเครื่องมือบรรทัดคำสั่งของ Android SDK และใช้ sdkmanager เพื่อติดตั้ง แพลตฟอร์ม Android SDK เวอร์ชัน 10.0 (API ระดับ 29)

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

3. ดาวน์โหลดไฟล์ ZIP แล้วแตกไฟล์ไว้ข้างๆ โปรเจ็กต์

   ลิงก์ดาวน์โหลด	ขนาด	ผลรวมตรวจสอบ SHA-256
   play-core-native-sdk-1.15.3.zip	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 Native SDK อาจรวบรวมข้อมูลที่เกี่ยวข้องกับเวอร์ชันเพื่อให้ Google ปรับปรุงผลิตภัณฑ์ ซึ่งรวมถึง

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

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

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

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

รวม review.h

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

#include "play/review.h"

เริ่มต้น 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 เช่น ทุกเฟรม กระบวนการนี้อาจใช้เวลาไม่กี่วินาที ดังนั้นคุณควรเริ่มกระบวนการนี้ก่อนที่แอปจะถึงจุดที่คุณต้องการแสดงโฟลว์การขอรีวิวในแอป

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();

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

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