שילוב העברת נכסים (מודעות מותאמות)

בעזרת השלבים במדריך הזה תוכלו לגשת לחבילות הנכסים של האפליקציה מתוך הקוד שלכם ב-C וב-C++‎.

קוד שילוב לדוגמה זמין ב-GitHub.

פיתוח לתוכן מקורי

כדי להטמיע את Play Asset Delivery בחבילת האפליקציות ל-Android של הפרויקט, פועלים לפי השלבים הבאים. אין צורך להשתמש ב-Android Studio כדי לבצע את השלבים האלה.

  1. מעדכנים את הגרסה של הפלאגין של Android Gradle בקובץ build.gradle של הפרויקט ל-4.0.0 ואילך.

  2. בספרייה ברמה העליונה של הפרויקט, יוצרים ספרייה לחבילת הנכסים. שם הספרייה הזה משמש כשם של חבילת הנכסים. שמות של חבילות נכסים חייבים להתחיל באות, והם יכולים להכיל רק אותיות, מספרים וקווים תחתונים.

  3. בספריית חבילת הנכסים, יוצרים קובץ build.gradle ומוסיפים את הקוד הבא. חשוב לציין את השם של חבילת הנכסים ורק סוג העברה אחד:

    // In the asset pack’s build.gradle file:
plugins {
    id 'com.android.asset-pack'
}

assetPack {
    packName = "asset-pack-name" // Directory name for the asset pack
    dynamicDelivery {
        deliveryType = "[ install-time | fast-follow | on-demand ]"
    }
}

  4. בקובץ build.gradle של האפליקציה בפרויקט, מוסיפים את השם של כל חבילת נכסים בפרויקט, כפי שמתואר בהמשך:

    // In the app build.gradle file:
android {
    ...
    assetPacks = [":asset-pack-name", ":asset-pack2-name"]
}

  5. בקובץ settings.gradle של הפרויקט, צריך לכלול את כל חבילות הנכסים של הפרויקט, כפי שמתואר בהמשך:

    // In the settings.gradle file:
include ':app'
include ':asset-pack-name'
include ':asset-pack2-name'

  6. בספרייה של חבילת הנכסים, יוצרים את ספריית המשנה הבאה: src/main/assets.

  7. מניחים את הנכסים בספרייה src/main/assets. אפשר גם ליצור כאן ספריות משנה. מבנה הספריות של האפליקציה אמור להיראות כך:

    • build.gradle
    • settings.gradle
    • app/
    • asset-pack-name/build.gradle
    • asset-pack-name/src/main/assets/your-asset-directories

  8. פיתוח של Android App Bundle באמצעות Gradle. בחבילת האפליקציות שנוצרה, התיקייה ברמת השורש כוללת עכשיו את הפריטים הבאים:

    • asset-pack-name/manifest/AndroidManifest.xml: הגדרת המזהה של חבילת הנכסים ושל אופן המסירה
    • asset-pack-name/assets/your-asset-directories: הספרייה שמכילה את כל הנכסים שנשלחים כחלק מחבילת הנכסים

    Gradle יוצר את המניפסט לכל חבילת נכסים ומפיק את הספרייה assets/ בשבילכם.

  9. (אופציונלי) מגדירים את חבילת האפליקציות כך שתתמוך בפורמטים שונים של דחיסת טקסטורות.

שילוב עם ספריית Play Asset Delivery

מטמיעים את ה-API הזה בהתאם לסוג המסירה של חבילת הנכסים שאליה רוצים לגשת. השלבים האלה מוצגים בתרשים התהליך הבא.

תרשים תהליך של חבילת נכסים לקוד מקורי

איור 1. תרשים זרימה לגישה לחבילות של נכסים

Play Core Native SDK מספק את קובץ הכותרת play/asset_pack.h ב-C, שמאפשר לבקש חבילות נכסים, לנהל את ההורדות ולגשת לנכסים.

הגדרת סביבת הפיתוח ל-Play Core Native SDK

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 Manager כדי להתקין את CMake ואת Android Native Development Kit (NDK) בגרסה העדכנית ביותר. למידע נוסף על יצירת פרויקטים מקומיים או ייבוא שלהם, קראו את המאמר תחילת העבודה עם NDK.

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

    קישור להורדה גודל סיכום ביקורת (checksum) מסוג 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
        ...)

איסוף נתונים

ערכת ה-SDK של Play Core Native עשויה לאסוף נתונים שקשורים לגרסה כדי לאפשר ל-Google לשפר את המוצר, כולל:

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

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

חשוב לדעת: איסוף הנתונים הזה קשור לשימוש שלכם ב-Play Core Native SDK, והשימוש של Google בנתונים שנאספים הוא נפרד ולא תלוי באיסוף של Google של יחסי התלות בספריות שהוגדרו ב-Gradle כשאתם מעלים את חבילת האפליקציה ל-Play Console.

העברה בזמן ההתקנה

חבילות נכסים שהוגדרו כ-install-time זמינות באופן מיידי עם השקת האפליקציה. משתמשים ב-NDK AAssetManager API כדי לגשת לנכסים שמוצגים במצב הזה:

#include <android/asset_manager.h>
#include <android_native_app_glue.h>
...
AAssetManager* assetManager = app->activity->assetManager;
AAsset* asset = AAssetManager_open(assetManager, "asset-name", AASSET_MODE_BUFFER);
size_t assetLength = AAsset_getLength(asset);
char* buffer = (char*) malloc(assetLength + 1);
AAsset_read(asset, buffer, assetLength);

הפצה ב-fast follow והפצה על פי דרישה

בחלקים הבאים מוסבר איך לאתחל את ה-API, איך לקבל מידע על חבילות נכסים לפני שמורידים אותן, איך להפעיל את ה-API כדי להתחיל את ההורדה ואיך לגשת לחבילות שהורדתם. הקטעים האלה חלים על חבילות נכסים מסוג fast-follow ו-on-demand.

השקת אפליקציה

תמיד צריך לקרוא ל-AssetPackManager_init() כדי לאתחל את ה-API של חבילת הנכסים לפני שמפעילים פונקציה אחרת. בודקים אם יש קודי שגיאה של חבילות נכסים.

#include "play/asset_pack.h"
...
AssetPackErrorCode AssetPackManager_init(JavaVM* jvm, jobject android_context);

בנוסף, חשוב להפעיל את הפונקציות הבאות ב-onPause() וב-onResume() של ANativeActivityCallbacks:

קבלת מידע על הורדה של חבילות נכסים

האפליקציות נדרשות לחשוף את גודל ההורדה לפני אחזור חבילת הנכסים. משתמשים בפונקציה AssetPackManager_requestInfo() כדי להתחיל בקשה אסינכררונית לגודל ההורדה ולבדוק אם החבילה כבר נמצאת בהורדה. לאחר מכן, משתמשים ב-AssetPackManager_getDownloadState() כדי לבדוק את מצב ההורדה (לדוגמה, קוראים לפונקציה הזו פעם לכל פריים בלולאת המשחק). אם הבקשה נכשלת, כדאי לבדוק את קודי השגיאה של חבילות נכסים.

AssetPackErrorCode AssetPackManager_requestInfo();      // Call once
AssetPackErrorCode AssetPackManager_getDownloadState(); // Call once per frame in your game loop

הפונקציה AssetPackManager_getDownloadState() מחזירה את הסוג האטום AssetPackDownloadState בתור מצביע פלט. אפשר להשתמש באותו פוינטר כדי להפעיל את הפונקציות הבאות:

AssetPackDownloadState* state;
AssetPackErrorCode error_code = AssetPackManager_getDownloadState(asset-pack-name, &state);
AssetPackDownloadStatus status = AssetPackDownloadState_getStatus(state);
uint64_t downloadedBytes = AssetPackDownloadState_getBytesDownloaded(state);
uint64_t totalBytes = AssetPackDownloadState_getTotalBytesToDownload(state));
AssetPackDownloadState_destroy(state);

התקנה

משתמשים ב-AssetPackManager_requestDownload() כדי להתחיל להוריד חבילת נכסים בפעם הראשונה או כדי לבקש שהעדכון של חבילת הנכסים יושלם:

AssetPackErrorCode AssetPackManager_requestDownload();  // Call once
AssetPackErrorCode AssetPackManager_getDownloadState(); // Call once per frame in your game loop

הפונקציה AssetPackManager_getDownloadState() מחזירה את הסוג האטום AssetPackDownloadState. מידע נוסף על השימוש בסוג הזה זמין במאמר קבלת פרטי הורדה.

הורדות גדולות

אם ההורדה גדולה מ-200MB והמשתמש לא מחובר לרשת Wi-Fi, ההורדה לא תתחיל עד שהמשתמש ייתן הסכמה מפורשת להמשיך בהורדה באמצעות חיבור לנתונים ניידים. באופן דומה, אם מדובר בהורדה גדולה והמשתמש מאבד את החיבור ל-Wi-Fi, ההורדה מושהית ונדרשת הסכמה מפורשת כדי להמשיך אותה באמצעות חיבור לחבילת גלישה. לחבילה מושהית יש את המצב WAITING_FOR_WIFI. כדי להפעיל את תהליך ממשק המשתמש כדי לבקש מהמשתמש הסכמה, משתמשים באפשרויות הבאות:

אישור נדרש מהמשתמש

אם לחבילה יש את הסטטוס REQUIRES_USER_CONFIRMATION, ההורדה לא תמשיך עד שהמשתמש יאשר את תיבת הדו-שיח שמוצגת עם AssetPackManager_showConfirmationDialog(). הסטטוס הזה יכול להופיע אם האפליקציה לא מזוהה על ידי Play. לתשומת ליבכם: במקרה כזה, קריאה ל-AssetPackManager_showConfirmationDialog() תגרום לעדכון האפליקציה. אחרי העדכון, צריך לשלוח שוב את הבקשה להוספת הנכסים.

גישה לחבילות של נכסים

אפשר לגשת לחבילת נכסים באמצעות קריאות למערכת הקבצים אחרי שבקשת ההורדה מגיעה לסטטוס COMPLETED. כל חבילת נכסים מאוחסנת בספרייה נפרדת באחסון הפנימי של האפליקציה. משתמשים ב-AssetPackManager_getAssetPackLocation() כדי לקבל AssetPackLocation לחבילת הנכסים שצוינה. משתמשים ב-AssetPackLocation_getStorageMethod() במיקום הזה כדי לקבוע את שיטת האחסון:

  • ASSET_PACK_STORAGE_APK: חבילת הנכסים מותקנת כ-APK. במאמר העברה בזמן ההתקנה מוסבר איך לגשת לנכסים האלה.
  • ASSET_PACK_STORAGE_FILES: משתמשים ב-AssetPackLocation_getAssetsPath() כדי לקבל נתיב קובץ לספרייה שמכילה את הנכסים, או null אם הנכסים לא הורדנו. אין לשנות קבצים שהורדתם בנתיב הקובץ הזה.
AssetPackLocation* location;

AssetPackErrorCode error_code = AssetPackManager_getAssetPackLocation(asset-pack-name, &location);

if (error_code == ASSET_PACK_NO_ERROR) {
    AssetPackStorageMethod storage_method = AssetPackLocation_getStorageMethod(location);
    const char* assets_path = AssetPackLocation_getAssetsPath(location);
    AssetPackLocation_destroy(location);
}

אחרי שמאתרים את הנכסים, משתמשים בפונקציות כמו fopen או ifstream כדי לגשת לקבצים.

שיטות אחרות של Play Core API

בהמשך מפורטות כמה שיטות API נוספות שאפשר להשתמש בהן באפליקציה.

ביטול הבקשה

אפשר להשתמש ב-AssetPackManager_cancelDownload() כדי לבטל בקשה פעילה לחבילת נכסים. חשוב לזכור שהבקשה הזו היא פעולה לפי יכולת.

בקשת הסרה

אפשר להשתמש ב-AssetPackManager_requestRemoval() כדי לתזמן את ההסרה של חבילת נכסים.

השלבים הבאים

בודקים את Play Asset Delivery באופן מקומי ומ-Google Play.