CLI ile Retention Messaging Yönetimi
Adapty CLI, terminalde adapty retention-messaging konusu altında Apple Retention Messaging özelliğini — yani abonelerin Cancel Subscription ekranında gördüğü mesajı — yönetmenizi sağlar. Bir uygulamanın kurulum durumunu okuyabilir, Apple’ı Adapty’nin gerçek zamanlı URL’sine bağlayabilir, Apple’ın performans testini çalıştırabilir, retention mesajları oluşturup düzenleyebilir, bunları etkinleştirip devre dışı bırakabilir ve her mesajın metriklerini inceleyebilirsiniz.
Bir AI ajanına sizin yerinize Retention Messaging kurulumunu yaptırmak, birden fazla uygulama genelinde mesajları betiklemek veya kontrol panelini açmadan mesaj metriklerini okumak için kullanın. Komutlar, kontrol panelinin Retention Messaging sayfasıyla aynı işlemleri yapar ve kontrol paneli de aynı mesajları gösterir.
Başlamadan önce
retention-messaging konusu, CLI’ın geri kalanıyla aynı kurulum ve oturumu kullanır. Bunu henüz ayarlamadıysanız, hızlı başlangıç kılavuzunun 1. ve 2. adımlarını takip edin. CLI’ınızın bu konuya sahip olup olmadığını görmek için şunu çalıştırın:
adapty retention-messaging --help
Her komut, --app parametresinde uygulamanın UUID’sini alır. Bunu bulmak için şunu çalıştırın:
adapty apps list
Her adım için uygulamanızın ihtiyaç duyduklarından:
- Kurulum durumunu okuma: Hiçbir şey. Her uygulama için çalışır.
- Gerçek zamanlı URL’yi okuma: Adapty’de eksiksiz bir App Store kurulumu. Bu URL’yi Apple’a erişim talep ettiğinizde gönderirsiniz.
- Gerçek zamanlı URL’yi yapılandırma ve performans testini çalıştırma: Ayrıca In-App Purchase anahtarı ve Apple’dan talep ettiğiniz Retention Messaging API’ye erişim. Apple’ın incelemesi bir aya kadar sürebilir, bu nedenle erişimi erken talep edin.
- Abonelere mesaj gösterme: Apple’dan erişim, Adapty’ye ayarlanmış gerçek zamanlı URL, en az bir ürün ve Apple’ın her mesajı onaylaması.
Saklama mesajları iki Apple ortamında bulunur: sandbox ve production. --mode bayrağı ortamı seçer. Sandbox mode kontrol paneli geçişinin gösterdiği gibi, her ortamın kendi mesajları vardır.
Saklama Mesajlaşmasını baştan sona ayarlamak için:
- Kurulum durumunu okuyun.
- Gerçek zamanlı URL’yi okuyun ve Apple’dan bu URL ile erişim talep edin.
sandboxiçin gerçek zamanlı URL’yi yapılandırın.- Performans testini çalıştırın ve test geçene kadar kurulum durumunu okuyun.
productioniçin gerçek zamanlı URL’yi yapılandırın.- Varsayılan mesajları oluşturun, ardından promosyon mesajlarını.
- Apple’ın incelemesini takip etmek için mesajları listeleyin.
Kurulum durumunu okuyun
adapty retention-messaging setup-status --app <app-id>
Durum, kontrol panelindeki kurulum adımlarının aynısını gösterir:
| Alan | Değerler |
|---|---|
credentials | present veya missing: uygulamanın, Retention Messaging’in kullandığı App Store anahtarlarına sahip olup olmadığı. |
registration_status | registered veya not_registered: Apple’ın uygulamaya Retention Messaging API erişimi verip vermediği. |
sandbox.realtime_url_status, production.realtime_url_status | not_configured, configured_to_other_url veya configured_to_adapty: Apple’ın her ortamda isteklerini hangi adrese gönderdiği. |
sandbox.performance_test_status | not_started, running, passed veya failed. |
Bazı okuma işlemleri, kontrol panelinin yaptığı gibi Adapty’yi de günceller:
- Performans testi çalışırken,
setup-statusApple’dan test sonucunu alır ve kaydeder.realtime-url configureonay istemeden önce aynı okumayı yapar, bu nedenle reddetseniz bile sonucu kaydeder. messages list,messages getvemessages updateişleminin yazmadan önce yaptığı okuma, Apple’a her mesajın inceleme durumunu sorar ve yeni durumu kaydeder. Apple bir mesajı onaylamışsa, okuma işlemi onu hemenlivedurumuna taşır. Adapty, Apple’ın incelemesini bağımsız olarak da kontrol eder, dolayısıyla onaylanan bir mesaj okuma yapmadan da yayına geçer.
Gerçek zamanlı URL’yi bağlayın
Apple, bir abone Cancel Subscription ekranını açtığında gerçek zamanlı URL’ye istek gönderir. Adapty bu isteğe mesajınızla yanıt verir. Adapty URL’sini okumak için şunu çalıştırın:
adapty retention-messaging realtime-url get --app <app-id>
Aynı URL hem sandbox hem de production ortamına hizmet eder. Bu URL’yi Apple’a, erişim talep ettiğinizde verirsiniz.
Adapty URL’sini Apple’da tek bir ortam için ayarlamak üzere şunu çalıştırın:
adapty retention-messaging realtime-url configure --app <app-id> --mode sandbox
Önce sandbox ortamını yapılandırın. Adapty, performans testi geçilene kadar production ortamına izin vermez. sandbox ortamını yapılandırdığınızda Adapty, performans testi için gizli bir test mesajı da oluşturur. Bu mesaj, mesaj listesinde görünmez.
Apple bu ortamın isteklerini farklı bir sunucuya gönderiyorsa (configured_to_other_url), Adapty URL’si Apple’da o sunucunun URL’sinin yerini alır. Bu noktadan itibaren o sunucu, Cancel Subscription ekranından herhangi bir istek almaz. CLI, ortamın adını belirten bir uyarı gösterir. Değişikliği onaylamak için:
- Terminalde,
--jsonolmadan: Uyarıyı okuyun veApply? [y/N]istemineyile yanıt verin.--yesgeçseniz bile istem görünür. - Bir script’te, bir agent’ta veya
--jsonile:--replace-other-url --yesgeçin.--replace-other-urlolmadan CLI hiçbir şey göndermez ve--yesile bile çıkış kodu 6 ile sonlanır.
Performans testini çalıştırın
Apple, production gerçek zamanlı URL’sine izin vermeden önce Adapty’nin ne kadar hızlı yanıt verdiğini test eder. Teste başlamadan önce, sandbox için gerçek zamanlı URL’yi yapılandırın. Ardından bir sandbox hesabı veya TestFlight üzerinden en uzun süreli ürününüzü satın alın, aboneliği aktif tutun ve satın alma işleminin hemen ardından testi başlatın:
adapty retention-messaging performance-test start --app <app-id>
Test her zaman sandbox ortamında çalışır ve bir saate kadar sürebilir. Sonucu görmek için kurulum durumunu yeniden okuyun: sandbox.performance_test_status değeri running’den passed veya failed olarak değişir. Durum running iken testi yeniden başlatmayın: Adapty bunu reddeder. Testin neden başarısız olduğunu öğrenmek için bkz. Performans testini geçme.
Test geçtikten sonra production ortamına bağlanın:
adapty retention-messaging realtime-url configure --app <app-id> --mode production
Mesajları listele ve oku
adapty retention-messaging messages list --app <app-id> --mode production --state live
--mode zorunludur. Liste, her mesajı adı, türü, durumu, ürün sayısı, başlangıç tarihi ve mesajın tüm yaşam süresi boyunca elde edilen şu metriklerle birlikte gösterir:
| Alan | Kontrol paneli sütunu | Değer |
|---|---|---|
shown | Shown | Sayı |
retained | Retained users | Sayı |
saved_users | Saved users | Sayı |
retention_rate | Retention rate | Yüzde, bir ondalık basamak. Hiçbir görüntülemenin sonucu yokken 0.0. |
save_rate | Save rate | Yüzde, bir ondalık basamak. Hiçbir görüntüleme 24 saatten eski değilken 0.0. |
saved_revenue | Saved revenue | Apple komisyonu öncesi USD, iki ondalık basamak |
Adapty’nin her metriği nasıl hesapladığı hakkında bilgi için bkz. Mesaj performansını takip etme.
Bir mesaj şu durumlardan birinde olabilir: in_review, live, rejected veya inactive. Her durumun ne anlama geldiği için bkz. Mesaj durumları.
Bir mesajı metinleri, görseli, madde noktaları, ürünleri ve dilleriyle birlikte okumak için şu komutu çalıştırın:
adapty retention-messaging messages get <message-id> --app <app-id>
Mesajda ortam alanı bulunmaz. Metinler ve madde noktaları en-US kaynağıdır. Diğer her dil kendi inceleme durumunu gösterir.
Mesaj oluşturma
Bir promosyon mesajı, aynı ürün için aynı ortamda varsayılan bir mesaj gerektirir. Önce varsayılan mesajı oluşturun. Apple’ın incelemesini beklemeniz gerekmez.
Dosya için ürün kimliklerini, promosyon tekliflerini ve plan geçişlerini bulmak üzere öneri komutlarını kullanın. Mesaj oluşturmak için içeriğini bir JSON dosyasına koyun:
{
"name": "Annual default",
"type": "default",
"title": "Before you go",
"body": "Your plan keeps every feature you use today.",
"alt_text": "App icon on a purple background",
"header_position": "above_body",
"products": [
{ "store_id": "com.example.annual" }
],
"bullet_points": [
{ "image_path": "icons/sync.png", "text": "Sync on all your devices" },
{ "image_path": "icons/offline.png", "text": "Work offline" }
],
"localizations": [
{
"locale": "de-DE",
"title": "Bevor du gehst",
"body": "Dein Abo behält alle Funktionen, die du heute nutzt.",
"bullet_points": [
{ "text": "Auf allen Geräten synchronisieren" },
{ "text": "Offline arbeiten" }
]
}
]
}
Then run:
adapty retention-messaging messages create --app <app-id> --mode sandbox \
--file message.json --image header.png
The file takes these keys:
name,type,title,body: Zorunlu. Başlık ve gövde,en-USkaynak metnidir; başlık en fazla 66, gövde en fazla 144 karakter olabilir.type: Mesaj türü,defaultveyapromo. Türü sonradan değiştiremezsiniz.alt_text: Ekran okuyucular için resim açıklaması; en fazla 150 karakter.header_position: Resimli bir default mesajda başlığın konumu.above_imagebaşlığı resmin üstünde gösterir.above_bodyise resmin altında, gövdenin üstünde gösterir. Sonradan değiştiremezsiniz.products: Abonelerin mesajı göreceği ürünler;store_idalanında App Store ürün kimliğiyle belirtilir. Default mesajdaassociationbulunmaz. Promo mesajın en az bir ürüne ihtiyacı vardır ve her ürününassociationalanında bir teşvik tanımlanmalıdır:{"type": "promo_offer", "store_id": "<offer-id>"}veya{"type": "plan_switch", "store_id": "<product-id>"}. Bir promo mesajdaki tüm ürünler aynı teşvik türünü kullanır: hepsipromo_offerya da hepsiplan_switch.bullet_points: Yalnızca default mesajlar için, en fazla beş madde. Her maddenintext(1–66 karakter), isteğe bağlıalt_textveimage_pathalanları bulunur;image_path, PNG simgesinin JSON dosyasının bulunduğu klasöre göreli yoludur. CLI,image_indexdeğerini reddeder.localizations:en-USdışındaki her yerel ayar için bir giriş;locale,title,bodyve mesajdaki her madde noktası için aynı sırada birbullet_pointsmetni içerir.
--image varsayılan bir mesajın görselini ekler. Promosyon mesajının görseli ve madde işaretleri yoktur.
Onayınızı istemeden önce CLI her görsel dosyasını doğrular. CLI ardından Betikler ve ajanlarda onay bölümünde açıklandığı gibi onay ister. Adapty, yeni mesajın metin ve görsellerini incelenmek üzere Apple’a gönderir ve mesajın durumu in_review olur.
Bir oluşturma işlemi ağ hatası veya sunucu hatası ile başarısız olursa tekrar çalıştırmayın. Bkz. Oluşturma veya değiştirme işlemi yanıt almazsa.
Görsel gereksinimleri
| Dosya | Gereksinimler |
|---|---|
Görsel (--image) | PNG, 3840 piksel genişliğinde ve 160–2160 piksel yüksekliğinde, şeffaflık yok, en fazla 10 MB |
Madde imi ikonu (image_path) | PNG, 1024 × 1024 piksel, şeffaflık yok, en fazla 10 MB |
CLI, herhangi bir şey göndermeden önce her dosyayı doğrular. Alfa kanalı olan bir PNG, tüm pikseller tam opaksa geçer. Bozuk bir PNG, must be a PNG hatasıyla başarısız olur. Bir dosya başarısız olursa, CLI hiçbir şey göndermez ve 2 koduyla çıkar. Hata mesajı dosyayı ve kuralı belirtir; örneğin … must be 3840 px wide and 160–2160 px tall.
Bir mesajı değiştirme
Devre dışı bir mesajdaki değişiklik, yalnızca ad değişikliği bile olsa onu yeniden etkinleştirir. Apple mesajı onayladıktan sonra aboneler bunu görür.
messages update yalnızca belirttiğiniz şeyleri değiştirir. Belirtmediğiniz her dil, madde işareti, simge, ürün ve görsel olduğu gibi kalır:
adapty retention-messaging messages update <message-id> --app <app-id> --title "Wait, there's more"
Change the name, title, body, and alt text, and the image, with flags: --name, --title, --body, --alt-text, --image, and --remove-image. Change locales, bullet points, and products with a changes file in --file. The changes file also takes name, title, body, alt_text, and remove_image. The CLI refuses a key that the changes file doesn’t know. This changes file works on the message from Create a message:
{
"localizations": [
{ "locale": "de-DE", "title": "Warte kurz", "bullet_texts": { "<bullet-id>": "Auf jedem Gerät synchronisieren" } }
],
"bullet_points": [
{ "bullet_id": "<bullet-id>", "text": "Sync on every device" },
{
"image_path": "icons/backup.png",
"text": "Daily backups",
"texts": { "de-DE": "Tägliche Backups" }
}
],
"remove_bullet_points": ["<other-bullet-id>"]
}
- Yerelleştirmeler: Her yerelleştirmeyi
localeiçinde kodu ile adlandırın;title,bodyve söz konusu yerelleştirmenin madde noktası metinleribullet_textsiçindebullet_id’ye göre belirtilir. Mesajın sahip olmadığı bir yerelleştirme eklenirsetitle,bodyve her madde noktası için bir metin gerekmektedir. - Madde noktaları: Bir madde noktasını değiştirmek için
messages getçıktısındakibullet_idile adlandırın; yeni bir simge içintext,alt_textveyaimage_pathkullanın. Yeni bir madde noktasınınbullet_id’si olmaz.image_path,en-USiçintextve mesajın her yerelleştirmesi içintextsiçinde bir metin gerektirir. - Ürünler: App Store ürün kimliğine göre
store_idile belirtilir. Mesajda bulunmayan bir ürün eklenir. Promosyon mesajında her ürünün bir teşvike ihtiyacı vardır: değiştirmek için yeni birassociationgönderin. Bir üründe teşvik sunmayı durdurmak için ürünüremove_productsile kaldırın. Promosyon mesajına eklediğiniz bir ürününassociationdeğeri olması gerekir. - Kaldırma işlemleri: Kaldırma alanlarını kullanın:
remove_localizations(yerel ayar kodları),remove_bullet_points(madde noktası kimlikleri),remove_products(App Store ürün kimlikleri) veremove_image: trueya da--remove-image. Kaldırılan bir madde noktası tüm yerelleştirmelerden silinir. Bir promosyon mesajı bir ürünü kullanırken, o ürünü varsayılan mesajından kaldıramazsınız.
Bir promosyon mesajının türünü, header_position değerini veya teşvik türünü (promo_offer ya da plan_switch) değiştiremezsiniz. Farklı bir tane kullanmak istiyorsanız yeni bir mesaj oluşturun.
CLI, herhangi bir şey göndermeden önce değişikliklerinizi doğrular. Giriş çelişkili ise, hiçbir şeyi değiştirmiyorsa ya da mesajda bulunmayan bir şeyi isimlendiriyor veya kaldırıyorsa CLI hiçbir şey göndermez, 2 kodu ile çıkar ve hata sorunu belirtir. Mevcut bir madde işaretinin yerel metinlerini texts içinde değil, yerel ayarın bullet_texts alanında verin.
CLI onay ister, mesajı okur, değişikliklerinizi mesajla birleştirir ve tam mesajı Adapty’ye gönderir. Her güncelleme tüm mesajı Apple’ın incelemesine gönderir ve mesaj durumu in_review olur. messages update çalışırken biri kontrol panelinde mesajı değiştirirse, güncelleme o değişikliğin üzerine yazar.
Bir mesajı etkinleştirme veya devre dışı bırakma
adapty retention-messaging messages set-status <message-id> --app <app-id> --action deactivate
activate:inactivedurumundaki bir mesajıin_reviewdurumuna taşır. Apple yalnızca daha önce onaylamadığı dilleri tekrar inceler. Apple mesajı onayladıktan sonra aboneler mesajı yeniden görmeye başlar.deactivate:livedurumundaki bir mesajıinactivedurumuna taşır. Aboneler artık mesajı göremez. Daha önce gerçekleşen görüntülemeler metriklerde kalmaya devam eder.
Adapty, inactive olmayan bir mesaj için activate isteğini ve live olmayan bir mesaj için deactivate isteğini reddeder. in_review durumundaki bir mesaj, Apple onayladığında yayına girer. Durdurmak için onaydan sonra devre dışı bırakın. CLI’ın mesaj silme komutu yoktur.
Bir ürünün her ortamda bir varsayılan mesajı ve bir promosyon mesajı olabilir. Adapty aşağıdaki durumlarda aktivasyonu reddeder:
- Bu mesaj inactive durumdayken ürüne aynı türde başka bir mesaj eklendi.
- Mesaj bir promosyon mesajıdır ve ürünlerinden birinin bu ortamda varsayılan mesajı yoktur.
Bir promosyon mesajı bir ürünü kullanırken, Adapty o ürünün varsayılan mesajını devre dışı bırakmayı reddeder. Önce promosyon mesajını devre dışı bırakın veya ürünü mesajdan kaldırın.
Ürünleri ve teklifleri bulma
Bir mesaja ekleyebileceğiniz ürünleri bulmak için şunu çalıştırın:
adapty retention-messaging products suggest --app <app-id> --mode production --type default
Bir mesajı değiştirirken, bu mesajın ürünlerinin used olarak görünmemesi için --message-id parametresine mesajın ID’sini geçin. disabled_reason bulunan bir ürün eklenemez:
used: Aynı türdeki başka bir mesaj bu ortamda ürünü zaten kullanıyor.no_default_message: Ürünün bu ortamda varsayılan mesajı yok, dolayısıyla promosyon mesajı alamaz.
Bir promosyon mesajı her ürünle tek bir teşvik ilişkilendirir. Bir ürünün teşviklerini bulmak için products suggest komutundan dönen ürün id’sini kullanın. Ürünün promosyon tekliflerini listelemek için şu komutu çalıştırın:
adapty retention-messaging promo-offers suggest <product-id> --app <app-id>
Bir abonenin geçiş yapabileceği planları listelemek için şu komutu çalıştırın:
adapty retention-messaging plan-switches suggest <product-id> --app <app-id>
plan-switches suggest özelliği, uygulama ayarlarında App Store Connect API anahtarı gerektirir. Teklifin veya planın store_id’sini ürünün association’ına ekleyin.
Betikler ve ajanlar için onay
Bu komutlar, abonelerin Cancel Subscription ekranında gördüklerini değiştirir. Her biri etkisini yazdırır ve değişikliği göndermeden önce hem sandbox hem de production ortamında onay ister:
realtime-url configuremessages createmessages updatemessages set-status
Onay isteme biçimi, komutun nasıl çalıştırıldığına göre farklılık gösterir:
| Komutun çalışma şekli | Ne olur |
|---|---|
Terminalde, --yes ve --json olmadan | CLI etkiyi yazdırır ve Apply? [y/N] diye sorar. y veya yes cevabı verirseniz CLI isteği gönderir. Başka bir cevap için CLI kod 1 ile çıkar ve hiçbir şey göndermez. |
--yes ile, terminalde ya da değil | CLI, production ortamında bile sormadan isteği gönderir. |
--yes olmadan, --json ile, bir pipe içinde veya terminal yokken | CLI hiçbir şey göndermez ve kod 6 ile çıkar. Hata, etkiyi açıklar. |
Apple’da farklı bir gerçek zamanlı URL’yi değiştirmenin kendine özgü kuralları vardır. Bkz. Gerçek zamanlı URL’yi bağlama.
Böylece bir script veya agent, önce komutu --yes olmadan çalıştırarak etkisini okuyabilir, çıktıdaki etkiyi inceleyebilir ve yalnızca biri bu etkiyi onayladıktan sonra --yes ile tekrar çalıştırabilir.
setup-status, realtime-url get, performance-test start, messages list, messages get ve suggest komutları onay istenmeden çalışır.
Hatalar
| Çıkış kodu | Neden | Ne yapmalı |
|---|---|---|
| 1 | İstemde y dışında bir şey girdiniz. Hiçbir şey gönderilmedi. | Göndermek istiyorsanız komutu tekrar çalıştırın. |
| 2 | CLI, değişikliği göndermeden önce girdiyi reddetti: bir bayrak, bir görsel dosyası, girdide bir çakışma, her madde için metin içermeyen bir yerel ayar veya saklama mesajının içermediği bir şeyin kaldırılması. | Hata mesajında belirtileni düzeltin. |
| 3 | Giriş yapmadınız ya da Adapty uygulamaya erişimi reddetti. | adapty auth login ile giriş yapın ve uygulama ID’sini adapty apps list ile bulun. |
| 4 | Adapty isteği reddetti. Hata mesajı nedeni açıklar; --json ise HTTP durumunu ve error_code değerini verir. Bir oluşturma veya değişiklik sırasında sunucu hatası (5xx) oluşursa da kod 4 döner ve sonuç bilinmez. | Adapty’den Gelen Mesajlar bölümüne bakın. Bir oluşturma veya değişiklik sırasında sunucu hatası alırsanız Bir oluşturma veya değişiklik yanıtsız kalırsa bölümüne bakın. |
| 5 | CLI, Adapty’ye ulaşamadı. | Çevrimiçi olduğunuzdan emin olun. Bir oluşturma veya değişiklikten sonra Bir oluşturma veya değişiklik yanıtsız kalırsa bölümüne bakın. |
| 6 | Onay gerektiren bir komut --yes olmadan ve yanıt verecek kimse yokken çalıştırıldı ya da gerçek zamanlı bir URL değişikliği --replace-other-url olmadan gerçekleştirildi. Hiçbir şey gönderilmedi. | Hatadaki etkiyi okuyun, ardından komutu --yes ile ve değişiklik için --replace-other-url ile tekrar çalıştırın. |
| 130 | İstemde Ctrl+C tuşuna bastınız. Hiçbir şey gönderilmedi. | — |
Adapty’den Gelen Mesajlar
--json ile hata, error_code’u döndürür:
error_code | Neden | Ne yapmalı |
|---|---|---|
app_store_credentials_missing | Uygulamanın Adapty’de App Store anahtarı yok. | App Store kurulumunu tamamlayın. |
app_store_connect_credentials_missing | plan-switches suggest için App Store Connect API anahtarı gerekiyor. | App Store Connect API anahtarını ekleyin. |
realtime_url_unavailable | Uygulamanın Adapty’de App Store sunucu bildirimleri kurulumu yok. | App Store kurulumunu tamamlayın. |
apple_rm_api_access_denied | Apple, uygulamaya Retention Messaging API erişimi vermemiş. | Apple’dan erişim isteyin. |
performance_test_required | Performans testi geçmeden production yapılandırıldı. | Önce performans testini çalıştırın. |
performance_test_already_running | Bir performans testi çalışıyor. | Bekleyin, ardından kurulum durumunu tekrar okuyun. |
active_sandbox_transaction_missing | Aktif sandbox aboneliği yok. | Sandbox’ta en uzun süreli ürününüzü satın alın, ardından testi yeniden başlatın. |
performance_test_request_rejected | Apple testi başlatmayı reddetti. | Yeni bir sandbox satın alımı yapın, ardından testi yeniden başlatın. |
retention_product_claimed | Aynı türdeki başka bir mesaj bu ürüne sahip. | Başka bir ürün seçin ya da diğer mesajı devre dışı bırakın. |
retention_default_message_missing | Bir promosyon mesajının varsayılan mesajı olmayan bir ürünü var. | Önce ürün için bir varsayılan mesaj oluşturun veya etkinleştirin. |
retention_dependent_promo_messages | Bir promosyon mesajı, yapılan değişiklikle varsayılan bir mesajdan alınan bir ürün kullanıyor. | Önce promosyon mesajını devre dışı bırakın ya da ürünü mesajdan kaldırın. |
retention_promo_association_invalid | Bir promosyon mesajının ürünü yok, association olmayan bir ürünü var ya da her iki teşvik türü de mevcut. | Her ürüne aynı türde bir association verin. |
retention_message_type_immutable | Yapılan değişiklik, promosyon mesajına farklı bir teşvik türü atıyor. | Yeni bir mesaj oluşturun. |
retention_message_invalid_status_transition | inactive olmayan bir mesajda activate veya live olmayan bir mesajda deactivate çağrısı yapıldı. | messages get ile mesajın durumunu okuyun. |
retention_message_not_found | Uygulamanın bu kimliğe sahip mesajı yok. | Kimliği messages list ile alın. |
Oluşturma veya değişiklik yanıt alamazsa
CLI, bir oluşturma veya güncelleme isteğine ağ hatası ya da sunucu hatası nedeniyle (çıkış kodu 4 veya 5) yanıt alamazsa, Adapty’nin değişikliği kaydedip kaydetmediğini bilemez. CLI isteği yeniden göndermez. Komutu kendiniz de tekrar çalıştırmayın.
- Oluşturma işlemi sonrası: Aynı ortam için
messages listkomutunu--search "<name>" --page-size 100parametreleriyle çalıştırın. Hata, tam adı ayrı bir satırda yazdırır (--jsonmodundamessage_namealanında).meta.pagination.pagesdeğerine kadar her sayfayı okuyun ve her adayımessages getile açın. İkinci bir oluşturma işlemi yinelenen bir mesaj oluşturabilir ve bunu Apple’ın incelemesine gönderebilir. Mesajı yalnızca hiçbir adayın sizin mesajınız olmadığı durumlarda yeniden oluşturun. - Güncelleme işlemi sonrası:
messages getkomutunu çalıştırın ve mesajın durumunu ile içeriğini okuyun.
Komut referansı
Her komut, adapty apps list komutundan elde edilen uygulama UUID’sini belirten --app parametresini alır.
retention-messaging setup-status
Kurulum durumunu döndürür. Başka bayrak almaz.
retention-messaging realtime-url get
Adapty gerçek zamanlı URL’sini döndürür. Başka bayrak almaz.
retention-messaging realtime-url configure
| Flag | Gerekli | Açıklama |
|---|---|---|
--mode | Evet | sandbox veya production. |
--replace-other-url | Hayır | Apple’daki farklı bir URL’nin değiştirilmesini onaylar. |
--yes, -y | Hayır | Sormadan yapılandırır. --json ile veya pipe içinde gereklidir. |
retention-messaging performance-test start
Apple’ın performans testini sandbox ortamında başlatır. Başka bayrak almaz.
retention-messaging messages list
| Flag | Zorunlu | Açıklama |
|---|---|---|
--mode | Evet | sandbox veya production. |
--search | Hayır | Adın bir kısmı (büyük/küçük harf fark etmez) veya tam mesaj ID’si. |
--type | Hayır | default veya promo. |
--state | Hayır | in_review, live, rejected veya inactive. |
--ordering | Hayır | name, type, state, products_count veya started_at. Ters sıralama için alanın önüne - ekleyin. Varsayılan: -started_at. |
--page | Hayır | Sayfa numarası. Varsayılan: 1. |
--page-size | Hayır | Sayfa başına mesaj sayısı, en fazla 100. Varsayılan: 20. |
retention-messaging messages get
Mesaj ID’sini argüman olarak alır. Mesajın tamamını döndürür.
retention-messaging messages create
| Flag | Zorunlu | Açıklama |
|---|---|---|
--mode | Evet | sandbox veya production. |
--file | Evet | Mesajın JSON dosyası veya standart girdiden okumak için -. Bkz. Mesaj oluşturma. |
--image | Hayır | Varsayılan mesajın PNG görseli. |
--yes, -y | Hayır | Onay sormadan oluşturur. --json ile veya bir pipe içinde kullanılırken zorunludur. |
retention-messaging messages update
Argüman olarak mesaj ID’sini alır.
| Bayrak | Zorunlu | Açıklama |
|---|---|---|
--name, --title, --body, --alt-text | Hayır | Alanın yeni değeri. |
--image | Hayır | Yeni PNG görsel. |
--remove-image | Hayır | Görseli kaldırır. |
--file | Hayır | Değişiklikler dosyası veya standart girdiden okumak için -. Bkz. Mesaj değiştirme. |
--yes, -y | Hayır | Onay sormadan değiştirir. --json ile veya bir pipe içinde gereklidir. |
retention-messaging messages set-status
Mesaj ID’sini argüman olarak alır.
| Bayrak | Zorunlu | Açıklama |
|---|---|---|
--action | Evet | activate veya deactivate. |
--yes, -y | Hayır | Onay sormadan durumu değiştirir. --json ile veya bir pipe içinde kullanılırken zorunludur. |
retention-messaging products suggest
| Flag | Zorunlu | Açıklama |
|---|---|---|
--mode | Evet | sandbox veya production. |
--type | Evet | default veya promo: mesaj türü. |
--search | Hayır | Ürün başlığının bir parçası, büyük/küçük harf fark etmez. |
--message-id | Hayır | Değiştirdiğiniz mesajın ID’si. |
--limit | Hayır | Döndürülecek ürün sayısı, en fazla 100. Varsayılan: 10. |
retention-messaging promo-offers suggest
products suggest komutunun döndürdüğü ürün ID’sini argüman olarak alır.
| Bayrak | Zorunlu | Açıklama |
|---|---|---|
--search | Hayır | Teklif başlığının bir kısmı, büyük/küçük harf fark etmez. |
--limit | Hayır | Döndürülecek teklif sayısı, en fazla 100. Varsayılan: 10. |
retention-messaging plan-switches suggest
products suggest komutundan dönen ürün ID’sini argüman olarak alır.
| Flag | Zorunlu | Açıklama |
|---|---|---|
--search | Hayır | Plan başlığının bir parçası, büyük/küçük harf duyarsız. |
--limit | Hayır | Döndürülecek plan sayısı, en fazla 100. Varsayılan: 10. |
Bir yapay zeka asistanıyla çalışma
Adapty MCP sunucusu, retention_messaging_* araçlarıyla aynı eylemleri sunar; örneğin messages list için retention_messaging_messages_list. Araçlar, --type yerine message_type parametresini alır.
- Onay: Asistan,
sandboxveproductionortamlarında realtime URL’yi yapılandırmadan, bir mesaj oluşturmadan veya değiştirmeden ya da durumunu değiştirmeden önce onay ister. Başka bir sunucunun realtime URL’sini değiştirmeden önce ayrı bir soru sorar. Ayrıca her konuşmada ilk kurulum durumu okumasından önce bir kez ve ilk mesaj okumasından önce bir kez onay ister; çünkü bu okumalar Adapty’yi güncelleyebilir. - Görseller ve madde işaretleri: MCP araçları görsel, madde işareti simgesi veya yeni bir madde işareti ekleyemez.
retention_messaging_messages_createbir mesajı görsel veya madde işaretleri olmadan oluşturur. Bunları eklemek için CLI’danmessages updatekomutunu çalıştırın ya da kontrol panelini kullanın.
Sırada ne var?
- Retention Messaging için agent skill — agentınızın Retention Messaging’i kurmasına ve mesajlarınızı yazmasına izin verin; her değişiklikten önce onayınız alınır.
- Retention Messaging’i kur — kontrol panelindeki kurulum adımlarının aynısı.
- Retention mesajı oluştur — kontrol panelindeki mesaj alanları, diller ve durumlar.
- Mesaj performansını takip et — her metriğin ne anlama geldiği.