ویرگول
ورودثبت نام
عامر لطفی اوریمی
عامر لطفی اوریمیدولوپر فرانت‌اند - علاقمند به جاوااسکریپ (تایپ‌اسکریپت)، ری‌اکت، ری‌اکت‌نیتیو - فرانت‌اند دولوپر سابق دیجی‌کالا، دیجی‌کالامگ، شیپور و سیبچه
عامر لطفی اوریمی
عامر لطفی اوریمی
خواندن ۷ دقیقه·۱ ماه پیش

گوگل تگ منیجر توی اکسپو | expo، بدون دست زدن به فولدر‌های نیتیو iOS و Android

Expo و GTM
Expo و GTM

-- مقدمه

چند هفته پیش یک تیم مارکتینگ از تیم تولید درخواست کرد کهGoogle Tag Manager رو به اپ موبایل اضافه کنه. حرفشون هم منطقی بود، می‌خواستن خودشون تگ‌ها رو عوض کنن و رویداد‌ها رو به جاهای جدید بفرستن، بدون اینکه هر بار منتظر یه نسخه جدید از تیم فنی بمونن. تا اینجا همه چیز خوب بود.

ولی اپ ساخته شده، باExpoنوشته شده و از Continuous Native Generation استفاده می‌کرد. یعنی فولدر‌های ios و android اصلا توی گیت نیستن و هر بار با expo prebuild از نو ساخته میشن. حالا هر آموزشی که پیدا می‌شد می‌گفت Xcode رو باز کن، فولدر container رو بکش بنداز توی پروژه، تیک folder reference رو بزن. خوب این برای یه اپ React Native ساده عالیه، ولی توی اکسپو با اولین prebuild --clean همه‌اش میره هوا.

یه دور npm و گیت‌هاب رو زیر و رو کردن بچه‌ها و چیزی که با نسخه جدید GTM کار کنه و مخصوص اکسپو expo باشه پیدا نشد که نشد. آخرش من نشستم و یه پلاگین نوشتم به اسم expo-google-tag-manager و منتشرش کردم، تا مشکلشون برطرف بشه. توی این مقاله می‌خوام یکم از تاریخچه‌اش بگم، بعد اینکه ایده‌اش چیه و آخر هم نصب و استفاده‌اش رو قدم به قدم بگم.

کوتاه بگم: اگر حوصله قصه ندارید، ریپوی گیت‌هاب و پکیج npm در خدمت شماست.


-- یه ریز تاریخچه

قصه GTM توی موبایل از چیزی که فکر می‌کنیم قدیمی‌تره. SDK‌های اولیه که الآن گوگل بهشون میگه Legacy، برای خودشون یه data layer داشتن. شما مقادیر رو push می‌کردی توش و container رو از توی کد باز می‌کردی. توی دنیای ری‌اکت نیتیو هم اون موقع همه از react-native-google-analytics-bridge استفاده می‌کردن که یه بخش GoogleTagManager داشت. بعد‌ها هم یک کتابخونه به نام react-native-google-tag-manager توسط خودم نوشته شد که این کار رو برای اپ‌های ری‌اکت نیتیو انجام میداد و در واقع یک رپر روی قسمت‌های نیتیو iOS و Android بود که توسط خود گوگل ارائه شده بود. منتهی اون روش منسوخ شد و همه چیز به Firebase منتقل شد و دیگه بعد از اون برای GTM روی ری‌اکت نیتیو از react-native-firebase استفاده میشه.

همونطور که توی پاراگراف بالا گفتم، بعدها توی اردیبهشت ۱۳۹۵ (می ۲۰۱۶)، گوگل توی Google I/O نسخه جدید Tag Manager رو معرفی کرد که روی Firebaseساخته شده. اینجا کلا داستان عوض شد. دیگه چیزی رو توی GTMpush نمی‌کنید، اپ شما رویداد‌ها رو بهFirebase Analyticsمی‌فرسته و GTM خودش روی دستگاه گوش وایمیسه (Listen میکنه) و تگ‌ها رو اجرا می‌کنه. آبان ۱۳۹۷ (نوامبر ۲۰۱۸) هم بعد از اینکه گوگل Google Analytics قدیمی برای اپ‌های موبایل رو تعطیل کرد، نگهدارنده اون کتابخونه deprecatedش کرد و گفت همه برن سراغ react-native-firebase.

پس سمت جاوااسکریپت روReact Native Firebaseحل کرد. ولی بخش GTM همچنان یه کار نیتیو باقی موند: یه pod، یه dependency توی Gradle و فایل JSON کانتینر توی فولدر درست. نسخه جدید به این شیوه کار میکنه و دیگه هیچ API ـی نیست که رپ کردنش معنی داشته باشه. کسی هم این رو برای اکسپو expo بسته بندی نکرده بود و اون تیم دقیقا افتاد توی همین چاله (issue) که به فکر من رسید حلش کنم.


-- ایده چیه؟

اگر مستندات GTM for Firebase رو با دقت بخونید، می‌بینید که اصلا API ای نداره که ارزش داشته باشه براش wrapper بنویسیم. GTM فقط سه تا چیز لازم داره:

۱. خودِ SDK نیتیو توی اپ
۲. فایل JSON کانتینر توی bundle اپ، توی یه فولدر مشخص
۳. اگر خواستید، یه URL scheme برای حالت پیش‌نمایش یا همون preview

هر سه تاش تنظیمات نیتیو هستن و تنظیمات نیتیو توی اکسپو دقیقا کار config plugin هست. برای همین پلاگین من فقط همین سه کار رو موقع expo prebuild انجام میده و تمام. نه API جاوااسکریپتی داره، نه bridge اضافه. رویداد‌ها رو مثل قبل با React Native Firebase می‌فرستید.

حالا چه سودی برای یه پروژه اکسپویی داره؟

  • فولدر‌های ios و android همچنان بیرون از گیت می‌مونن و هیچ وقت دستی ادیتشون نمی‌کنید.

  • prebuild --clean بی‌خطره، پلاگین هر بار همه چیز رو سر جاش می‌ذاره.

  • اگر اسم کانتینر رو عوض کنید یا حذفش کنید، فایل قبلی جا نمی‌مونه. چون پلاگین صاحب فولدر‌های container و containers هست و هر بار محتواشون رو از نو می‌سازه.

  • فایل‌های کانتینر رو موقع prebuild چک می‌کنه. اگر فایل نبود، یا اسمش با آیدی GTM یکی نبود، یا JSON معتبر نبود، prebuild با یه پیغام واضح خطا میده. خیلی بهتر از اپی که بی‌صدا هیچی نمی‌فرسته و شما یه هفته بعد می‌فهمید.


-- قبل از شروع

این‌ها رو حتما چک کنید:

  • پروژه اکسپو با expo prebuild یا development build. باExpo Goکار نمی‌کنه، چون Expo Go کد نیتیو جدید رو لود نمی‌کنه.

  • پکیج‌های @react-native-firebase/app و @react-native-firebase/analytics نصب و تنظیم شده باشن، با GoogleService-Info.plist و google-services.json. GTM به Firebase گوش میده، پس اول باید Firebase سالم کار کنه.

  • فریمورک استاتیک یا همون static frameworks روی iOS از طریق expo-build-properties. خود React Native Firebase اینو می‌خواد پس احتمالا از قبل دارید.

  • برای هر پلتفرم یه کانتینر جدا. GTM برای iOS و Android کانتینر‌های جدا می‌سازه.


-- خوب بریم سراغ نصب

۱. پکیج‌ها رو نصب کنید. من از yarn expo install استفاده می‌کنم چون خودش نسخه‌هایی از Firebase و build-properties رو انتخاب می‌کنه که با نسخه SDK اکسپوی شما جور هستن و لازم نیست حدس بزنید:

yarn expo install expo-google-tag-manager @react-native-firebase/app @react-native-firebase/analytics expo-build-properties

۲. کانتینر‌ها رو export کنید. برید توی tagmanager.google.com، کانتینر iOS رو انتخاب کنید، برید توی Versions، نسخه‌ای که می‌خواید رو باز کنید و از Actions گزینه Download رو بزنید. همین کار رو برای کانتینر Android هم بکنید. هر دو فایل رو بذارید توی یه فولدر به اسم gtm کنار app.json. اسم فایل‌ها رو دست نزنید، همون GTM-ABC1234.json که خود گوگل میده خوبه، چون پلاگین اسم فایل رو آیدی کانتینر حساب می‌کنه. کامیتشون هم بکنید، الآن دیگه جزئی از اپ هستن.

کاری که پلاگین موقع prebuild می‌کنه
کاری که پلاگین موقع prebuild می‌کنه

۳. پلاگین رو به app.json اضافه کنید:

{ "expo": { "ios": { "bundleIdentifier": "com.mycompany.exchange" }, "android": { "package": "com.mycompany.exchange" }, "plugins": [ "@react-native-firebase/app", ["expo-build-properties", { "ios": { "useFrameworks": "static" } }], [ "expo-google-tag-manager", { "ios": { "container": "./gtm/GTM-ABC1234.json" }, "android": { "container": "./gtm/GTM-XYZ9876.json" }, "enablePreview": true } ] ] } }

آپشن‌ها خیلی ساده هستن:

  • ios.container و android.container: مسیر فایل کانتینر از روت پروژه. حداقل یکیش لازمه.

  • enablePreview: روی iOS یه URL scheme برای پیش‌نمایش اضافه می‌کنه و روی Android هم TagManagerPreviewActivity رو. برای این یکی باید bundleIdentifier و package توی کانفیگ باشن. پیش‌فرضش false هست.

۴. پروژه‌های نیتیو رو از نو بسازید:

yarn expo prebuild --clean

بعدش فایل‌ها رو توی ios/<YourApp>/container (توی Xcode یه فولدر آبی) و android/app/src/main/assets/containers پیدا می‌کنید. نیازی نیست بهشون دست بزنید.

۵. یه رویداد بفرستید. این قسمت هیچ ربطی به پلاگین من نداره و خالص React Native Firebase هست. مثلا توی صفحه سفارش، وقتی کاربر یه سفارش خرید ثبت می‌کنه:

import { getAnalytics, logEvent } from '@react-native-firebase/analytics'; export const trackOrderSubmitted = async (pair: string, side: 'buy' | 'sell', amount: number) => { await logEvent(getAnalytics(), 'order_submitted', { pair, side, amount, }); };

حالا تیم مارکتینگ توی GTM یه trigger روی order_submitted می‌سازه و هر جا دلش خواست می‌فرسته. هر وقت هم نسخه جدید کانتینر رو publish کنن، اپ خودش می‌گیرتش و شما لازم نیست چیزی منتشر کنید. دستخوش!

۶. تمام. اپ رو با yarn expo run:ios یا yarn expo run:android اجرا کنید.


-- حالت پیش‌نمایش

این بخش موقع تست کلی وقت منو نجات داد. توی GTM روی کانتینر Preview رو بزنید، یه لینک و یه QR code بهتون میده. اپ رو ببندید و لینک رو روی دستگاه باز کنید. روی شبیه‌ساز یا امولاتور هم می‌تونید از ترمینال بازش کنید:

xcrun simctl openurl booted "<preview link>" adb shell am start -a android.intent.action.VIEW -d "<preview link>"

اپ با کانتینر پیش‌نمایش باز میشه و می‌تونید رویداد‌هاتون رو بفرستید و ببینید تگ‌ها اجرا میشن یا نه. روی Android هم این دستور لاگ‌های GTM رو توی Logcat نشون میده که خیلی به کار میاد:

adb shell setprop log.tag.GoogleTagManager VERBOSE

-- چی کار نمی‌کنه؟

نهpushداره نهdata layer، چون GTM for Firebase اصلا این‌ها رو نداره. تگ‌ها و متغیر‌های Custom JavaScript پشتیبانی نمیشن و SDK‌های Legacy هم کلا پشتیبانی نمیشن. اگر یکی از این‌ها رو لازم دارید، این پلاگین به دردتون نمی‌خوره و به نظرم یه بار دیگه تنظیمات GTM تون رو نگاه کنید.

نکته: هر بار که نسخه جدید کانتینر رو دانلود کردید و فایل رو عوض کردید، یه بار دیگه yarn expo prebuild بزنید، وگرنه اپ همون فایل قدیمی رو با خودش داره.

پکیج هنوز خیلی جوونه، پس اگر جایی باگ دیدید یا روی پروژه شما درست کار نکرد، توی گیت‌هاب issue باز کنید یا همینجا کامنت بذارید، همه‌اش رو می‌خونم. PR هم با کمال میل قبول می‌کنم.

امیدوارم به کار پروژه‌هاتون بیاد. شاد و موفق باشید.

react nativeGoogle Tag Manager
۰
۰
عامر لطفی اوریمی
عامر لطفی اوریمی
دولوپر فرانت‌اند - علاقمند به جاوااسکریپ (تایپ‌اسکریپت)، ری‌اکت، ری‌اکت‌نیتیو - فرانت‌اند دولوپر سابق دیجی‌کالا، دیجی‌کالامگ، شیپور و سیبچه
شاید از این پست‌ها خوشتان بیاید