POST /api/v1/client-api/exports/placements/

プレースメント情報を取得する

ペイウォール、オンボーディング、またはフローのプレースメントの設定を取得します。各プレースメントのオーディエンス、セグメント、A/B テスト、および各オーディエンスに表示されるペイウォール、オンボーディング、またはフローが含まれます。これにより、各プレースメントを個別に開かずに、すべてが正しく設定されているかどうかを確認できます。

レート制限: 1秒あたり2リクエスト。

Request body

filtersobjectrequired

placement_typestringrequired

返すプレースメントのタイプ。各リクエストは1種類のタイプのプレースメントを返します。

One of: "paywall", "onboarding", "flow"

Responses

プレースメント情報が正常に取得されました

Schema

レスポンスには、リクエストした placement_type に応じて名付けられた配列が1つ含まれます: paywall_placements、onboarding_placements、または flow_placements。

paywall_placementsarray of object

placement_type が paywall の場合に返されます

developer_idstring

プレースメントID

placement_namestring

プレースメント名

audience_namestring

オーディエンス名

segment_namestring

オーディエンスの基となるセグメントの名前

cross_placement_ab_test_namestring

クロスプレースメントA/B テスト名

ab_test_namestring

A/B テスト名

paywall_namestring

このプレースメントに表示されるペイウォールの名前

onboarding_placementsarray of object

placement_type が onboarding の場合に返されます

developer_idstring

プレースメントID

placement_namestring

プレースメント名

audience_namestring

オーディエンス名

segment_namestring

オーディエンスの基となるセグメントの名前

cross_placement_ab_test_namestring

クロスプレースメントA/B テスト名

ab_test_namestring

A/B テスト名

onboarding_namestring

このプレースメントに表示されるオンボーディングの名前

flow_placementsarray of object

placement_type が flow の場合に返されます

developer_idstring

プレースメントID

placement_namestring

プレースメント名

audience_namestring

オーディエンス名

segment_namestring

オーディエンスの基となるセグメントの名前

cross_placement_ab_test_namestring

クロスプレースメントA/B テスト名

ab_test_namestring

A/B テスト名

flow_namestring

このプレースメントで表示されるフローの名前

Bad Request

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Unauthorized

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

レート制限を超えました。APIキーごとに1秒あたり最大2リクエストです。

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/exports/placements/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "placement_type": "paywall"
    }
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/exports/placements/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "placement_type": "paywall"
    }
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/exports/placements/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "placement_type": "paywall"
      }
    })
data = response.json()