広告ユニット API v1
Ad Units API v1を使用してモバイル広告単位設定をプログラムで設定および取得し、広告配置管理を効率化します。
読み終わるまでの所要時間 14 分最終更新 7日前
この API を使用して、LevelPlay ダッシュボードで広告ユニットを管理します。API は以下のサポートします。
- 広告ユニットの作成と更新
- 広告ユニット設定の管理
要求は呼び出しごとに 1 アプリケーションに制限されます。
レート制限
リクエストが 30 分間に 4000 リクエストを超えた場合、API は 429 HTTP 状態コードを返します。
認証タイプ
GET
説明
アプリケーションの広告ユニットのリストを取得します。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
反応パラメータ
Name (名前) | 説明 | 例 |
|---|---|---|
| mediationAdUnitId | 広告単位作成時に LevelPlay プラットフォームによって生成される一意の広告単位 ID | fgx25t56dq201bd2 |
| mediationAdUnitName | 広告単位名 | interstitial-1 |
| adFormat | リワード、インタースティシャル、バナー、ネイティブ | インタースティシャル |
| hasAbTest | A/Bテストがアクティブかどうかを示す(アクティブの場合はtrue、それ以外の場合はfalse) | false |
| isPaused | 広告単位が現在一時停止しているかどうかを示します(一時停止の場合はtrue、アクティブな場合はfalse)。 | false |
| 報酬 | 報酬、報酬の名前と金額を表します。リワード型広告の形式にのみ関連 | |
| これらは「reward」パラメーターの以下の報酬フィールドです。 | ||
| rewardItemName | 報酬項目の名前を指定します | 仮想項目 |
| rewardAmount | 報酬の金額または値を示します。 | 1 |
| settings | 広告単位に属する設定のリスト | |
| これらは「settings」配列の以下の設定フィールドです。 | ||
| testGroup | 関連する設定テスト | A |
| cappingEnabled | 上限または制限が適用されているかどうかを示します (有効の場合は true、有効でない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | true |
| cappingLimit | 広告単位の最大キャップ値を指定します。 | 2 |
| cappingInterval | 'd' (日) または 'h' (時間) の時間間隔を定義します。 | d |
| pacingEnabled | ペーシングがアクティブかどうかを示します (有効な場合は true、そうでない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | false |
| pacingMinutes | ペーシング間隔を分単位で指定します。 | 5.2 |
| bannerRefreshRate | バナーのリフレッシュ レートを秒単位で設定します。バナー広告形式にのみ関連 | 10 |
反応例
[ { "mediationAdUnitId": "fgx25t56dq201bd2", "mediationAdUnitName":"Banner", "adFormat": "banner", "hasAbTest": true, "isPaused": false, "settings": [ { "testGroup":"A", "bannerRefreshRate":15 }, { "testGroup":"B", "bannerRefreshRate":20 } ] }, { "mediationAdUnitId":"8oe7wr90gbsbaj74", "mediationAdUnitName":"Interstitial", "adFormat": "interstitial", "hasAbTest": false, "isPaused": false, "settings": [ { "testGroup": null, "cappingEnabled": false, "pacingEnabled": false } ] }, { "mediationAdUnitId": "v5ipmsg9d4hiqp60", "mediationAdUnitName":"ネイティブ", "adFormat": "native", "hasAbTest": false, "isPaused": false, "settings": [ { "testGroup": null } ] }, { "mediationAdUnitId":"33o8iowbyf3vvof2", "mediationAdUnitName":「報酬型」、 "adFormat": "rewarded", "hasAbTest": false, "isPaused": false, "reward": { "rewardItemName":"仮想項目", "rewardAmount":1 }, "settings": [ { "testGroup": null, "cappingEnabled": true, "cappingLimit":2, "cappingInterval": "d", "pacingEnabled": true, "pacingMinutes":5.2 } ] }]
作成
この API を使用してメディエーション広告ユニットを作成します。この API を使用すると、1 つの API 呼び出しで複数の広告ユニットを作成できます。「settings」パラメーターを使用すると、広告単位ごとに特定の設定を定義できます。
- この API を使用すると、1 つの API 呼び出しで複数の広告ユニットを作成できます。
- この API への GET 呼び出しを使用して広告単位 ID 値に到達できます。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
サポートされているパラメーター
Name (名前) | 型 | 説明 | 必須 | 例 |
|---|---|---|---|---|
| mediationAdUnitName | String | 新しく作成した広告単位の名前の長さは 1 から 255 の範囲でなければなりません | ✓ | Interstitial-1 |
| adFormat | String | リワード、インタースティシャル、バナー、ネイティブ | ✓ | インタースティシャル |
| 報酬 | オブジェクト | 報酬、報酬の名前と金額を表します。リワード型広告形式にのみ関連あり広告形式がリワード型の場合は必須 | x | |
| rewardItemName | String | 報酬項目の名前を指定します。長さは 1 から 32 の範囲でなければなりません。 | ✓ | 仮想項目 |
| rewardAmount | 数値 | 報酬の金額または値を示します。 | ✓ | 1 |
| settings | 配列 | 設定のリスト。指定しない場合、デフォルト値が設定されます。 | x | |
| これらは「settings」配列の以下の設定フィールドです。 | ||||
| testGroup | String | 関連する AB テストグループ。testGroup 値は 'null' にするか、AB テストがない場合は送信しないでください。 | x | null |
| cappingEnabled | Boolean | 上限または制限が適用されているかどうかを示します (有効の場合は true、有効でない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | x | true |
| cappingLimit | 数値 | 広告単位の最大キャップ値を指定します。 | x | 5 |
| cappingInterval | String | 'd' (日) または 'h' (時間) の時間間隔を定義します。 | x | d |
| pacingEnabled | Boolean | ペーシングがアクティブかどうかを示します (有効な場合は true、そうでない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | x | true |
| pacingMinutes | 数値 | ペーシング間隔を分単位で指定します。 Float 数の最大値は 1000 です。 | x | 4.6 |
| bannerRefreshRate | 数値 | バナーのリフレッシュ レートを秒単位で設定します。バナー広告形式にのみ関連します。送信されない場合のデフォルト値：25 可能な値は 0、10、15、20、25、30、45、60、120、240 です。 | x | 10 |
リクエスト例
[ { "mediationAdUnitName": "interstitial-1", "adFormat": "interstitial", "settings": [ { "testGroup": null, "cappingEnabled": true, "cappingInterval": "d", "cappingLimit":5, "pacingEnabled": true, "pacingMinutes":4.6 } ] }, { "mediationAdUnitName": "banner-1", "adFormat": "banner", "settings": [ { "bannerRefreshRate":10 } ] }, { "mediationAdUnitName": "rewarded-1", "adFormat": "rewarded", "reward": { "rewardItemName":"仮想項目", "rewardAmount":1 } }]
update
説明
このAPIを使用してメディエーション広告ユニット設定を更新
1つのAPI呼び出しで複数の広告ユニットを更新可能
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
サポートされているパラメーター
Name (名前) | 型 | 説明 | 必須 | 例 |
|---|---|---|---|---|
| mediationAdunitId | String | GET リクエストで送信された広告単位 ID | ✓ | fgx25t56dq201bd2 |
| mediationAdUnitName | String | 新しく作成した広告単位の名前の長さは 1 から 255 の範囲でなければなりません | x | interstitial-1 |
| isPaused | Boolean | 広告単位が現在一時停止しているかどうかを示します(一時停止の場合は true、アクティブな場合は false)。広告単位の一時停止の場合は true、広告単位の一時停止を解除する場合は false。 | x | false |
| 報酬 | オブジェクト | 報酬、報酬の名前と金額を表します。リワード型広告形式にのみ関連あり広告形式がリワード型の場合は必須 | x | |
| rewardItemName | String | 報酬項目の名前を指定します。長さは 1 から 32 の範囲でなければなりません。 | ✓ | 仮想項目 |
| rewardAmount | 数値 | 報酬の金額または値を示します。 | ✓ | 1 |
| settings | 配列 | 設定のリスト。指定しない場合、デフォルト値が設定されます。 | x | |
| これらは「settings」配列の以下の設定フィールドです。 | ||||
| testGroup | String | 関連する AB テストグループ。null/"A"/"B" | x | null |
| cappingEnabled | Boolean | 上限または制限が適用されているかどうかを示します (有効の場合は true、有効でない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | x | true |
| cappingLimit | 数値 | 広告単位の最大キャップ値を指定します。 | x | 5 |
| cappingInterval | String | 'd' (日) または 'h' (時間) の時間間隔を定義します。 | x | d |
| pacingEnabled | Boolean | ペーシングがアクティブかどうかを示します (有効な場合は true、そうでない場合は false)。リワード型およびインタースティシャル広告フォーマットにのみ関連 | x | true |
| pacingMinutes | 数値 | ペーシング間隔を分単位で指定します。 Float 数の最大値は 1000 です。 | x | 4.6 |
| bannerRefreshRate | 数値 | バナーのリフレッシュ レートを秒単位で設定します。バナー広告形式にのみ関連します。送信されない場合のデフォルト値：25 可能な値は 0、10、15、20、25、30、45、60、120、240 です。 | x | 10 |
リクエスト例
[ { "mediationAdUnitId": "fgx25t56dq201bd2", "mediationAdUnitName": "interstitial-1", "settings": [ { "testGroup": null, "cappingEnabled": true, "cappingInterval": "d", "cappingLimit":5, "pacingEnabled": false } ] }, { "mediationAdUnitId": "agv25t56g6hj01bd2", "mediationAdUnitName": "banner-1", "settings": [ { "testGroup":"A", "bannerRefreshRate":30 }, { "testGroup":"B", "bannerRefreshRate":10 } ] }, { "mediationAdUnitId": "qtr25t56dq201bd2", "reward": { "rewardItemName":"仮想項目", "rewardAmount":1 } }]
Success
正常な反応は HTTP コード 200 で送信されます。
エラー
リクエストで送信されたグループのいずれかが失敗した場合、エラー配列が HTTP コード 400 で送信され、リクエスト全体が拒否されます。
各エラーの後にエラーメッセージが表示されます。
例
{ "errorsArray": [ { "code": "ERR-4332", "errorMessage": "cappingInterval value must be either 'd' (days) or 'h' (hours)", "params": { "[0].settings[0].cappingInterval": "s" } } ], "code": 400}