از FCM و FIAM برای ارسال پیام به کاربران استفاده کنید

۱. قبل از شروع

در این آزمایشگاه کد، یاد می‌گیرید که چگونه قابلیت تعامل با کاربران را چه در حال استفاده از برنامه شما در پیش‌زمینه و چه در پس‌زمینه، اضافه کنید.

206c7ecece550bde.png

پیش‌نیازها

هیچکدام

آنچه یاد خواهید گرفت

  • فایربیس را به برنامه اندروید خود اضافه کنید
  • وابستگی‌های FCM و FIAM را اضافه کنید
  • ارسال پیام تست FCM به برنامه شما
  • ارسال پیام آزمایشی FIAM به برنامه شما

آنچه نیاز دارید

  • اندروید استودیو ۴.۱
  • دستگاه یا شبیه‌ساز اندروید

۲. شروع کنید

کد نمونه را دریافت کنید

مخزن گیت‌هاب را از خط فرمان کلون کنید:

برنامه شروع کننده را وارد کنید

از اندروید استودیو، پوشه codelab-fcm-and-fiam را انتخاب کنید ( پوشه android_studio.png ). این همان فایلی خواهد بود که در مرحله قبل ( File > Open > .../codelab-fcm-and-fiam) کپی شده است.

اکنون باید پروژه FcmAndFiam را در اندروید استودیو باز داشته باشید. اگر هشداری در مورد عدم وجود فایل google-services.json مشاهده کردید، نگران نباشید. این فایل در مرحله بعدی اضافه خواهد شد.

۳. یک پروژه Firebase و برنامه خود را برای استفاده از Firebase تنظیم کنید

ایجاد یک پروژه فایربیس

  1. با استفاده از حساب گوگل خود وارد کنسول فایربیس شوید.
  2. برای ایجاد یک پروژه جدید، روی دکمه کلیک کنید و سپس نام پروژه را وارد کنید (برای مثال، Send messages codelab ).
  3. روی ادامه کلیک کنید.
  4. در صورت درخواست، شرایط Firebase را مرور و قبول کنید و سپس روی ادامه کلیک کنید.
  5. (اختیاری) دستیار هوش مصنوعی را در کنسول Firebase (با نام "Gemini در Firebase") فعال کنید.
  6. برای این آزمایشگاه کد، برای استفاده بهینه از محصولات Firebase به Google Analytics نیاز دارید، بنابراین گزینه Google Analytics را فعال نگه دارید. برای تنظیم Google Analytics، دستورالعمل‌های روی صفحه را دنبال کنید.
  7. روی ایجاد پروژه کلیک کنید، منتظر بمانید تا پروژه شما آماده شود و سپس روی ادامه کلیک کنید.

فایربیس را به برنامه خود اضافه کنید

  1. از صفحه نمای کلی پروژه جدید خود، روی آیکون اندروید کلیک کنید تا گردش کار راه‌اندازی شود.
  2. نام بسته‌ی codelab را وارد کنید: com.google.firebase.codelab.fcmandfiam
  3. پس از افزودن نام بسته، روی «ثبت برنامه» کلیک کنید و سپس «google-services.json» را دانلود کنید تا فایل پیکربندی Firebase Android خود را دریافت کنید. سپس فایل google-services.json را در پوشه app در پروژه خود کپی کنید. پس از دانلود فایل، می‌توانید برای مراحل بعدی نشان داده شده در کنسول، روی «رد شدن» کلیک کنید (این مراحل قبلاً در پروژه build-android-start برای شما انجام شده‌اند).
  4. افزونه‌ی سرویس‌های گوگل را به برنامه‌ی خود اضافه کنید**
    افزونه‌ی google-services از فایل google-services.json برای پیکربندی برنامه‌ی شما جهت استفاده از Firebase استفاده می‌کند. وابستگی افزونه‌ی google-services و خود افزونه باید به ترتیب به فایل‌های ساخت سطح پروژه و برنامه اضافه شده باشند. ورودی‌های زیر را تأیید کنید: build.gradle
    buildscript {
      ...
      dependencies {
        ...
        classpath 'com.google.gms:google-services:4.3.8'
      }
    }
    
    برنامه/ساخت.gradle
    plugins {
      ...
      id: 'com.google.gms.google-services'
    }
    

وابستگی‌ها را اضافه کنید

FCM و FIAM به وابستگی‌های زیر نیاز دارند. این وابستگی‌ها باید از قبل به فایل ساخت سطح برنامه اضافه شده باشند. تأیید کنید که وابستگی‌های زیر اضافه شده‌اند:

برنامه/ساخت.gradle

dependencies {
  ...
  implementation platform('com.google.firebase:firebase-bom:28.4.2')
  implementation 'com.google.firebase:firebase-analytics'
  implementation 'com.google.firebase:firebase-messaging'
  implementation 'com.google.firebase:firebase-inappmessaging-display'
}

پروژه خود را با فایل‌های gradle همگام‌سازی کنید

برای اطمینان از اینکه همه وابستگی‌ها برای برنامه شما در دسترس هستند، باید در این مرحله پروژه خود را با فایل‌های gradle همگام‌سازی کنید. از نوار ابزار اندروید استودیو ، File > Sync Project with Gradle Files را انتخاب کنید.

۴. شناسه‌های لاگ

پیام‌رسانی ابری فایربیس و پیام‌رسانی درون برنامه‌ای فایربیس هر دو از شناسه‌ها برای ارسال پیام به برنامه‌ها استفاده می‌کنند. FCM از یک توکن ثبت نام و FIAM از یک شناسه نصب استفاده می‌کند.

  1. در MainActivity.kt کد زیر را جایگزین TODO کنید تا شناسه‌های مورد نیاز برای ارسال پیام‌ها ثبت شوند:
FirebaseMessaging.getInstance().token.addOnCompleteListener { regTokenTask ->
   if (regTokenTask.isSuccessful) {
       Log.d(TAG, "FCM registration token: ${regTokenTask.result}")
   } else {
       Log.e(TAG, "Unable to retrieve registration token",
           regTokenTask.exception)
   }
}
FirebaseInstallations.getInstance().id.addOnCompleteListener { installationIdTask ->
   if (installationIdTask.isSuccessful) {
       Log.d(TAG, "Firebase Installations ID: ${installationIdTask.result}")
   } else {
       Log.e(TAG, "Unable to retrieve installations ID",
           installationIdTask.exception)
   }
}
  1. دستگاه اندروید خود را وصل کنید و روی Run (اجرا) کلیک کنید اجرا.png ) در نوار ابزار اندروید استودیو. با ضربه زدن روی دکمه‌ی Log Identifiers ، توکن ثبت FCM و شناسه‌ی نصب Firebase در logcat ثبت می‌شوند. خروجی باید به شکل زیر باشد:
D/FcmAndFiam: Firebase Installations ID: emMc5...AsJfb
  FCM registration token: emMc5LART6GV7...r0Q

۵. ارسال پیام آزمایشی FCM

پیام‌های FCM را می‌توان هم از کنسول Firebase و هم از FCM REST API ارسال کرد. در این آزمایشگاه کد، یک پیام اعلان FCM می‌نویسیم و آن را به دستگاه خود ارسال می‌کنیم. پیام‌های اعلان، پیام‌هایی هستند که در ناحیه اعلان سیستم نمایش داده می‌شوند. یک پیام آزمایشی FCM را از طریق زیر ارسال کنید:

  1. مطمئن شوید که برنامه در پس‌زمینه است (به صفحه اصلی بروید)
  2. به کنسول Firebase بروید و در منوی سمت چپ، Cloud Messaging را انتخاب کنید.
  3. ارسال اولین پیام خود را انتخاب کنید
  4. یک عنوان و متن برای پیام اضافه کنید، سپس روی ارسال پیام آزمایشی کلیک کنید

207ced65f5245ada.png

  1. توکن ثبت FCM را اضافه کنید، سپس روی تست کلیک کنید

f3556c6a8a6453fe.png

  1. مشاهده نمایش اعلان روی دستگاه
  2. با ضربه زدن روی اعلان، برنامه باز می‌شود

۶. ارسال پیام آزمایشی FIAM

پیام‌رسانی درون برنامه‌ای فایربیس می‌تواند در نتیجه‌ی رویدادهای مختلف کاربر فعال شود. پیام آزمایشی از رویداد باز شدن برنامه برای فعال‌سازی پیام درون برنامه‌ای استفاده می‌کند. یک پیام آزمایشی FIAM را از طریق موارد زیر ارسال کنید:

  1. مطمئن شوید که برنامه در پس‌زمینه است (به صفحه اصلی بروید)
  2. به کنسول فایربیس بروید و در منوی سمت چپ، گزینه‌ی پیام‌رسانی درون‌برنامه‌ای (In-App Messaging) را انتخاب کنید.
  3. اولین کمپین خود را ایجاد کنید را انتخاب کنید
  4. کمپین بنر برتر را انتخاب کنید و عنوان و متن پیام را وارد کنید
  5. روی تست روی دستگاه کلیک کنید

69f6ea5efff240d1.png

  1. شناسه نصب را اضافه کنید و روی تست کلیک کنید

24b101edfab47144.png

  1. بازگشایی برنامه
  2. مشاهده در پیام برنامه

۷. تبریک

تبریک می‌گوییم، شما با موفقیت هر دو پیام FCM و FIAM را ارسال کردید. اکنون می‌دانید که چگونه با کاربران خود ارتباط برقرار کنید، چه در حال استفاده از برنامه شما در پیش‌زمینه باشند و چه در پس‌زمینه.

مطالعه بیشتر

قدم بعدی چیست؟

  • ارسال پیام به کاربران در برنامه اندروید خودتان.

اسناد مرجع