این راهنما نحوه فعال کردن بازخورد درونبرنامه را بااستفاده از Firebase App Distribution Android SDK اختیاری شرح میدهد تا آزمایشکنندگان بتوانند بازخوردشان را (ازجمله نماگرفتها) مستقیماً در برنامه ارسال کنند.
قبل از شروع
اگر قبلاً این کار را نکردهاید، Firebase را به پروژه Android خود اضافه کنید.
مرحله ۱: فعال کردن App Distribution Tester API
کنسول Google Cloud را باز کنید و پروژه Firebase خود را انتخاب کنید.
در بخش Firebase App Testers API، روی فعال کردن کلیک کنید.
مرحله ۲: افزودن App Distribution به برنامه
کیت توسعه نرمافزار Android App Distribution از دو کتابخانه تشکیل شده است:
firebase-appdistribution-api: کتابخانه فقط API که میتوانید آن را در همه انواع ساخت اضافه کنید.firebase-appdistribution: پیادهسازی کامل کیت توسعه نرمافزار (اختیاری).
کتابخانه فقط API به کد شما اجازه میدهد کیت توسعه نرمافزار را فراخوانی کند. اگر پیادهسازی کامل کیت توسعه نرمافزار وجود نداشته باشد، این فراخوانیها هیچ تأثیری ندارند.
وابستگی کیت توسعه نرمافزار Android App Distribution را در فایل Gradle ماژول (سطح برنامه) (معمولاً
<project>/<app-module>/build.gradle.ktsیا<project>/<app-module>/build.gradle) اعلام کنید.برای اینکه عملکرد خودبهروزرسانی پیادهسازی کامل کیت توسعه نرمافزار در ساختهای Google Play شما گنجانده نشود، تنوعهای ساخت، ازجمله انواع ساخت یا نسخههای ویژه محصول را که ازطریق App Distribution توزیع خواهید کرد شناسایی کنید.
وابستگی کیت توسعه نرمافزار Android App Distribution را در فایل Gradle (سطح برنامه) واحد (معمولاً
app/build.gradle) اعلام کنید. فقط پیادهسازی کامل کیت توسعه نرمافزار را به انواع مختلفی که منحصراً برای آزمایش پیشانتشار درنظر گرفته شدهاند اضافه کنید:Kotlin
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta21") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta21") }
Java
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta21") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta21") }
بهدنبال ماژول کتابخانه مختص Kotlin هستید؟ از نسخه اکتبر ۲۰۲۳، توسعهدهندگان Kotlin و Java میتوانند به واحد کتابخانه اصلی وابسته باشند. برای جزئیات، پرسشگان مربوط به این طرح را ببینید.
مرحله ۳: پیکربندی بازخورد درونبرنامه
برای جمعآوری بازخورد از آزمونگران، از یکی از راهاندازهای زیر استفاده کنید تا آزمونگران بتوانند بازخورد ارائه دهند:
راهانداز اعلان داخلی: «کیت توسعه نرمافزار Android» App Distribution میتواند اعلان درحال انجامی را نمایش دهد که آزمایشکننده میتواند از هرجایی در برنامه روی آن تکضرب بزند. اگر میخواهید سریعتر شروع کنید و نیازی به سفارشیسازی نحوه ارائه بازخورد توسط آزمایشکنندگان ندارید، از این راهانداز استفاده کنید.
راهانداز سفارشی: میتوانید سازوکار راهانداز خودتان را ارائه دهید، مثلاً تکضرب زدن روی دکمه یا گزینه منو در برنامه یا تکان دادن دستگاه.
وقتی از هرکدام از این راهاندازها استفاده میکنید و آزمایشکننده بازخورد ارسال میکند، کیت توسعه نرمافزار Android اقدامات زیر را انجام میدهد:
نماگرفتی از فعالیت فعلی برنامه میگیرد.
بررسیهایی را اجرا میکند تا مطمئن شود آزمایشکننده ویژگیهای آزمایشی کیت توسعه نرمافزار را فعال کرده است. اگر ویژگیهای آزمایشی فعال نباشد، «کیت توسعه نرمافزار Android» از آزمایشکننده میخواهد با «حساب Google» خود به سیستم App Distribution وارد شود.
فعالیتی تمامصفحه را شروع میکند که به آزمایشکننده امکان میدهد بازخوردش را بنویسد و ارسال کند.
گزینه ۱: راهانداز اعلان
از showFeedbackNotification() برای نمایش اعلان دائمی یا
درجریان در دستگاه آزمایشکننده استفاده کنید تا بتواند با تکضرب زدن روی آن،
بازخورد را شروع کند. وقتی اعلان را پیکربندی میکنید، باید نوشتاری ارائه دهید که قبلاز ارسال بازخورد به آزمایشکننده نشان داده شود و سطح وقفه برای اعلان (مطابق با اهمیت کانال اعلان). اگر میخواهید به آزمایشکنندگان خود درباره جمعآوری و پردازش دادههای بازخوردشان اطلاع دهید، میتوانید از این نوشتار برای ارائه چنین اطلاعیهای استفاده کنید.
وقتی از showFeedbackNotification استفاده میکنید و وقتی برنامه به پسزمینه میرود، اعلان پنهان میشود. اگر میخواهید اعلان را بهطور صریح پنهان کنید،
از cancelFeedbackNotification استفاده کنید. Firebase توصیه میکند
showFeedbackNotification را در onCreate فعالیت اصلیتان قرار دهید.
Kotlin
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
Firebase.appDistribution.showFeedbackNotification(
// Text providing notice to your testers about collection and
// processing of their feedback data
R.string.additionalFormText,
// The level of interruption for the notification
InterruptionLevel.HIGH)
}
}
Java
public class MainActivity extends AppCompatActivity {
FirebaseAppDistribution firebaseAppDistribution =
FirebaseAppDistribution.getInstance();
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
firebaseAppDistribution.showFeedbackNotification(
// Text providing notice to your testers about collection and
// processing of their feedback data
R.string.additionalFormText,
// The level of interruption for the notification
InterruptionLevel.HIGH);
}
}
گزینه ۲: راهانداز سفارشی
از روش startFeedback() برای شروع بازخورد بااستفاده از سازوکار انتخابیتان استفاده کنید. برای مثال، برای راهاندازی بازخورد، ممکن است بخواهید گزینه منوِ «ارسال بازخورد» را به منوِ کنشهای برنامهتان اضافه کنید، یا به آزمایشکنندگان اجازه دهید دستگاهشان را تکان دهند یا نماگرفت بگیرند.
وقتی بازخورد را راهاندازی میکنید، نوشتاری را ارائه دهید که قبلاز ارسال بازخورد به آزمایشکننده نشان داده شود. اگر میخواهید به آزمایشکنندگان خود درباره جمعآوری و پردازش دادههای بازخوردشان اطلاع دهید، میتوانید از این نوشتار برای ارائه چنین اطلاعیهای استفاده کنید.
Kotlin
Firebase.appDistribution.startFeedback(R.string.feedbackMessage)
Java
FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);
مرحله ۴: ساختن و آزمایش کردن پیادهسازی
آزمایش محلی
برای آزمایش پیادهسازیتان بدون نیاز به توزیع برنامه، این مراحل را دنبال کنید:
حالت توسعهدهنده را در دستگاه محلیتان فعال کنید:
adb shell setprop debug.firebase.appdistro.devmode true
برنامهتان را بهعنوان یک نوع پیشانتشار بسازید که شامل کتابخانههای کامل App Distribution باشد و آزمایش کنید که میتوانید بااستفاده از سازوکار پیادهسازیشده در مرحله ۳: پیکربندی بازخورد درونبرنامه، بازخورد را فعال کنید. بازخورد در حالت توسعهدهنده ارسال نمیشود.
پساز آزمایش، میتوانید حالت توسعهدهنده را در دستگاهتان غیرفعال کنید:
adb shell setprop debug.firebase.appdistro.devmode false
آزمایش سرتاسر
برای آزمایش اینکه برنامهتان میتواند بازخورد ارسال کند، برنامهتان را بهعنوان یک نسخه پیشانتشار بسازید که شامل کتابخانههای کامل App Distribution باشد، و پیادهسازیتان را با دنبال کردن این مراحل آزمایش کنید:
نسخه پخش جدیدی از برنامه را در App Distribution بارگذاری کنید.
نسخه پخش برنامه را در حسابی توزیع کنید که اجازه دسترسی به آن را دارید.
برنامه را ازطریق وب App Distribution یا برنامه آزمایشکننده Android بارگیری کنید.
بااستفاده از سازوکار پیادهسازیشده در مرحله ۳: پیکربندی بازخورد درونبرنامهای، بازخورد را راهاندازی کنید.
مطمئن شوید با همان حسابی به سیستم وارد شدهاید که نسخه پخش برنامه را برای آن توزیع کردهاید، و بازخورد ارسال کنید.
بازخوردتان را در کارت نسخه جدید در Firebase کنسول مشاهده کنید.
برای آشنایی با نحوه حل مشکلات رایج، مثل عدم امکان شروع بازخورد توسط آزمایشکنندگان در برنامه، به فعال کردن ویژگیهای آزمایشی با کیت توسعه نرمافزار مراجعه کنید.
مرحله ۵: مدیریت بازخورد آزمایشکننده
پساز اینکه به آزمایشکنندگان اجازه دادید بازخورد ارسال کنند، میتوانید از ابزارهای زیر برای بررسی و اقدام درباره آن بازخورد استفاده کنید:
مشاهده و حذف بازخورد در کنسول Firebase
میتوانید بازخورد کاربر، ازجمله نماگرفتها، را با باز کردن برگه بازخورد آزمایشکننده در زیر نسخه پخش خاصی در کنسول Firebase مرور و حذف کنید. بازخورد کاربر براساس نسخه پخش سازماندهی میشود تا بتوانید نسخهای را که بازخورد به آن مربوط میشود تأیید کنید.
پساز مرور بازخورد کاربر، میتوانید با کلیک کردن روی دکمه حذف بازخورد آن بازخورد را حذف کنید. بازخورد حذفشده از نسخه پخش شما برداشته میشود.
دریافت هشدارهای ایمیلی برای بازخوردهای جدید
برای اینکه پیشاز اقدام، از بازخورد جدید آزمایشکننده مطلع شوید، میتوانید هنگام ارسال بازخورد توسط آزمایشکننده، هشدار ایمیلی دریافت کنید. هشدار ایمیلی شامل بازخورد نوشتاری ارائهشده توسط آزمایشکننده و پیوندی به نماگرفتهای ارسالی او است.
برای دریافت هشدارهای ایمیلی App Distribution بااستفاده از این سازوکار پیشفرض،
باید اجازه firebase.projects.update را داشته باشید. نقشهای زیر بهطور پیشفرض
این اجازه لازم را دارند:
سرپرست Firebase یا
مالک یا ویرایشگر پروژه.
بهطور پیشفرض، هر عضو پروژه که اجازههای لازم را برای دریافت هشدارهای ایمیلی دارد، هنگام ارسال گزارش بازخورد جدید، ایمیلی دریافت خواهد کرد. اعضای پروژه میتوانند بهطور جداگانه از این هشدارها انصراف دهند.
برای غیرفعال کردن هشدارهای ایمیلی، به دریافت هشدارهای Firebase مراجعه کنید.
ارسال بازخورد جدید به ابزارهای شخص ثالث
همچنین میتوانید بااستفاده از Cloud Functions for Firebase، هشدارهای App Distribution را به کانال اعلان ترجیحی تیمتان ارسال کنید. برای مثال، میتوانید تابعی بنویسید که رویداد هشدار را برای بازخورد درونبرنامه جدید ضبط کند و اطلاعات هشدار را در سرویس شخص ثالثی مثل Discord، Slack، یا Jira پست کند.
برای راهاندازی قابلیتهای هشدار پیشرفته بااستفاده از Cloud Functions for Firebase، این مراحل را دنبال کنید:
راهاندازی Cloud Functions for Firebase، که شامل تکالیف زیر است:
Node.js و npm را بارگیری کنید.
Firebase CLI را نصب کنید و به سیستم آن وارد شوید.
Cloud Functions for Firebase را بااستفاده از Firebase CLI مقداردهی اولیه کنید.
تابعی بنویسید و مستقر کنید که رویداد هشدار بازخورد درونبرنامه را از App Distribution ضبط کند و بار داده رویداد را مدیریت کند (برای مثال، اطلاعات هشدار را در پیامی در Discord پست کند).
برای دیدن نمونه تابعی که نحوه ارسال بازخورد جدید به Jira را نشان میدهد، به این نمونه توابع مراجعه کنید.
برای آشنایی با همه رویدادهای هشداری که میتوانید ضبط کنید، به سند مرجع هشدارهای App Distribution مراجعه کنید.