POST /api/v2/web-api/paywall/

Paywall'ı al

Copy as Markdown

Belirtilen placement'tan paywall'ı alır.

Request body

storestringrequired

Ürünün satın alındığı mağaza. Olası değerler: app_store, play_store, stripe veya özel mağazanızın Store ID'si.

localestring

Paywall yerelleştirmesinin tanımlayıcısı. Bu parametrenin "-" karakteriyle ayrılmış bir veya daha fazla alt etiket içeren bir dil kodu olması beklenir. İlk alt etiket dil içindir, ikincisi bölge içindir.

placement_idstringrequired

Placement'ın tanımlayıcısı. Bu, Adapty Kontrol Paneli'nde bir placement oluştururken belirttiğiniz değerdir.

customer_user_idstring

customer_user_id veya profile_id'den biri zorunludur. Kullanıyorsanız uygulamanızda kullanıcıyı tanımlamak için kullandığınız kullanıcı kimliği. Örneğin, kullanıcı UUID'niz, e-postanız veya başka herhangi bir kimlik olabilir.

profile_idstring

customer_user_id veya profile_id'den biri zorunludur. Adapty'deki bir kullanıcının tanımlayıcısı.

Responses

Başarılı yanıt, Paywall nesnesini içerecektir.

Schema
placement_idstringrequired

Bu paywall'ın gösterildiği placement'ın kimliği. Bu değer, Adapty Kontrol Paneli'nde bir placement oluştururken belirlenir.

variation_idstringrequired

Bu belirli paywall'a bağlı satın alımları izlemek için kullanılan varyant kimliği.

paywall_idstringrequired

Paywall'ın benzersiz tanımlayıcısı.

ab_test_namestring

Üst A/B testinin adı.

paywall_namestringrequired

Adapty Kontrol Paneli'nde tanımlandığı şekliyle paywall'ın adı.

productsarray of objectrequired

Paywall için ürün bilgilerini içeren Product nesnelerinden oluşan dizi.

titlestring

Adapty Kontrol Paneli'ndeki Ürünler bölümünden ürün adı.

is_consumablebooleanrequired

Ürünün consumable olup olmadığını belirtir.

adapty_product_idstring

Adapty'de kullanılan dahili ürün kimliği.

vendor_product_idstringrequired

Uygulama mağazalarındaki ürün kimliği.

introductory_offer_eligibilityboolean

Kullanıcının iOS başlangıç teklifi için uygun olup olmadığını belirtir.

promotional_offer_eligibilityboolean

Kullanıcının promosyon teklifi için uygun olup olmadığını belirtir.

base_plan_idstring

Google Play için temel plan kimliği veya Stripe için fiyat kimliği. Google Play için Temel plan kimliği'ne veya Stripe için fiyat kimliği'ne bakın.

offerallOf

JSON olarak bir Offer nesnesi.

categorystring

Uygulanan teklifin kategorisi.

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Aktif teklifin türü. Bu null değilse, teklifin mevcut abonelik döneminde uygulandığı anlamına gelir.

One of: "free_trial", "pay_as_you_go", "pay_up_front", "unknown"

idstring

Uygulanan teklifin kimliği.

remote_configobject

Paywall'ın tam remote config'ini içeren bir RemoteConfig nesnesi.

langstringrequired

Paywall yerelleştirmesi için yerel ayar kodu. Dil ve bölge alt etiketlerini tire (-) ile ayırarak kullanır. Örnekler: İngilizce için en, Brezilya Portekizcesi için pt-br.

datastringrequired

Paywall'ınızın remote config'ini temsil eden serileştirilmiş JSON dizesi. Adapty Kontrol Paneli'nde belirli bir paywall'ın Remote Config sekmesinde bulabilirsiniz.

Example 
{
  "placement_id": "onboarding",
  "variation_id": "d76feea0-c0cf-4942-bef5-84ed701fc6db",
  "paywall_id": "9a93fe6f-9162-4dc0-b4b7-73079ed95c34",
  "ab_test_name": "1 week + 1 month | apple picture",
  "paywall_name": "1 week + 1 month | apple picture",
  "products": [
    {
      "title": "1 week",
      "is_consumable": false,
      "adapty_product_id": "1c3e03e1-9c43-4f94-aeb5-c7ae2f73d0c2",
      "vendor_product_id": "1_week_apple",
      "introductory_offer_eligibility": true,
      "promotional_offer_eligibility": true,
      "base_plan_id": null,
      "offer": null
    },
    {
      "title": "1 month",
      "is_consumable": false,
      "adapty_product_id": "f4088450-45a8-4737-8db0-367e642d7dcb",
      "vendor_product_id": "1_month_apple",
      "introductory_offer_eligibility": true,
      "promotional_offer_eligibility": true,
      "base_plan_id": null,
      "offer": null
    }
  ],
  "remote_config": {
    "lang": "en",
    "data": "{\"default_product_number\":1,\"features\":[\"#fresh\",\"#green\",\"#healthy1\"],\"soft_paywall\":false,\"image_url\":\"https://adapty.io/apple.png\"}"
  }
}

Hatalı İstek

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Yetkisiz

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Bulunamadı

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger