דף זה תורגם על ידי Cloud Translation API.

שילוב של ביקורות בתוך האפליקציה (מודעות מותאמות)

במדריך הזה מוסבר איך לשלב ביקורות בתוך האפליקציה באמצעות מודעות מותאמות (C או C++ ). יש מדריכי שילוב נפרדים אם משתמשים ב-Kotlin או Java Unity.

סקירה כללית על Native SDK

ערכת ה-SDK המקורית של Play Core היא חלק מספריות הליבה של Google Play למשפחה. ה-SDK של Play Core Native כולל קובץ כותרת מסוג C, review.h, נפח אחסון של ReviewManager מספריות של Java Play In-App Review. קובץ הכותרת הזה מאפשר לאפליקציה קוראים ל-API ישירות מקוד ה-Native. לסקירה כללית של הציבור את הפונקציות הזמינות, עיינו במודול המקורי של 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

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.
For purposes of these terms, "APIs" means Google's APIs, other developer services, and associated software, including any Redistributable Code.
“Redistributable Code” means Google-provided object code or header files that call the APIs.
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.
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.

I have read and agree with the above terms and conditions

Download Play Core Native SDK

play-core-native-sdk-1.14.0.zip

בצע אחת מהפעולות הבאות:
- מתקינים את Android Studio בגרסה 4.0 ואילך. שימוש ב-SDK ממשק משתמש של מנהל להתקנת פלטפורמת Android SDK גרסה 10.0 (רמת API 29).
- להתקין את כלי שורת הפקודה של Android SDK. ולהשתמש ב-sdkmanager כדי להתקין פלטפורמת Android SDK גרסה 10.0 (רמת API 29).
כדי להכין את Android Studio לפיתוח מקורי באמצעות מנהל ה-SDK כדי להתקין את הגרסה העדכנית ביותר CMake ו-Android Native Development Kit (NDK). מידע נוסף על ליצירה או לייבוא של פרויקטים מקוריים, תחילת העבודה עם NDK.

מורידים את קובץ ה-ZIP ומחלצים אותו לצד הפרויקט.

קישור להורדה	גודל	סיכום ביקורת (checksum) SHA-256
	36MiB	782a8522d937848c83a715c9a258b95a3ff2879a7cd71855d137b41c00786a5e

מעדכנים את קובץ 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.1'

        // 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.1")

    // Import these common dependencies.
    implementation("com.google.android.gms:play-services-tasks:18.0.2")
    implementation(files("$playcoreDir/playcore-native-metadata.jar"))
    ...
}

מעדכנים את קובצי 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: לשפר את המוצר, כולל:

שם החבילה של האפליקציה
גרסת החבילה של האפליקציה
גרסת ה-SDK של Play Core Native

הנתונים האלה ייאספו כשתעלו את חבילת האפליקציה אל Play Console. כדי לבטל את ההסכמה לתהליך איסוף הנתונים הזה, צריך להסיר את ייבוא של $playcoreDir/playcore-native-metadata.jar בקובץ build.gradle.

לתשומת ליבך, איסוף הנתונים הזה שקשור לשימוש שלך ב-Play Core Native SDK השימוש של 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, למשל, פעם אחת בכל פריים. הפעולה עשויה להימשך כמה שניות, כך צריך להתחיל את התהליך לפני שהאפליקציה תגיע לנקודה שבה אתם רוצים להציג את תהליך הבדיקה בתוך האפליקציה.

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 (לדוגמה, אחרי השימוש ב-API) תהליך הבדיקה הושלם).

void ReviewManager_destroy();

השלבים הבאים

בודקים את תהליך הבדיקה בתוך האפליקציה כדי לוודא שהשילוב פועל כראוי.