# インプレッションレベルの収益サーバー側 API

> ILR Server Side APIを使用して日次CSVレポートにアクセスし、インプレッションとデバイスレベルで広告収益を追跡します。

インプレッションレベル収益（ILR）ソリューションでは、LevelPlay メディエーションで広告のデバイスとインプレッションレベルの両方のデータを提供します。2 つの異なる API があります。

* デバイス レベル データをプルするための1つ
* 1つはインプレッションレベルデータの取得用です。

収益は、アプリケーション、ネットワーク、国、インスタンスに応じて、各インプレッションの eCPM に基づいて計算されます。

## しくみ

* インプレッションレベルとユーザーレベルのデータのプルは、以下の手順を実行して実行します。
  * API リクエストを送信し、レポートをダウンロードするための URL リンクを取得する
  * 提供されたリンクをクリックしてレポートをダウンロードする
* 各 API 呼び出しは、1 つのアプリケーションと 1 つの日付に対して行う必要があります。
* 各日付のデータは保存して 14 日間だけ利用できます。
  * 例: 1 月 1 日のデータは 1 月 14 日まで利用可能
* 毎日、昨日のデータは UTC 午前 10:00 から利用できます。API の呼び出しは、毎日 10:00 AM UTC 以降だけにしてください。
  * 例: 1 月 1 日のデータは 1 月 2 日の午前 10 時 (日本時間) 以降にのみ利用可能。
* 毎日、昨日と一昨日のデータを更新します。データは 2 日後には変更されません。
  * 例: 1 月 1 日のデータは 1 月 2 日と 1 月 3 日に更新される。1 月 3 日以降はデータは変更されない
* Date & アプリケーション キー (日付とアプリキー) はレポート (ファイル) ごとに一意のであるため、インプレッションレポートとユーザーレベルレポートの両方に含まれません。

## インプレッションレベル

### レポート URL 取得のための API リクエスト

> **Note:**
>
> 正しい API リクエストを送信すると、リクエストしたファイルへのリンクが返されます。このファイルをダウンロードできるのは 1 時間です。

### Authenticationタイプ

[Bearer API 認証](/grow/levelplay/platform/api/authentication.md.md)

### メソッド

GET [platform.ironsrc.com/partners/adRevenueMeasurements/v4](http://platform.ironsrc.com/partners/AdRevenueMeasurements/v1)

### 必須パラメーター

| **名前**   | **型** | **説明**                         |
| -------- | ----- | ------------------------------ |
| `date`   | 文字列   | YYYY-MM-DD (UTC タイムゾーン)        |
| `appKey` | 文字列   | アプリケーションキー (プラットフォーム上で表示されるもの) |

#### リクエストの URL 例

[https://platform.ironsrc.com/partners/adRevenueMeasurements/v4?appKey=8a95a38d\\\&date=2020-03-31](https://platform.ironsrc.com/partners/adRevenueMeasurements/v4?appKey=8a95a38d\\\&date=2020-03-31)

### 反応の例 URL

```json
{
"urls": [
"https://user-ad-revenue.s3.amazonaws.com/data/bi_databases/arm/tables/mediation/report_version%3Dv1/publisher_id%3D551399/application_id%3D225509/day%3D2020-03-31/report.csv.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1585751272&Signature=bONL8mMc%2B0kdtekXzmXRT4shidQ%3D"
],
"expiration": "2020-03-31 14:27:52"
}
```

### レポートのダウンロード

レポートをダウンロードする URL を選択します。

### フィールド定義 v3

| **フィールド**                | **説明**                                                                                              | **例**                                |
| ------------------------ | --------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `event timestamp`        | インプレッションの正確な日時（UTC）                                                                                 | 2020-03-30 09:33:58                  |
| `advertising id`         | デバイス広告 ID - GAID または IDFA                                                                           | fdbe7b9b-d183-4c7c-9bb5-59c9df8c35aa |
| `advertising vendor id`  | デバイス広告ベンダーID - アプリケーション セットIDまたはIDFV                                                                | A0810F0B-16C2-474B-B765-77B3A3113AA2 |
| `user id`                | 開発者によって設定されているユーザー ID                                                                               | 135920                               |
| `ad unit`                | 収益が発生した広告の形式                                                                                        | 動画リワード                               |
| `ad network`             | 広告ネットワーク名                                                                                           | Admob                                |
| `creative id`            | 広告キャンペーンのクリエイティブ ID。デフォルトは空の文字列です（Google、Meta、Digital Turbine、および Mintegral ネットワークは含まれません）。         | 65af8c5f9dd504dba89ea38e             |
| `instance name`          | プラットフォームで定義されている広告ネットワークのインスタンス名。入札ソースのインスタンス名は「Bidding」になります。                                      | High (高)                             |
| `country`                | [ISO 3166-1 アルファ-2 に基づく 2 文字の国コード](http://www.iso.org/iso/country_names_and_code_elements)          | CN                                   |
| `placement`              | プラットフォームで定義されたユーザーに関連する配置                                                                           | ホーム画面                                |
| `segment`                | ユーザーが関連づけられているセグメント。セグメント化メソッドに基づいて定義されます。[詳細を読む](/grow/levelplay/platform/settings/segments.md.md) | Tier 1                               |
| `AB Testing`             | ユーザーが割り当てられている A/B テストグループ (「A」、「B」、「N/A」など)                                                        | A、B、N/A                              |
| `revenue`                | ユーザーによって発生した収益 (ドル)。収益値は推定値（CPM / Rate）または正確値（入札者インスタンスの場合、FAN を除く）のいずれかです。                         | 0.5                                  |
| `mediation ad unit id`   | 収益が発生した広告単位のID                                                                                      | fgx25t56dq201bd2                     |
| `mediation ad unit name` | 収益が発生した広告単位の名前                                                                                      |                                      |

### ユーザーレベル

### レポート URL 取得のための API リクエスト

正しい API リクエストを送信すると、リクエストしたファイルへのリンクが返されます。このファイルをダウンロードできるのは 1 時間です。

### 認証タイプ

[Bearer API 認証](/grow/levelplay/platform/api/authentication.md.md)

### メソッド

GET:

```text
platform.ironsrc.com/partners/userAdRevenue/v3
```

### 必須パラメーター

| **名前**       | **型** | **説明**                                     |
| ------------ | ----- | ------------------------------------------ |
| `date`       | 文字列   | YYYY-MM-DD (UTC タイムゾーン)                    |
| `appKey`     | 文字列   | アプリケーションキー (プラットフォーム上で表示されるもの)             |
| `reportType` | 整数    | さまざまなレポート タイプのサポート。現在、 は常に 1 に設定する必要があります。 |

### リクエスト例 URL

```text
https://platform.ironsrc.com/partners/userAdRevenue/v3?appKey=12345678&date=2018-12-15&reportType=1
```

### 反応の例 URL

```text
https://user-ad-revenue.s3.amazonaws.com/data/biデータベース/uar/tables/ネットワーク/レポート バージョン%3Dv1/パブリッシャーID%3D138101/アプリケーションID%3D100411/day%3D2018-07-13/000000.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1532524582&Signature=1U%2FbrLmb%2F7TwXXdoHtb%2F%2FQjrmz0%3D
```

## レポートのダウンロード

レポートをダウンロードする URL を選択します。以下のセクションでは、各種レポートフィールドの定義の概要を説明します。

### フィールド定義

| **フィールド**             | **説明**                          | **例**                                |
| --------------------- | ------------------------------- | ------------------------------------ |
| `Ad Unit`             | 収益が発生した広告単位                     | 動画リワード                               |
| `Advertising ID`      | ユーザーのデバイスの一意の ID                | 21d0e51a-772d-4b23-9fc4-296126b4f123 |
| `Advertising ID Type` | ユーザーのデバイスの一意の ID タイプ            | IDFA/IDFV/GAID                       |
| `User ID`             | 開発者によって設定されているユーザー ID           | 135920                               |
| `Segment`             | セグメント化に基づいて定義された、ユーザーに関連するセグメント |                                      |
