JPNクエリーパラメータ
この API は非推奨となりました。 この API へのアクセスは 2023年6月下旬に停止され、それ以降は新しい GraphQL APIを使用する必要があります。
1. クエリーパラメータ
| パラメータ | 必須? | 値 | 説明 |
|---|---|---|---|
| date | YES | YYYY-MM-DD | データを取得する日付 |
| page_size | NO | 0 < Integer値 <= アカウントのアプリ登録数 | JSON表現のデータの1ページあたりにアプリいくつ分の情報を含めるかを指定します。デフォルト値は1です。 |
| page | NO | 0 < Integer値 <= 最大ページ | 取得するページを指定します。デフォルト値は1です。 |
| time_increment | NO | hourlyまたはdaily | データの時間粒度を指定します。デフォルトは日毎(daily)です。 |
| group_by | NO | placements、content_typesまたはcontent_cards | デフォルトでコンテンツ別(content_types)です。placementsまたはcontent_cardsを指定した場合、収入をプレイスメント別およびコンテントカード別のデータを返します。 |
| mock | NO | 0または1 | 1を指定するとテストデータが返るため、データの解析が正常に動くかの確認ができます。デフォルト値の0を指定すると、アカウントに紐付く実際のデータが返ります。 |
2. JSONの例
A. アプリ別にグルーピングしたレスポンスの例
{
"Date": "2016-10-01",
"TotalApps": 2,
"PageSize": 1,
"TotalPages": 2,
"CurrentPage": 1,
"Apps": [
{
"Name": "MyTapjoy",
"Platform": "android",
"AppKey": "bba49f11-b87f-4c0f-9632-21aa810dd6f1",
"ContentTypes": [
{
"ContentType": "DirectPlay",
"Global": {
"Clicks": 0,
"Conversions": 0,
"Impressions": 0,
"Revenue": 0,
"ECPM": 0
},
"Countries": []
},
{
"ContentType": "FullScreenInterstitial",
"Global": {
"Clicks": 0,
"Conversions": 0,
"Impressions": 0,
"Revenue": 0,
"ECPM": 0
},
"Countries": []
},
{
"ContentType": "Offerwall",
"Global": {
"Revenue": 6010.0208,
"Impressions": 176610,
"Clicks": 91910,
"Conversions": 24910,
"DAU": 100203,
"DUV": 100203,
"DUC": 17028,
"ECPM": 34.0299
},
"Countries": [
{
"Country": "ae",
"Revenue": 0,
"Impressions": 7,
"Clicks": 3,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ar",
"Revenue": 0,
"Impressions": 6,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "at",
"Revenue": 0.056,
"Impressions": 32,
"Clicks": 21,
"Conversions": 1,
"DAU": 20,
"DUV": 20,
"DUC": 1,
"ECPM": 1.75
},
{
"Country": "au",
"Revenue": 0.3304,
"Impressions": 7,
"Clicks": 6,
"Conversions": 2,
"DAU": 3,
"DUV": 3,
"DUC": 2,
"ECPM": 47.2
},
{
"Country": "ba",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "bd",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "be",
"Revenue": 0.42364,
"Impressions": 19,
"Clicks": 6,
"Conversions": 3,
"DAU": 11,
"DUV": 11,
"DUC": 3,
"ECPM": 22.29684
},
{
"Country": "bg",
"Revenue": 0.0476,
"Impressions": 4,
"Clicks": 4,
"Conversions": 1,
"DAU": 2,
"DUV": 2,
"DUC": 1,
"ECPM": 11.9
},
{
"Country": "bh",
"Revenue": 0.056,
"Impressions": 2,
"Clicks": 1,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 28
},
{
"Country": "br",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ca",
"Revenue": 0.84952,
"Impressions": 9,
"Clicks": 6,
"Conversions": 3,
"DAU": 4,
"DUV": 4,
"DUC": 2,
"ECPM": 94.39111
},
{
"Country": "ch",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "cl",
"Revenue": 0,
"Impressions": 4,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "co",
"Revenue": 0.224,
"Impressions": 19,
"Clicks": 7,
"Conversions": 1,
"DAU": 8,
"DUV": 8,
"DUC": 1,
"ECPM": 11.78947
},
{
"Country": "cz",
"Revenue": 0,
"Impressions": 2,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "de",
"Revenue": 2.4528,
"Impressions": 6,
"Clicks": 3,
"Conversions": 1,
"DAU": 3,
"DUV": 3,
"DUC": 1,
"ECPM": 408.8
},
{
"Country": "dk",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "dm",
"Revenue": 0,
"Impressions": 5,
"Clicks": 2,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "dz",
"Revenue": 0,
"Impressions": 20,
"Clicks": 0,
"Conversions": 0,
"DAU": 17,
"DUV": 17,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ec",
"Revenue": 0,
"Impressions": 4,
"Clicks": 1,
"Conversions": 0,
"DAU": 2,
"DUV": 2,
"DUC": 0,
"ECPM": 0
},
{
"Country": "eg",
"Revenue": 0,
"Impressions": 11,
"Clicks": 8,
"Conversions": 0,
"DAU": 8,
"DUV": 8,
"DUC": 0,
"ECPM": 0
},
{
"Country": "es",
"Revenue": 6.0648,
"Impressions": 321,
"Clicks": 166,
"Conversions": 57,
"DAU": 302,
"DUV": 302,
"DUC": 50,
"ECPM": 18.89346
},
{
"Country": "fi",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "fr",
"Revenue": 10.44092,
"Impressions": 219,
"Clicks": 143,
"Conversions": 50,
"DAU": 202,
"DUV": 202,
"DUC": 47,
"ECPM": 47.67543
},
{
"Country": "gb",
"Revenue": 18.75832,
"Impressions": 351,
"Clicks": 216,
"Conversions": 69,
"DAU": 312,
"DUV": 312,
"DUC": 64,
"ECPM": 53.44251
},
{
"Country": "gh",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "gr",
"Revenue": 0.3094,
"Impressions": 2,
"Clicks": 1,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 154.7
},
{
"Country": "hk",
"Revenue": 0.0532,
"Impressions": 3,
"Clicks": 2,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 17.73333
},
{
"Country": "hr",
"Revenue": 0,
"Impressions": 6,
"Clicks": 0,
"Conversions": 0,
"DAU": 5,
"DUV": 5,
"DUC": 0,
"ECPM": 0
},
{
"Country": "id",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ie",
"Revenue": 0.056,
"Impressions": 33,
"Clicks": 20,
"Conversions": 1,
"DAU": 15,
"DUV": 15,
"DUC": 1,
"ECPM": 1.69697
},
{
"Country": "il",
"Revenue": 0,
"Impressions": 1,
"Clicks": 2,
"Conversions": 0,
"DAU": 2,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "in",
"Revenue": 0.084,
"Impressions": 20,
"Clicks": 8,
"Conversions": 1,
"DAU": 19,
"DUV": 19,
"DUC": 1,
"ECPM": 4.2
},
{
"Country": "iq",
"Revenue": 0,
"Impressions": 15,
"Clicks": 7,
"Conversions": 0,
"DAU": 12,
"DUV": 12,
"DUC": 0,
"ECPM": 0
},
{
"Country": "is",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "it",
"Revenue": 0.6608,
"Impressions": 25,
"Clicks": 13,
"Conversions": 5,
"DAU": 18,
"DUV": 18,
"DUC": 5,
"ECPM": 26.432
},
{
"Country": "je",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "jo",
"Revenue": 0,
"Impressions": 4,
"Clicks": 2,
"Conversions": 0,
"DAU": 2,
"DUV": 2,
"DUC": 0,
"ECPM": 0
},
{
"Country": "jp",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ke",
"Revenue": 0,
"Impressions": 8,
"Clicks": 2,
"Conversions": 0,
"DAU": 4,
"DUV": 4,
"DUC": 0,
"ECPM": 0
},
{
"Country": "kw",
"Revenue": 0,
"Impressions": 1,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "lb",
"Revenue": 0,
"Impressions": 3,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "lt",
"Revenue": 0,
"Impressions": 2,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ma",
"Revenue": 0,
"Impressions": 4,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "mk",
"Revenue": 0.3094,
"Impressions": 2,
"Clicks": 2,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 154.7
},
{
"Country": "mt",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "mx",
"Revenue": 0.14,
"Impressions": 18,
"Clicks": 3,
"Conversions": 1,
"DAU": 5,
"DUV": 5,
"DUC": 1,
"ECPM": 7.77778
},
{
"Country": "ng",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "nl",
"Revenue": 2.5634,
"Impressions": 191,
"Clicks": 107,
"Conversions": 16,
"DAU": 123,
"DUV": 123,
"DUC": 8,
"ECPM": 13.42094
},
{
"Country": "no",
"Revenue": 0,
"Impressions": 4,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "nz",
"Revenue": 0,
"Impressions": 5,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "pe",
"Revenue": 0,
"Impressions": 1,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "pk",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "pm",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "pr",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "ps",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "pt",
"Revenue": 0,
"Impressions": 8,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "qa",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "re",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "rs",
"Revenue": 0,
"Impressions": 4,
"Clicks": 3,
"Conversions": 0,
"DAU": 2,
"DUV": 2,
"DUC": 0,
"ECPM": 0
},
{
"Country": "sa",
"Revenue": 9.48556,
"Impressions": 257,
"Clicks": 101,
"Conversions": 15,
"DAU": 56,
"DUV": 56,
"DUC": 9,
"ECPM": 36.90879
},
{
"Country": "sc",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "se",
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"DAU": 0,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "sg",
"Revenue": 0.4732,
"Impressions": 13,
"Clicks": 5,
"Conversions": 2,
"DAU": 2,
"DUV": 2,
"DUC": 1,
"ECPM": 36.4
},
{
"Country": "si",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "sk",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "sy",
"Revenue": 0,
"Impressions": 0,
"Clicks": 1,
"Conversions": 0,
"DAU": 1,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "th",
"Revenue": 0.448,
"Impressions": 3,
"Clicks": 1,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 149.33333
},
{
"Country": "tr",
"Revenue": 0,
"Impressions": 2,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "tt",
"Revenue": 0,
"Impressions": 3,
"Clicks": 2,
"Conversions": 0,
"DAU": 1,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
{
"Country": "us",
"Revenue": 5944.4562,
"Impressions": 174787,
"Clicks": 90955,
"Conversions": 24647,
"DAU": 6003,
"DUV": 6003,
"DUC": 2004,
"ECPM": 34.0097
},
{
"Country": "uy",
"Revenue": 0,
"Impressions": 1,
"Clicks": 0,
"Conversions": 0,
"DAU": 1,
"DUV": 0,
"DUC": 0,
"ECPM": 0
},
{
"Country": "za",
"Revenue": 0.28,
"Impressions": 2,
"Clicks": 1,
"Conversions": 1,
"DAU": 1,
"DUV": 1,
"DUC": 1,
"ECPM": 140
}
]
},
{
"ContentType": "Tapjoy.com",
"Global": {
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"ECPM": 0
},
"Countries": []
},
{
"ContentType": "Banner",
"Global": {
"Revenue": 0,
"Impressions": 0,
"Clicks": 0,
"Conversions": 0,
"ECPM": 0
},
"Countries": []
}
]
}
]
}
B. コンテントカード別にグルーピングしたレスポンスの例
{
"Date": "2021-05-21",
"TotalApps": 1,
"PageSize": 1,
"TotalPages": 1,
"CurrentPage": 1,
"Apps": [
{
"Name": "MyTapjoy",
"Platform": "iphone",
"AppKey": "13b0ae6a-8516-4405-9dcf-fe4e526486b2",
"ContentCards": []
}
]
}
C. プレイスメント別にグルーピングしたレスポンスの例
{
"Date": "2021-05-21",
"TotalApps": 1,
"PageSize": 1,
"TotalPages": 1,
"CurrentPage": 1,
"Apps": [
{
"Name": "MyTapjoy",
"Platform": "iphone",
"AppKey": "13b0ae6a-8516-4405-9dcf-fe4e526486b2",
"Placements": [
{
"Name": "offerwall_unit",
"Global": {
"Revenue": 0,
"Impressions": 5,
"Clicks": 1,
"Conversions": 0,
"DUV": 1,
"DUC": 0,
"ECPM": 0
},
"Countries": [
{
"Country": "us",
"Revenue": 0,
"Impressions": 5,
"Clicks": 1,
"Conversions": 0,
"DUV": 1,
"DUC": 0,
"ECPM": 0
}
]
}
]
}
]
}
3. 項目
| 全体オブジェクト | 説明 | 値 |
|---|---|---|
| Date | 次の形式のデータの日付: YYYY-MM-DD | 次の形式の日付の文字列: YYYY-MM-DD |
| TotalApps | 全アプリ数 | Integer |
| PageSize | 1ページあたりのアプリ数。すべてのアプリを一度のレスポンスで取得する場合はこの値をアプリの総数に指定します。パラメータで指定された値を使用するため、この値はアプリリストに登録されたアプリ数よりも大きい場合があります。 | Integer |
| TotalPages | リポートの総ページ数 | Integer |
| CurrentPage | データのページ番 | Integer |
| Name | アプリ名 | String |
| AppKey | このアプリのユニークなID (SDK keyとは異なります。) | 正規化されていない appID |
| Platform | このアプリのプラットフォーム | android, ios |
| Status | エラーがあるかどうかのメッセージを返します。 | String |
| Country | 収入・スペンドが発生した国. (2文字の国コード) | us, ca, gb, … 小文字 |
| コンテンツ種別オブジェクト | 説明 | 値 |
|---|---|---|
| Type | コンテンツの種別。種別は次のいずれか; “DirectPlay” (リワード動画), “Offerwall”, “FullScreenInterstitial”, "Tapjoy.com" (廃止済), "Banner" (廃止済)。 JSONの例(2A) にこれらの要素がすべて含まれています。 | String |
| Impressions | M2E, N2E, P2Eの場合は、プライマリ オファーのインプレッション数です。 | Integer |
| Clicks | プライマリ コンテンツのクリック数 | Integer |
| Conversions | プライマリ コンテンツのコンバーション数 | Integer |
| Revenue | プライマリ コンテンツの総レベニュー(USドル) | Float |
| eCPM | このコンテンツユニットの該当日のeCPM。この値は時間別データはありません。 | Integer |
| DUV | アプリでオファーウォールを見たユニークユーザー数 | Integer |
| DUC | アプリでオファーウォールでコンバージョンしたユニークユーザー数 | Integer |
| プレイスメントオブジェクト | 説明 | 値 |
|---|---|---|
| Name | ダッシュボードに登録されているプレイスメント名 | String |
| Impressions | このプレイスメントに登録されている広告ユニットの総インプレッション数 | Integer |
| Clicks | このプレイスメントのクリック数 | Integer |
| Conversions | このプレイスメントの総コンバーション数 | Integer |
| Revenue | このプレイスメントの総レベニュー(USドル) | Float |
| eCPM | このプレイスメントの該当日のeCPM。この値は時間別データはありません。 | Float |
| DUV | このプレイスメントまたはコンテンツカードの広告を見たユニークユーザー数 | Integer |
| DUC | このプレイスメントまたはコンテンツカードの広告でコンバージョンしたユニークユーザー数 | Integer |
4. エラー
| エラーコード | 意味 | 対処法 |
|---|---|---|
| 400 | リクエストエラー | パラメータが正しいか確認して下さい。 |
| 401 | 認証トークンなし、または不正値 | 認証トークンが正しい値で有効期限内かを確認して下さい。 |
| 500 | 内部サーバーエラー | 再度試行するか、問題が続く場合は support@tapjoy.com までお問い合わせ下さい。 |
| 429 | アクセス過多 | API呼びだし頻度を下げて下さい。 |