Groups API v4
Groups API v4を使用してグループを作成、更新、フェッチ、削除することで、ユーザーセグメントを整理および管理します。
読み終わるまでの所要時間 16 分最終更新 6日前
重要
API バージョン 3 以下は、2025 年 3 月 時点で非推奨です。中断を避けるために最新バージョンに更新。
この API を使用して、LevelPlay ダッシュボードでメディエーショングループを管理します。API は以下のサポートします。
- メディエーショングループ設定の管理
- メディエーショングループごとのウォーターフォールの管理
要求は呼び出しごとに 1 アプリケーションに制限されます。
レート制限
リクエストが 30 分間に 4000 リクエストを超えた場合、API は 429 HTTP 状態コードを返します。
認証タイプ
GET
説明
アプリケーション グループのリストを取得します。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
反応パラメータ
Name (名前) | 説明 | 例 |
|---|---|---|
| groupId | グループ作成時に LevelPlay プラットフォームによって生成される一意のグループ ID | 2432228 |
| groupName | グループ名 | SpeakingEnglish |
| mediationAdUnitId | グループが属する広告単位のID | fgx25t56dq201bd2 |
| mediationAdUnitName | グループが属する広告単位の名前 | interstitial-1 |
| adFormat | リワード、インタースティシャル、バナー、ネイティブ | インタースティシャル |
| abTest | 関連するグループテスト | A |
| 位置 | リスト内のグループの位置 | 1 |
| floorPrice | インプレッションあたりの最低入札額（CPM） | 1.3 |
| countries | グループに属する国コードのリスト | 米国、GB |
| セグメント | グループに属するセグメント名のリスト | under30， femaleOnly |
| インスタンス | グループに属するインスタンスのリスト | |
| これらは「インスタンス」配列の以下のインスタンス フィールドです。 | ||
| id | LevelPlay インスタンス API で送信されるインスタンス ID | 128395 |
| name | インスタンス名 | Rewarded50 |
| networkName | インスタンスが属する広告ネットワーク | unityAds |
| isBidder | 入札者インスタンスの場合は true、それ以外の場合は false | false |
| groupRate | ウォーターフォール内のインスタンスの優先順位付けに使用されます。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | 11.9 |
| countriesRate | グループレベルのレートと異なる国レートのリスト | |
| 「countriesRate」配列の以下の countryRate フィールド | ||
| countryCode | ISO 3166-1アルファ2に従って2文字の国コードで定義される国コード | GB |
| 率 | ウォーターフォール内のインスタンスの優先順位付けとレポートに使用されます。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | 9 |
反応例
[ { "groupId":12673, "groupName": "newGroup", "mediationAdUnitId": "fgx25t56dq201bd2", "mediationAdUnitName": "interstitial-1", "adFormat": "interstitial", "abTest":"A", "countries": ["FR","US"], "position":1, "segments": [], "floorPrice":0.3, "instances": [ { "id": 3681, "name": "", "networkName": "ironSource", "isBidder": true }, { "id": 2, "name": "Default", "isBidder": false, "networkName": "unityAds", "groupRate":5, "countriesRate": [ { "countryCode":"FR", "rate":1 } ] } ] }]
作成
この API を使用してメディエーショングループを作成します。この API を使用すると、1 つの API 呼び出しで複数のグループを作成できます。"instances"パラメーターを使用して、グループに含める/除外する各インスタンスを決定します。"インスタンス ID 値は、Instances API を使用してアクセスできます。
- この API を使用すると、1 つの API 呼び出しで複数のグループを作成できます。
- グループ ID 値は、この API の取得呼び出しを使用してアクセスできます。
- インスタンス ID 値は、Instances API を使用してアクセスできます。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
サポートされているパラメーター
Name (名前) | 型 | 説明 | 必須 | 例 |
|---|---|---|---|---|
| groupName | String | 新しく作成したグループの名前の長さは、1 から 32 までの範囲でなければなりません。 | ✓ | Tier 1 |
| adFormat | String | リワード、インタースティシャル、バナー、ネイティブ | ✓ | インタースティシャル |
| mediationAdUnitId | String | グループが属する広告単位の ID 広告形式に複数の広告単位が存在する場合は必須 | x | fgx25t56dq201bd2 |
| 位置 | 数値 | リスト内のグループの位置は、リストの 1 から最大グループまでである必要があります (allCountries グループを除く)。 | ✓ | 2 |
| abTest | String | 関連する AB テストグループA,B | x | B |
| floorPrice | 数値 | インプレッションあたりの最低入札額。CPM で表されます。 | x | 15 |
| countries | 文字列の配列 | ISO 3166-1 アルファ 2 に従って 2 文字の国コードで定義される国コードの配列指定しない場合、デフォルトは allCountries になります。 | x | 米国、GB |
| セグメント | 文字列の配列 | セグメント名の配列 | x | under30， femaleOnly |
| インスタンス | 配列 | 更新するインスタンスのリスト。指定しない場合、デフォルトは広告形式に設定されているすべてのインスタンスが含まれます。 | x | |
| これらは「インスタンス」配列の以下のインスタンス フィールドです。 | ||||
| id | 数値 | LevelPlay インスタンス API で送信されるインスタンス ID | ✓ | 124526 |
| groupRate | 数値 | ウォーターフォール内のインスタンスの優先順位付けに使用されます。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | x | 0.6 |
| countriesRate | 配列 | 更新する国レートのリスト | x | |
| 「countriesRate」配列の以下の countryRate フィールド | ||||
| countryCode | String | 国コード。 ISO 3166-1 アルファ 2 に従って 2 文字の国コードで定義されます。 | ✓ | AU |
| 率 | 数値 | ウォーターフォール内のインスタンスの優先順位付けにのみ使用します。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | ✓ | 2.4 |
リクエスト例
[ { "groupName": "new group", "adFormat": "rewarded", "mediationAdUnitId": "fgx25t56dq201bd2", "countries": ["FR","US"], "position":1, "segments": ["nonPaying"], "abTest":"B", "floorPrice":0.3, "instances": [ { "id": 7983541, "groupRate":2, "countriesRate": [ { "countryCode":"FR", "rate":1 } ] }, { "id": 4896357 }, { "id": 62624583, "countriesRate": [ { "countryCode":"US", "rate":5.3 } ] } ] }]
update
このAPIを使用して、メディエーショングループの設定設定とウォーターフォールを更新
- 1つのAPI呼び出しで複数のグループを更新可能
- groupRate/countryRate を削除するには、フィールドパラメーターに null 値を追加します。
- 配列フィールドを更新するには、すべての値（新規および既存）を含めます。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
サポートされているパラメーター
Name (名前) | 型 | 説明 | 必須 | 例 |
|---|---|---|---|---|
| groupId | 数値 | GET リクエストで送信されたグループ ID | ✓ | 12673 |
| groupName | String | 新しく作成されたグループの名前の長さは 1 から 32 の範囲である必要があります | x | 英語を話す |
| 位置 | 数値 | リスト内のグループの位置は、リストの 1 から最大グループまでである必要があります (allCountries グループを除く)。 | x | 2 |
| floorPrice | 数値 | インプレッションあたりの最低入札額（CPM） | x | 15 |
| countries | 文字列の配列 | ISO 3166-1 アルファ 2 に従って 2 文字の国コードで定義される国コードの配列。指定しない場合、デフォルトは allCountries になります。 | x | 米国、GB |
| セグメント | 文字列の配列 | セグメント名の配列 | x | under30， femaleOnly |
| インスタンス | 配列 | 更新するインスタンスのリスト。指定しない場合、デフォルトは広告形式に設定されているすべてのインスタンスが含まれます。 | x | |
| これらは「インスタンス」配列の以下のインスタンス フィールドです。 | ||||
| id | 数値 | LevelPlay インスタンス API で送信されるインスタンス ID | ✓ | 123658 |
| groupRate | 数値 | ウォーターフォール内のインスタンスの優先順位付けにのみ使用します。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | x | 0.6 |
| countriesRate | 配列 | 更新する countryRate のリスト | x | |
| 「countriesRate」配列の以下の countryRate フィールド | ||||
| countryCode | string | ISO 3166-1アルファ2に従って2文字の国コードで定義される国コード | ✓ | AU |
| 率 | 数値 | ウォーターフォール内のインスタンスの優先順位付けにのみ使用します。0.01 ~ 3000 の範囲でなければなりません。メディエーション管理 を参照してください。 | ✓ | 2.5 |
リクエスト例
[ { "groupId":123, "groupName": "new group", "countries": ["FR","US"], "position":1, "segments": [], "floorPrice":0.3, "instances": [ { "id": 1, "groupRate": null, "countriesRate": [ { "countryCode":"FR", "rate":1 } ] }, { "id": 2, "countriesRate": [ { "countryCode":"FR", "rate":1.4 } ] } ] }]
Success
正常な反応は HTTP コード 200 で送信されます。
DELETE
この API を使用してインスタンスを削除します。
- AllCountries グループは削除できません。
- 削除されたグループは復元できません。
メソッド
リクエストパラメーター
Name (名前) | 型 | 説明 | 例 |
|---|---|---|---|
| appKey | String | アプリケーションキー (プラットフォーム上に表示されるもの) | 142401ac1 |
リクエストの URL 例
サポートされているパラメーター
Name (名前) | 型 | 説明 | 必須 | 例 |
|---|---|---|---|---|
| ids | number の配列 | GET リクエストで送信されたグループ ID | ✓ | 12473, 47238 |
リクエスト ボディ例
{ "ids": [1458, 5769]}
Success
正常な反応は HTTP コード 200 で送信されます。
エラー
リクエストで送信されたグループのいずれかが失敗した場合、エラー配列が HTTP コード 400 で送信され、リクエスト全体が拒否されます。
各エラーの後にエラーメッセージが表示されます。
例
{ "errorsArray": [ { "code": ERR-208、 "errorMessage":"グループ名の値が必要です", "params": { "[0].groupName": "" } }, { "code": ERR-311、 "errorMessage":"グループ位置値が有効ではありません", "params": { "[0].position": "" } } ], "code": 400}