این راهنما نحوه فعال کردن بازخورد درون برنامهای را با استفاده از Firebase App Distribution Android SDK توضیح میدهد تا آزمایشکنندگان شما بتوانند بازخورد (از جمله تصاویر صفحه) را مستقیماً در برنامه ارسال کنند.
قبل از شروع
اگر قبلاً این کار را نکردهاید، Firebase را به پروژه Android خود اضافه کنید .
مرحله 1: App Distribution Tester API را فعال کنید
کنسول Google Cloud را باز کنید و پروژه Firebase خود را انتخاب کنید.
در زیر Firebase App Testers API، روی فعال کردن کلیک کنید.
مرحله 2: App Distribution به برنامه خود اضافه کنید
SDK Android App Distribution از دو کتابخانه تشکیل شده است:
-
firebase-appdistribution-api
: کتابخانه فقط API، که میتوانید آن را در همه انواع ساختها قرار دهید. -
firebase-appdistribution
: اجرای کامل SDK (اختیاری).
کتابخانه فقط API به کد شما اجازه میدهد با SDK تماس بگیرد. اگر اجرای کامل SDK وجود نداشته باشد، تماس ها تاثیری ندارند.
وابستگی App Distribution Android SDK را در فایل Gradle ماژول (سطح برنامه) خود اعلام کنید (معمولا
<project>/<app-module>/build.gradle.kts
یا<project>/<app-module>/build.gradle
).برای جلوگیری از گنجاندن عملکرد خود بهروزرسانی کامل اجرای SDK در ساختهای Google Play خود، انواع ساختها را شناسایی کنید، از جمله انواع ساخت یا طعمهای محصولی که از طریق App Distribution توزیع خواهید کرد.
وابستگی App Distribution Android SDK را در فایل Gradle ماژول (سطح برنامه) خود (معمولا
app/build.gradle
) اعلام کنید. اجرای کامل SDK را فقط به انواعی که منحصراً برای آزمایش قبل از انتشار در نظر گرفته شده اند اضافه کنید:Kotlin+KTX
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api-ktx:16.0.0-beta14") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta14") }
Java
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta14") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta14") }
مرحله 3: بازخورد درون برنامه را پیکربندی کنید
برای جمعآوری بازخورد از آزمایشکنندگان، از یکی از محرکهای زیر استفاده کنید تا آزمایشکنندگان بتوانند بازخورد را شروع کنند:
راهانداز اعلان داخلی : App Distribution Android SDK میتواند یک اعلان مداوم را نشان دهد که آزمایشکننده میتواند از هر نقطه برنامه روی آن ضربه بزند. اگر میخواهید سریعتر شروع کنید و نیازی به سفارشی کردن نحوه ارائه بازخورد آزمایشکنندگانتان ندارید، از این راهانداز استفاده کنید.
ماشه سفارشی : میتوانید مکانیسم ماشه خود را ارائه دهید، مانند ضربه زدن روی یک دکمه یا آیتم منو در برنامه یا تکان دادن دستگاه.
وقتی از یکی از این راهاندازها استفاده میکنید و آزمایشکننده بازخورد ارسال میکند، Android SDK اقدامات زیر را انجام میدهد:
اسکرین شات از فعالیت فعلی برنامه می گیرد.
بررسی هایی را انجام می دهد تا مطمئن شود که تستر ویژگی های آزمایش SDK را فعال کرده است. اگر ویژگیهای آزمایشی فعال نباشند، Android SDK از آزمایشکننده میخواهد تا با حساب Google خود وارد App Distribution شود.
یک فعالیت تمام صفحه را شروع می کند که به آزمایش کننده اجازه می دهد بازخورد خود را بنویسد و ارسال کند.
گزینه 1: ماشه اعلان
از showFeedbackNotification()
برای نمایش یک اعلان دائمی یا مداوم در دستگاه آزمایشگر استفاده کنید که می تواند برای شروع بازخورد روی آن ضربه بزند. وقتی اعلان را پیکربندی میکنید، باید متنی را ارائه کنید که قبل از ارسال بازخورد به آزمایشکننده نمایش داده میشود، و سطحی از وقفه برای اعلان (مرتبط با اهمیت کانال اعلان). اگر میخواهید درباره جمعآوری و پردازش دادههای بازخوردشان به آزمایشکنندگان خود اطلاعیه بدهید، میتوانید از متن برای ارائه چنین اخطاری استفاده کنید.
وقتی از showFeedbackNotification()
استفاده می کنید و وقتی برنامه به پس زمینه می رود، اعلان پنهان می شود. اگر میخواهید آشکارا اعلان را پنهان کنید، از cancelFeedbackNotification()
استفاده کنید. توصیه می کنیم که showFeedbackNotification()
در onCreate()
Activity اصلی خود قرار دهید.
Kotlin+KTX
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);
}
}
گزینه 2: ماشه سفارشی
از متد startFeedback()
برای شروع بازخورد با استفاده از مکانیزم انتخابی خود استفاده کنید. به عنوان مثال، برای راهاندازی بازخورد، ممکن است بخواهید یک مورد منوی «ارسال بازخورد» را به منوی عملکرد برنامهتان اضافه کنید، یا به آزمایشکنندگان اجازه دهید دستگاه خود را تکان دهند یا از صفحهنمایش عکس بگیرند . وقتی بازخورد را راهاندازی میکنید، متنی ارائه کنید که قبل از ارسال بازخورد به آزمایشکننده نشان داده میشود. اگر میخواهید درباره جمعآوری و پردازش دادههای بازخوردشان به آزمایشکنندگان خود اطلاعیهای ارائه کنید، میتوانید از این متن برای ارائه چنین اخطاری استفاده کنید.
Kotlin+KTX
Firebase.appDistribution.startFeedback(R.string.feedbackMessage)
Java
FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);
مرحله 4: پیاده سازی خود را بسازید و آزمایش کنید
تست محلی
برای آزمایش پیاده سازی خود بدون نیاز به توزیع اولیه برنامه، این مراحل را دنبال کنید:
حالت برنامه نویس را در دستگاه محلی خود فعال کنید:
adb shell setprop debug.firebase.appdistro.devmode true
برنامهتان را بهعنوان یک نسخه پیشانتشار بسازید که شامل کتابخانههای کامل App Distribution است و آزمایش کنید که میتوانید بازخورد را با استفاده از مکانیسم پیادهسازی شده در مرحله ۳: پیکربندی بازخورد درونبرنامه راهاندازی کنید. در حالت توسعه دهنده بازخورد ارسال نمی شود.
پس از آزمایش، می توانید حالت توسعه دهنده را در دستگاه خود غیرفعال کنید:
adb shell setprop debug.firebase.appdistro.devmode false
تست انتها به انتها
برای آزمایش اینکه برنامه شما میتواند بازخورد ارسال کند، برنامه خود را بهعنوان یک نسخه پیشانتشاری که شامل کتابخانههای App Distribution است، بسازید و اجرای خود را با دنبال کردن این مراحل آزمایش کنید:
یک نسخه جدید برنامه را در App Distribution آپلود کنید.
انتشار برنامه را در حسابی که اجازه دسترسی به آن را دارید، توزیع کنید.
برنامه را از طریق وب App Distribution یا برنامه آزمایش کننده اندروید دانلود کنید.
بازخورد را با استفاده از مکانیزم پیادهسازی شده در مرحله 3 فعال کنید: بازخورد درون برنامه را پیکربندی کنید .
مطمئن شوید با همان حسابی وارد شدهاید که نسخه برنامه را در آن توزیع کردهاید و بازخورد ارسال کنید.
بازخورد خود را در کارت نسخه جدید در کنسول Firebase مشاهده کنید.
برای یادگیری نحوه حل مشکلات رایج، مانند آزمایشکنندگان که نمیتوانند بازخورد را در برنامه شروع کنند، به فعال کردن ویژگیهای آزمایش با SDK مراجعه کنید.
مرحله 5: بازخورد آزمایش کننده را مدیریت کنید
پس از اینکه آزمایشکنندگان خود را برای ارسال بازخورد فعال کردید، میتوانید از ابزارهای زیر برای بررسی و اقدام بر روی آن بازخورد استفاده کنید:
بازخورد را در کنسول 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 را نصب کرده و وارد آن شوید.
با استفاده از Firebase CLI، Cloud Functions for Firebase راه اندازی کنید.
تابعی بنویسید و مستقر کنید که یک رویداد هشدار بازخورد درون برنامهای را از App Distribution گرفته و بار رویداد را مدیریت میکند (به عنوان مثال، اطلاعات هشدار را در پیامی در Discord پست میکند).
برای مشاهده یک تابع مثال که نحوه ارسال بازخورد جدید به Jira را به شما نشان می دهد، به این نمونه مراجعه کنید.
برای اطلاع از همه رویدادهای هشداری که میتوانید ضبط کنید، به مستندات مرجع هشدارهای App Distribution مراجعه کنید.