Impression-level revenue server-side API
Track ad revenue at the impression and device level by accessing daily CSV reports through the ILR Server Side API.
読み終わるまでの所要時間 1 分最終更新 1日前
The impression level revenue (ILR) solution provides both device level and impression level data for your ads in the LevelPlay mediation. There are 2 separate APIs:
- One to pull device level data
- One to pull impression level data.
How it works
- Pulling the impression level and the user level data is performed by completing the following steps:
- Make an API request which returns a URL link to download the report
- Download the report by clicking on the provided link
- Each API call must be made for a single app and single date.
- The data for each date is stored and available for only 14 days.
- Example: Data for January 1st will be available only until January 14th
- Each day, the data for yesterday is available starting 10:00 AM UTC. Make sure to only call the API after 10:00 AM UTC each day.
- Example: The data for January 1st is only available on January 2nd, after 10:00 AM UTC
- Each day, we update the data for yesterday and the day before yesterday. The data will not change after 2 days.
- Example: The data for January 1st will update on January 2nd and January 3rd. After January 3rd, the data will not change
- Date & App Key aren't included in both impression and user level reports as they are unique per report (file)
Impression level
API request for report URL
注
A valid API hit returns a link to the requested file. The file will be available to download for one hour.
Authentication type
Bearer API authenticationMethod
GET platform.ironsrc.com/partners/adRevenueMeasurements/v4Required parameters
Name | Type | Description |
|---|---|---|
| String | YYYY-MM-DD (UTC Timezone) |
| String | Application Key (as seen on our platform) |
Request Example URL
https://platform.ironsrc.com/partners/adRevenueMeasurements/v4?appKey=8a95a38d\&date=2020-03-31Response example URL
{"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"}
Download the report
Select the URL to download the report.Fields definition v3
Field | Description | Example |
|---|---|---|
| The exact date and hour of the impression in UTC | 2020-03-30 09:33:58 |
| Device advertising id - GAID or IDFA | fdbe7b9b-d183-4c7c-9bb5-59c9df8c35aa |
| Device advertising vendor id - app Set ID or IDFV | A0810F0B-16C2-474B-B765-77B3A3113AA2 |
| The user ID being set by the developer | 135920 |
| The ad format from which the revenue was generate from | rewarded video |
| The ad network name | Admob |
| The creative ID of the ad campaign. The default is an empty string (not included for Google, Meta, Digital Turbine, and Mintegral networks) | 65af8c5f9dd504dba89ea38e |
| The ad network instance name as defined on the platform. For bidding sources instance name will 'Bidding' | High |
| 2 letter country code, as per ISO 3166-1 Alpha-2 | CN |
| The placement the user is related to as defined on the platform | Home Screen |
| The segment the user is related to as defined based on the segmentation method. Read more | Tier 1 |
| A/B testing group the user was allocated to (can be 'A','B','N/A') | A, B, N/A |
| The Revenue generated by the user (USD). The revenue value is either estimated (CPM /Rate) or exact (for bidder instances, excluding FAN) | 0.5 |
| ID of the ad unit which the revenue was generated from | fgx25t56dq201bd2 |
| Name of the ad unit which the revenue was generated from |
User level
API request for report URL
A valid API hit returns a link to the requested file. The file will be available to download for one hour.Authentication Type
Bearer API authenticationMethod
GET:platform.ironsrc.com/partners/userAdRevenue/v3
Required Parameters
Name | Type | Description |
|---|---|---|
| String | YYYY-MM-DD (UTC timezone) |
| String | Application Key (as seen on our platform) |
| Integer | Supporting different report types. Currently, should always set to 1. |
Request example URL
https://platform.ironsrc.com/partners/userAdRevenue/v3?appKey=12345678&date=2018-12-15&reportType=1
Response example URL
https://user-ad-revenue.s3.amazonaws.com/data/bi databases/uar/tables/network/report version%3Dv1/publisher id%3D138101/application id%3D100411/day%3D2018-07-13/000000.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1532524582&Signature=1U%2FbrLmb%2F7TwXXdoHtb%2F%2FQjrmz0%3D
Download the report
Select the URL to download the report. The following section outlines the definition of various report fields.Fields definition
Field | Description | Example |
|---|---|---|
| The ad unit from which the revenue was generate from | rewarded video |
| The unique ID of the user's device | 21d0e51a-772d-4b23-9fc4-296126b4f123 |
| The unique ID type of the user's device | IDFA/IDFV/GAID |
| The user ID being set by the developer | 135920 |
| The segment the user is related to as defined based on the segmentation |