CHN请求参数
This API is now deprecated. Access to this API will be removed in late June 2023 after which the Tapjoy GraphQL API must be used for reporting purposes.
1. 请求参数
| 参数 | 是否必须? | 值 | 说明 |
|---|---|---|---|
| date | YES | YYYY-MM-DD | 请求数据的日期 |
| page_size | NO | 0 < Integer value <= 账户下应用的数目 | 在JSON一页返回中app的数目。值越大返回所需时间越长。默认值是1。 |
| page | NO | 0 < Integer value <= 最大页数 | 您想要返回数据的页码。默认返回第一页的数据。 |
| time_increment | NO | hourly, daily | 返回数据细分参数。默认是Daily。 |
| group_by | NO | placements, content_types, content_cards | 默认数据是按广告类型分组。如果使用placements or content_cards, 数据将会按照placement or content card返回。 |
| mock | NO | 0, 1 | 传1，将会返回测试数据来验证脚本是否正确。没有这个参数或者传0，将会返回账户下的真实数据。 |
2. JSON数据示例
A. 按Content Types分组数据示例
{
"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. 按Content Cards分组数据示例
{
"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. 按Placemets分组数据示例
{
"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 | Date String in following format: YYYY-MM-DD |
| TotalApps | App的总数目 | Integer number |
| PageSize | T每页返回的App数目。如果在一次请求中想要得到所有的App，请设置为App的总数目。我们会按照传递的值来返回数据，您可以传递大于App总数目的值。 | Integer number |
| TotalPages | 返回数据的总页数 | Integer number |
| CurrentPage | 当前的页码 | Integer number |
| Name | App名称 | String |
| AppKey | App的唯一app id（非SDK key）。 | appID, not normalized |
| Platform | App的平台 | android, ios |
| Status | 返回状态码。 | String |
| Country | 收入/花费的国家代码 | us, ca, gb, … all lowercase |
| 广告内容项目 | 说明 | 值 |
|---|---|---|
| Type | 广告单元类型。目前可用的广告类型有："DirectPlay" (rewarded video), "Offerwall", "FullScreenInterstitial", "Tapjoy.com" (deprecated), and "Banner" (deprecated)。您可以在上面JSON数据中看到这些类型。 | String |
| Impressions | 对于M2E, N2E, P2E, 表示根offer的展示数 | Integer number |
| Clicks | 根广告类型的点击数。 | Integer number |
| Conversions | 根广告类型的转化数。 | Integer number |
| Revenue | 根广告类型的USD收入数。 | Float number |
| eCPM | 某一天此广告单元的Ecpm。无按小时展示。 | Integer number |
| DUV | 在App中的Offerwall看过广告唯一用户数目 | Integer number |
| DUC | 在App中的Offerwall完成广告唯一用户数 | Integer number |
| 展示位置项目 | 说明 | 值 |
|---|---|---|
| Name | 在控制面板中展示位置名称 | String |
| Impressions | 当前展示位置的展示数。不包括不产生收入的广告类型，比如M2E。 | Integer Number |
| Clicks | 当前展示位置的点击数。 | Integer Number |
| Conversions | 当前展示位置的转化数。 | Integer Number |
| Revenue | 当前展示位置中的USD收入 | Float Number |
| eCPM | 当前展示位置的ecpm。无按小时数据。 | Float Number |
| DUV | 在App中的Offerwall看过广告唯一用户数目 | Integer number |
| DUC | 在App中的Offerwall完成广告唯一用户数 | Integer number |
4. 错误
| 错误代码 | 意义 | 解决方案 |
|---|---|---|
| 400 | Bad Request | 请检查参数是否正确。 |
| 401 | Bad or missing authentication token | 请检查验证token是否正确，并保证没有过期。 |
| 500 | Internal server error | 重试或者如果问题持续出现，请联系support@tapjoy.com |
| 429 | Too many requests | 请求过于频繁。 |