プレースメント API
Placements API を使用して広告プレースメントを作成、取得、更新、削除することで、AIR アプリケーション内の配置設定を管理できます。
読み終わるまでの所要時間 12 分最終更新 6日前
この API を使用して、LevelPlay アカウントの広告単位レベルでプレースメントを管理します。この API により、以下が可能になります。
- プレースメントのリストの詳細を取得する
- 新しいプレースメントの作成と配置広告の配信設定の定義
- 既存のプレースメントの更新
- プレースメントの削除(アーカイブ)
詳細については、プレースメント を参照してください。
注
各 API リクエストは、Bearer API 認証 を使用して認証する必要があります。
Get メソッド
説明
配置設定情報を提供します。
リクエスト
リクエスト URL 例
リクエストパラメーター
キー /Key | 型 | 説明 | 値 | 必須 |
|---|---|---|---|---|
| appKey | string | アプリケーション一意の識別子 | v |
レスポンス
反応パラメータ
キー /Key | 型 | 説明 | 必須 |
|---|---|---|---|
| adUnit | string | 広告単位名：rewardedVideo インタースティシャルバナー | v |
| name | string | 配置一意の名前 | v |
| id | integer | 配置一意の識別子 | v |
| adDelivery | integer | 配置広告配信がオンの場合は 1、それ以外の場合は 0 | v |
| itemName | string | 報酬名 (最大 30 文字) | v (動画リワードのみ) |
| rewardAmount | integer | 1 つの広告ビューに贈るアイテムの数 (最大 2000000000) | v (動画リワードのみ) |
| capping.enabled | integer | 1 の場合は上限設定を有効にし、0 の場合は無効にします。 | |
| capping.limit | integer | 上限インターバルごとに配信される広告の最大数 (最大 1000) | |
| capping.interval | string | capping interval： d - days h - hours | |
| pacing.enabled | integer | pacinhg を有効にする場合は 1、有効にしない場合は 0 | |
| pacing.minutes | float | 広告配信間の最小ギャップ (分単位) (最大 1000) |
反応ボディ例
[ { "name": "Home_Screen", "id": 12, "adUnit": "rewardedVideo", "itemName":コイン "rewardAmount":3, "adDelivery":1, "capping": { "enabled":1, "cappingLimit":3, "cappingInterval": "h" }, "pacing": { "enabled":1, "pacingMinutes":12.5 }, "abVersion":"A" }]
Post メソッド
このメソッドを使用して、アプリケーションアカウントに新しいプレースメントを作成します。これには、制限とペーシングの設定が含まれます。
プレースメントは広告単位タイプごとに作成され、各配置は 1 広告単位ごとにのみ追加できます。以下の広告ユニットでの API サポート作成。
動画リワード
-
Interstitial (インタースティシャル)
-
Banner
-
配置名は広告単位タイプごとに一意の名前にする必要があります
-
1 つの POST 呼び出しでの複数のプレースメントの作成がサポートされています。
-
反応として、プレースメント ID を受け取ります。このパラメーターは Ironsource プラットフォームでは表示されません。このパラメーターは PUT メソッドと DELETE メソッドに使用する必要があります
リクエスト
リクエスト ボディ パラメータ
キー /Key | 型 | 説明 | 必須 |
|---|---|---|---|
| appKey | string | プレースメントを作成するためのアプリケーション キー | v |
| プレースメント | array | 作成するプレースメントのリスト | v |
| これらは「placements」配列の以下の配置フィールドです。 | |||
| adUnit | string | 広告単位名：rewardedVideo インタースティシャルバナー | v |
| name | string | 配置一意の名前 | v |
| adDelivery | ボレアン | 配置広告配信がオンの場合は 1、それ以外の場合は 0 (デフォルト 1) | |
| itemName | string | 報酬名 (最大 30 文字) | v (動画リワードのみ) |
| rewardAmount | integer | 1 つの広告ビューに贈るアイテムの数 (最大 2000000000) | v (動画リワードのみ) |
| capping.enabled | integer | 1 の場合は上限設定を有効にし、0 の場合は無効にします。 | |
| capping.limit | integer | 上限インターバルごとに配信される広告の最大数 (最大 1000) | |
| capping.interval | string | capping interval： d - days h - hours | |
| pacing.enabled | integer | pacinhg を有効にする場合は 1、有効にしない場合は 0 | |
| pacing.minutes | float | 広告配信間の最小ギャップ (分単位) (最大 1000) |
リクエスト ボディ例
{ "appKey":"28cd2e39", "placements": [ { "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner "name": "メインメニュー", // 一意の配置名 "itemName": "coin", // the rewarded item name "rewardAmount":25, // 広告ビューごとに付与するゲームゲーム内報酬の額 "capping": { "enabled":1， // 1 - capping を有効にします。有効でない場合は 0（デフォルト：1) "cappingLimit":3， // cappingInterval あたりの広告の制限 "cappingInterval": "h" // interval type. "h"-hours, "d"-days (デフォルト: "d") } }, { "adUnit": "banner", "name": "Custom_Pause", "pacing": { "enabled":0， // 1 - ペーシングを有効にします。そうでない場合は 0（デフォルト：1) "pacingMinutes":3、 // 分単位の間隔 } } ]}
レスポンス
成功の反応には、配置識別子が新たに作成されます。このパラメーターは Ironsource プラットフォームでは表示されず、GET メソッドを使用して取得できます。プレースメントを編集/削除するときに、この ID を使用する必要があります。
反応パラメータ
キー /Key | 型 | 説明 | 値 | 必須 |
|---|---|---|---|---|
| appKey | string | アプリケーションの一意の識別子 | v | |
| adUnit | string | 広告単位の名前 | rewardedVideo インタースティシャルバナー | v |
| name | string | 配置の名前 | 最大 30 文字 | v |
| id | string | 配置 ID |
反応ボディ例
{ "appKey":"28cd2e39", "placements": [ { "adUnit": "rewardedVideo", "id": 2， // 配置の一意の ID "name": "Main_Menu" }, { "adUnit": "banner", "id": 4, "name": "Custom_Pause" } ]}
Put メソッド
アプリケーションの制限やペーシングなど、既存のプレースメントの更新 API は以下の広告ユニットをサポートします。
- 動画リワード
- Interstitial (インタースティシャル)
- Banner
デフォルト配置広告配信はオフに切り替えることはできません。
上限/ペーシングを有効にするには、金額フィールドを指定する必要があります。
リクエスト
リクエスト URL 例
https://dev-php-ssp5.supersonicads.com/partners/publisher/placements/v1?appKey=132deb27dリクエスト ボディ パラメータ
キー /Key | 型 | 説明 | 必須 |
|---|---|---|---|
| appKey | string | プレースメントを更新するアプリケーションキー | v |
| プレースメント | array | 更新するプレースメントのリスト | v |
| これらは「placements」配列の以下の配置フィールドです | |||
| adUnit | string | 広告単位名：rewardedVideo インタースティシャルバナー | v |
| id | integer | 配置一意の ID | v |
| adDelivery | integer | 配置広告配信がオンの場合は 1、それ以外の場合は 0 | |
| itemName | string | 報酬名 (最大 30 文字) | |
| rewardAmount | integer | 1 つの広告ビューに贈るアイテムの数 (最大 2000000000) | |
| capping.enabled | integer | 1 の場合は上限設定を有効にし、0 の場合は無効にします。 | |
| capping.limit | integer | 上限インターバルごとに配信される広告の最大数 (最大 1000) | |
| capping.interval | string | capping interval： d - days h - hours | |
| pacing.enabled | integer | pacinhg を有効にする場合は 1、有効にしない場合は 0 | |
| pacing.minutes | float | 広告配信間の最小ギャップ (分単位) (最大 1000) |
リクエスト ボディ例
{ "appKey":"28cd2e39", "placements": [ { "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner "id": 1, // 一意のの配置 ID "rewardAmount":25, // 渡すゲームゲーム内報酬の金額の変更 "adDelivery":1, // 広告配信の切り替え、1 - 有効、0 "capping": { "cappingInterval": "h" // updating capping interval to hours } }, { "adUnit": "interstitial", "id": 3, "pacing": { "enabled":1, // 1 - ペーシングを有効にします。そうでない場合は 0 "pacingMinutes":15, // 間隔を分単位で指定 } } ]}
レスポンス
更新が成功した場合、HTTP コード「200」はメッセージ「true」で応答されます。
削除メソッド
アプリケーションの既存のプレースメントをアーカイブ API は以下の広告ユニットをサポートします。
- 動画リワード
- Interstitial (インタースティシャル)
- Banner
注
デフォルト配置はアーカイブできません
リクエスト
リクエスト ボディ パラメータ
キー /Key | 型 | 説明 | 必須 |
|---|---|---|---|
| appKey | string | 配置をアーカイブするアプリケーション キー | v |
| adUnit | string | 広告単位名：rewardedVideo インタースティシャルバナー | v |
| id | integer | 配置一意の ID | v |
リクエスト ボディ例
{ "appKey":"28cd2e39", "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner "id": 1 // 一意の配置 ID}
レスポンス
更新が成功した場合、HTTP コード「200」はメッセージ「true」で応答されます。