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

Получить пейвол

Copy as Markdown

Возвращает пейвол из указанного плейсмента.

Request body

storestringrequired

Стор, в котором был куплен продукт. Возможные значения: app_store, play_store, stripe или Store ID вашего пользовательского стора.

localestring

Идентификатор локали пейвола. Ожидается языковой код, состоящий из одного или нескольких субтегов, разделённых символом «-». Первый субтег — для языка, второй — для региона.

placement_idstringrequired

Идентификатор плейсмента. Это значение, которое вы указали при создании плейсмента в дашборде Adapty.

customer_user_idstring

Требуется либо customer_user_id, либо profile_id. Идентификатор пользователя, который вы используете в своём приложении. Например, это может быть UUID пользователя, email или любой другой идентификатор.

profile_idstring

Требуется либо customer_user_id, либо profile_id. Идентификатор пользователя в Adapty.

Responses

Успешный ответ будет содержать объект пейвола.

Schema
placement_idstringrequired

Идентификатор плейсмента, в котором отображается этот пейвол. Это значение задаётся при создании плейсмента в дашборде Adapty.

variation_idstringrequired

Идентификатор варианта, используемый для отслеживания покупок, связанных с конкретным пейволом.

paywall_idstringrequired

Уникальный идентификатор пейвола.

ab_test_namestring

Название родительского A/B-теста.

paywall_namestringrequired

Название пейвола, заданное в дашборде Adapty.

productsarray of objectrequired

Массив объектов продуктов, содержащих информацию о продуктах для пейвола.

titlestring

Название продукта из раздела «Products» в дашборде Adapty.

is_consumablebooleanrequired

Указывает, является ли продукт расходуемой покупкой.

adapty_product_idstring

Внутренний идентификатор продукта в Adapty.

vendor_product_idstringrequired

Идентификатор продукта в сторах приложений.

introductory_offer_eligibilityboolean

Указывает, имеет ли пользователь право на introductory offer для iOS.

promotional_offer_eligibilityboolean

Указывает, имеет ли пользователь право на promotional offer.

base_plan_idstring

Идентификатор базового плана для Google Play или идентификатор цены для Stripe. См. Base plan ID для Google Play или price ID для Stripe.

offerallOf

Объект Offer в формате JSON.

categorystring

Категория применённого предложения.

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

typestring

Тип активного предложения. Если это значение не равно null, предложение было применено в текущем расчётном периоде подписки.

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

idstring

Идентификатор применённого предложения.

remote_configobject

Объект RemoteConfig, содержащий полный Remote Config пейвола.

langstringrequired

Код локали для локализации пейвола. Использует субтеги языка и региона, разделённые дефисом (-). Примеры: en для английского, pt-br для бразильского португальского.

datastringrequired

Сериализованная JSON-строка, представляющая Remote Config вашего пейвола. Её можно найти на вкладке Remote Config конкретного пейвола в дашборде Adapty.

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\"}"
  }
}

Неверный запрос

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Не авторизован

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Не найдено

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger