Uzantı yayıncısına genel bakış

Firebase uzantıları, HTTP isteklerine yanıt olarak veya Firebase Cloud Messaging, Cloud Firestore ya da Pub/Sub gibi diğer Firebase ve Google ürünlerinden gelen etkinlikleri tetikler.

Firebase Uzantı Merkezi'nde kişisel kullanım için veya dünyayla paylaşmak üzere kendi uzantınızı oluşturabilirsiniz. Örneğin, uzantınız uygulamanızın düzenli olarak ihtiyaç duyduğu belirli bir görevi gerçekleştirebilir veya şirketinizin API'lerinden birine erişmeyi kolaylaştırabilir. Uzantı oluşturduktan sonra başkalarıyla paylaşabilirsiniz. Bu kullanıcılar, uzantıyı kendi Firebase projelerinde kullanmak üzere yükleyip yapılandırabilir.

Uzantının yapısı

Bir uzantının üç ana bileşeni olduğunu düşünebilirsiniz:

  • JavaScript veya TypeScript'te Cloud Functions kodu
  • Uzantınızı açıklayan meta veriler
  • Kullanıcılarınızın uzantınızı yapılandırmalarına ve kullanmalarına yardımcı olacak dokümanlar

Bir uzantı geliştirmek için bu bileşenleri aşağıdaki yapıda birleştirirsiniz:

example-extension
├── functions
│   ├── integration-tests
│   │   ├── extensions
│   │   │   └── example-extension.env
│   │   ├── firebase.json
│   │   └── integration-test.spec.js
│   ├── index.js
│   └── package.json
├── README.md
├── PREINSTALL.md
├── POSTINSTALL.md
├── CHANGELOG.md
├── icon.png
└── extension.yaml
  • functions dizini, JavaScript veya TypeScript'te Cloud Functions kodunuzu içerir. Bu kod, Firebase ve Google hizmetleri tarafından tetiklenen etkinliklere yanıt olarak uzantının görevlerini gerçekleştirir.
  • extension.yaml dosyası, uzantınızla ilgili tetikleyiciler ve IAM erişim rolleri gibi meta verilerin yanı sıra kullanıcı tarafından yapılandırılmasını istediğiniz parametreleri içerir.
  • PREINSTALL, POSTINSTALL ve CHANGELOG dosyaları, uzantınızın sahip olması gereken minimum dokümandır. Bu dosyalar, kullanıcılarınızın uzantınızın ne yaptığını, nasıl kullanıldığını ve yaptığınız güncellemeleri öğrenmesine yardımcı olur. Ayrıca, kullanıcıların uzantınızı tanımasına yardımcı olacak bir simge de eklemeniz gerekir. Kullanıcılar uzantınızı keşfederken, yüklerken ve yönetirken Firebase konsolu, Firebase CLI ve Extensions Hub bu dosyaların içeriğini gösterir.

Oluşturduğunuz uzantıları Firebase CLI'yı kullanarak bir projeye yükleyebilir veya herkesin keşfedip kendi projelerine yükleyebileceği Extensions Hub'da yayınlayabilirsiniz.

Uzantım hangi ürünlerle etkileşime geçebilir?

Firebase uzantıları, işlerini Cloud Functions'i kullanarak yaptığından, olası entegrasyonlar sorununu iki şekilde düşünebilirsiniz: Uzantımın işlevlerini hangi ürünler tetikleyebilir? ve Tetiklendikten sonra uzantımın işlevleri hangi ürünlerle etkileşime geçebilir?

Desteklenen işlev tetikleyicileri

Manuel tetikleyiciler

Öncelikle, bir işlevi manuel olarak tetikleyebilirsiniz. Firebase uzantıları ve Cloud Functions, işlevleri manuel olarak tetiklemenin iki yolunu destekler:

  • HTTP tetikleyicileri: Bir işlevi HTTP uç noktasına dağıtma
  • Çağırılabilir işlevler: Firebase istemci SDK'larını kullanarak Cloud Functions'lerinizi doğrudan iOS, Android veya web istemci kodunuzdan çağırın.

Uzantılarınız, HTTP uç noktalarını sunarak webhook'ları destekleyen tüm web hizmetleriyle entegre olabilir. Çağırılabilir işlevler sayesinde, uzantınızı yükleyen kullanıcılar, uzantınızın uyguladığı API'ye erişmek için Firebase SDK'larını istemci kitaplığı olarak kullanabilir.

Firebase hizmet tetikleyicileri

Çoğu Firebase ürünü, bir uzantının Cloud Functions'ini tetikleyebilecek etkinlikler yayınlar.

  • Analytics: Analytics bir etkinlik kaydettiğinde işlevleri tetikler
  • App Distribution: App Distribution bir uyarıyı tetiklediğinde işlevleri tetikler
  • Kimlik doğrulama: Kullanıcılar hesap oluşturup sildiğinde işlevleri tetikleme
  • Cloud Firestore: Sayfalar oluşturulduğunda, güncellendiğinde veya silindiğinde işlevleri tetikleme
  • Cloud Storage: Nesneler paketlere yüklendiğinde, arşivlendiğinde veya paketlerden silindiğinde işlevleri tetikleyin.
  • Crashlytics: Crashlytics bir uyarı tetiklediğinde işlevleri tetikleme
  • Performans İzleme: Performans İzleme bir uyarı tetiklediğinde işlevleri tetikleme
  • Realtime Database: Veriler oluşturulduğunda, güncellendiğinde veya silindiğinde işlevleri tetikleyin
  • Remote Config: Bir parametre güncellendiğinde işlevleri tetikleme
  • Test Lab: Test Lab bir uyarı tetiklediğinde işlevleri tetikleme

Google Cloud hizmet tetikleyicileri

Uzantıların, Firebase dışındaki çeşitli Google Cloud hizmetlerini tetikleyen işlevleri de içerebileceğini unutmayın:

  • Cloud Pub/Sub: Uzantılar, yapılandırılabilir bir Pub/Sub konusuna etkinlik gönderildiğinde tetiklenen işlevler içerebilir.
  • Cloud Scheduler: Uzantı, belirli bir programda çalışan işlevler içerebilir
  • Cloud Tasks: Uzantılar, Cloud Tasks kullanılarak sıraya alınabilecek işlevler içerebilir. Firebase uzantıları, uzantı yazarı olarak uzantının "yaşam döngüsü" etkinliklerine (bir projeye ilk kez yükleme, yeni bir sürüme yükseltme ve yeniden yapılandırma) yanıt veren işlevler yazmanıza olanak tanımak için bu özelliği kullanır.
  • Eventarc: Bir uzantı, etkinlikler yapılandırılabilir bir Eventarc kanalına yayınlandığında tetiklenen işlevler içerebilir. Buna karşılık, kullanıcıların uzantı etkinliklerinden tetiklenen kendi işlevlerini tanımlayabilmesi için uzantı, kendi etkinliklerini bir Eventarc kanalına yayınlayabilir.

İşlevlerden desteklenir

Bir uzantının Cloud Functions işlevi tetiklendikten sonra, bir dizi olası entegrasyon genellikle açık uçlu olur. Cloud Functions'dan yapabileceğiniz bazı önemli işlemleri aşağıda bulabilirsiniz:

  • Desteklenen bir IAM rolü kullanan tüm Firebase veya Google Cloud hizmetini okuma, yazma ve başka bir şekilde etkileşim kurma.
  • Web API sağlayan herhangi bir üçüncü taraf hizmetle çalışma.
  • Web API'si sağlıyorsanız özel hizmetlerinizle çalışın.
  • TensorFlow.js, Express.js vb. dahil olmak üzere çoğu JavaScript kitaplığını çalıştırın.

Uzantı nasıl oluşturulur?

Başlarken eğiticisi, eksiksiz bir uzantı oluşturma, test etme ve yayınlama sürecinde size yol gösterir ve nasıl uzantı oluşturacağınızı öğrenmeniz için önerilen yoldur.

Başlayın

Başlangıç kılavuzunu bir kez inceledikten sonra, kendi uzantınızı oluştururken tüm görevlerin açıklandığı ayrı konu kılavuzlarına göz atabilirsiniz: