English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
GET /api/v2/server-side-api/paywalls/{paywall_id}/

Lấy paywall

Copy as Markdown

Truy xuất một paywall cụ thể trong ứng dụng của bạn.

Path parameters

paywall_idstring · uuidrequired

Định danh duy nhất của paywall cần truy xuất

Responses

Lấy paywall thành công

Schema
titlestringrequired

Tên của paywall, như được định nghĩa trong Adapty Dashboard của bạn

paywall_idstringrequired

Mã định danh duy nhất của paywall

use_paywall_builderbooleanrequired

Paywall có sử dụng Paywall Builder hay không

use_paywall_builder_legacybooleanrequired

Paywall có sử dụng Paywall Builder phiên bản cũ hay không

updated_atstringrequired

Thời điểm paywall được cập nhật lần cuối

created_atstringrequired

Thời điểm paywall được tạo

statestringrequired

Trạng thái hiện tại của paywall

One of: "draft", "live", "inactive", "archived"

is_deletedbooleanrequired

Paywall có được đánh dấu là đã xóa hay không

web_purchase_urlstring

URL để mua hàng qua web, nếu có

productsarray of objectrequired

Mảng các đối tượng Product chứa thông tin sản phẩm

product_idstringrequired

Mã định danh duy nhất của sản phẩm

titlestringrequired

Tiêu đề của sản phẩm

product_setstringrequired

Danh mục nhóm sản phẩm

One of: "weekly", "monthly", "trimonthly", "semiannual", "annual", "lifetime", "uncategorised", "nonsubscriptions", "two_months", "consumable"

offerobjectrequired
product_offer_idstringrequired

Mã định danh duy nhất của ưu đãi sản phẩm

titlestringrequired

Tiêu đề của ưu đãi

remote_configsarray of object

Mảng các đối tượng RemoteConfig với ngôn ngữ địa phương và dữ liệu

localestringrequired

Ngôn ngữ địa phương cho Remote Config

datastringrequired

Chuỗi JSON chứa dữ liệu Remote Config

main_screenshotobject

Đối tượng ảnh chụp màn hình chính với image_id và url

image_idintegerrequired

Mã định danh duy nhất của hình ảnh

urlstringrequired

URL của hình ảnh

Example 
{
  "title": "Premium Subscription",
  "paywall_id": "fd891d4f-5906-45b9-97c1-13cc3dc665df",
  "use_paywall_builder": true,
  "use_paywall_builder_legacy": false,
  "updated_at": "2025-07-30T11:13:58.798Z",
  "created_at": "2025-07-30T11:13:58.798Z",
  "state": "live",
  "is_deleted": false,
  "web_purchase_url": "https://example.com/purchase",
  "products": [
    {
      "product_id": "b95e9e51-a056-4eb6-9cf7-b75d139e7c3c",
      "title": "Premium Monthly",
      "product_set": "uncategorised",
      "offer": {
        "product_offer_id": "e31a4296-f250-4faf-ac80-3cc93c2da8f5",
        "title": "Free Trial"
      }
    }
  ],
  "remote_configs": [
    {
      "locale": "en",
      "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
    }
  ],
  "main_screenshot": {
    "image_id": 123456,
    "url": "https://public-media.adapty.io/public/screenshot.jpg"
  }
}

Không được phép

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example 
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Không tìm thấy paywall

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example 
{
  "errors": [
    {
      "source": null,
      "errors": [
        "Paywall not found"
      ]
    }
  ],
  "error_code": "paywall_does_not_exist",
  "status_code": 404
}

Lỗi máy chủ nội bộ

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP