IGAWorks Help Center

adbrix Open API

使用 Open API，可以查询 adbrix 报告及 Tracking Link 信息。

提供的功能

查询应用信息
adbrix 报告
查询 Tracking Link 的元数据
查询 Tracking Link 渠道的元数据
查询 Tracking Link 的转换报告

发放 Token

为了使用 Open API，必须发放令牌。令牌可以在 Open API 菜单中发放。

发放了令牌，但调用 Open API 的服务器或客户端的 IP 未登录时，不能返回任何信息。

查询应用信息

可以查询申请的令牌的相关应用信息。

API

GET: 
~/v3/AppInfo?access_token={发放的令牌 Key}

Example Request

GET: 
https://report.ad-brix.com/v3/AppInfo?access_token=d00f4e0d76497033f5d82d53987c1060

Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T14:47:18.7485346+09:00",
  "data": {
    "name": "    Adbrix Postback Test App   ",
    "appScheme": "igaworks.integration.testapp",
    "appKey": 493312809,
    "hashKey": "8ae42e5b25d74580",
    "os": "Android",
    "thumbnailImage": "https://lh3.googleusercontent.com/bsZT3FosCpVKc9LIs-cA1RxZFmDFIyoH4ZKGE4LaVKFhzW4VWPr8kQM2UQo7952lTWQ=w170",
    "marketURL": "market://details?id=igaworks.integration.testapp",
    "screenShotURL": [
      "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/7a4441a4-8994-488e-b7bf-81fd4ef47c5d.png",
      "//i.ytimg.com/vi/lHehS1L7JtI/hqdefault.jpg",
      "https://lh3.googleusercontent.com/RPyEeMwyyz8xHD_yJYBqTqaRk576uvD05CFQZnvBqLIa4GUVwAUHlpcm6YNAG6fA8xKh=h310",
      "https://lh3.googleusercontent.com/D9zA-t17anzA1yHngbWFcCynWcuHAmysohJsfe72JjveZQaMyh6dA6mGdRlaTo5wtiY=h310"
    ],
    "currenySymbol": null
  }
}

Response Details

version : api 版本
generatedDate : api 应答时刻
data : 详细信息
name : 应用名称
appScheme : Android Package name 或 iOS app scheme
appKey : App Key
hashKey : Hash Key
os : OS Platform (Android or iOS)
thumbnailImage : 缩略图
marketUrl : Market URL
screenShotUrl : 应用截图
hashKey : Hash Key
currencySymbol : 虚拟货币名称 (使用必须登录虚拟货币的服务时返回)

查询 adbrix 报告

可以查询申请令牌的相关 adbrix 报告信息。

API

GET : 
~/v3/Metrics?access_token={发放的_令牌 Key}&startDate={开始查询的日期}&endDate={结束查询得出日期}

Example Request

GET :
https://report.ad-brix.com/v3/Metrics?access_token=d00f4e0d76497033f5d82d53987c1060&startDate=2015-09-09&endDate=2015-09-10

Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T14:56:38.7265662+09:00",
  "fromDate": "2015-09-09T00:00:00",
  "toDate": "2015-09-10T00:00:00",
  "datas": [
    {
      "reportAt": "20150910",
      "dailyActiveUser": 0,
      "weeklyActiveUser": 0,
      "monthlyActiveUser": 0,
      "retentionUser": 0,
      "newUser": 0,
      "underOneMinuteUser": 0,
      "runCount": 0,
      "oneDay": 0,
      "twoDay": 0,
      "threeDay": 0,
      "fourDay": 0,
      "fiveDay": 0,
      "sixDay": 0,
      "sevenDay": 0,
      "fourteenDay": 0,
      "fifteenDay": 0,
      "thirtyDay": 0,
      "oneWeek": 0,
      "twoWeek": 0,
      "threeWeek": 0,
      "fourWeek": 0
    },
    {
      "reportAt": "20150909",
      "dailyActiveUser": 0,
      "weeklyActiveUser": 0,
      "monthlyActiveUser": 0,
      "retentionUser": 0,
      "newUser": 0,
      "underOneMinuteUser": 0,
      "runCount": 0,
      "oneDay": 0,
      "twoDay": 0,
      "threeDay": 0,
      "fourDay": 0,
      "fiveDay": 0,
      "sixDay": 0,
      "sevenDay": 0,
      "fourteenDay": 0,
      "fifteenDay": 0,
      "thirtyDay": 0,
      "oneWeek": 0,
      "twoWeek": 0,
      "threeWeek": 0,
      "fourWeek": 0
    }
  ]
}

Response Details

generatedDate : 申请数据查询时间
fromDate : 开始查询的日期
toDate : 结束查询的日期
version : 查询 api 版本
datas : 详细数据
reportAt : 现有数据日期
dailyActiveUser : 日活跃用户
weeklyActiveUser : 周活跃用户
monthlyActiveUser : 月活跃用户
retUser : 再次访问的用户
newUser : 新增用户
underOneMinuteUser : 在线未超过 1分钟用户
runCount : 启动次数
oneDayRetentionUser : 1天启动的用户
twoDayRetentionUser : 连续 2天启动的用户
threeDayRetentionUser : 连续 3天启动的用户
fourDayRetentionUser : 连续 4天启动的用户
fiveDayRetentionUser : 连续 5天启动的用户
sixDayRetentionUser : 连续 6天启动的用户
sevenDayRetentionUser : 连续 7天启动的用户
oneWeekRetentionUser : 连续 1周启动的用户
twoWeekRetentionUser : 连续 2周启动的用户
threeWeekRetentionUser : 连续 3周启动的用户
fourWeekRetentionUser : 连续 4周启动的用户

查询 Tracking Link 元数据信息

可以查询申请的令牌的相关 Tracking Link 元数据信息。

API

GET :
~/v3/TrackingLink/AllList?access_token={发放的令牌 Key}

Example Request

GET :
https://report.ad-brix.com/v3/TrackingLink/AllList?access_token=d00f4e0d76497033f5d82d53987c1060

Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T15:16:17.3386977+09:00",
  "datas": [    
    {
      "appkey": 493312809,
      "conversionKey": 1095259,
      "conversionName": "Tracking Link simple 3",
      "thumbnailImage": "",
      "channelName": "Syrup ad",
      "channelNo": 0,
      "landingUrl": "market://details?id=igaworks.integration.testapp",
      "registeredDate": "2015-09-16T15:57:26.79",
      "updatedDate": "2015-09-16T15:57:26.787",
      "isSubConversion": true,
      "conversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259",
      "subConversions": [
        {
          "appkey": 493312809,
          "conversionKey": 1095259,
          "subConversionKey": 9916840,
          "subConversionName": "Sub Tracking Link B",
          "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/4922d2e1-1e45-403d-8028-57d511651af8.png",
          "registeredDate": "2015-09-16T16:03:55.52",
          "updatedDate": "2015-09-16T16:03:55.52",
          "subConversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=9916840"
        },
        {
          "appkey": 493312809,
          "conversionKey": 1095259,
          "subConversionKey": 8414567,
          "subConversionName": "Sub Tracking Link A",
          "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/1b47ba45-f038-4a80-b96d-03b6ecf66676.png",
          "registeredDate": "2015-09-16T16:03:36.293",
          "updatedDate": "2015-09-16T16:03:36.293",
          "subConversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=8414567"
        }
      ]
    },
    {
      "appkey": 493312809,
      "conversionKey": 9690971,
      "conversionName": "Tracking Link simple 2",
      "thumbnailImage": "",
      "channelName": "UnityAds",
      "channelNo": 0,
      "landingUrl": "market://details?id=igaworks.integration.testapp",
      "registeredDate": "2015-09-16T15:56:58.51",
      "updatedDate": "2015-09-16T15:57:48.36",
      "isSubConversion": false,
      "conversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=9690971",
      "subConversions": null
    },
    {
      "appkey": 493312809,
      "conversionKey": 1097410,
      "conversionName": "Tracking Link simple 1",
      "thumbnailImage": "",
      "channelName": "AppLift",
      "channelNo": 0,
      "landingUrl": "market://details?id=igaworks.integration.testapp",
      "registeredDate": "2015-09-16T15:56:25.927",
      "updatedDate": "2015-09-16T15:56:25.917",
      "isSubConversion": false,
      "conversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1097410",
      "subConversions": null
    }
  ]
}

Response Details

version : 查询 API 版本
generatedDate : 申请查询的时刻
datas : 详细信息
appKey : App Key
conversionKey : 转换价 (=Tracking Link 识别值)
conversionName : 转换名称 (=Tracking Link 名称)
thumbnailImage : Tracking Link 管理用图像 URL
channelName : Tracking Link 渠道名
channelNo : Tracking Link 渠道号码
LandingUrl : Market URL (=Tracking Link Landing URL)
registedDate : Tracking Link 生成时刻
updatedDate : Tracking Link 修正时刻
isSubConversion : sub 转换存在与否
conversionUrl : Tracking Link URL
subConversions : sub 转换信息 (=sub Tracking Link 信息)
appKey : App Key
conversionKey : 转换价 (=Tracking Link 识别值)
subConversionKey : sub 转换价 (=sub Tracking Link 识别值)
subConversionName : sub 转换名称 (=sub Tracking Link 名称)
thumbnailImg : sub Tracking Link 管理用图像
registedDate : sub Tracking Link 生成时刻
updatedDate : sub Tracking Link 修正时刻
subConversionUrl : sub 转换 URL (=sub Tracking Link URL)

查询 Tracking Link 元数据信息

可以查询 adbrix 内登录的 Tracking Link 渠道元数据信息。

API

GET :
~/v3/TrackingLink/GetChannel?access_token={发放的令牌 Key}

Example Request

GET :
https://report.ad-brix.com/v3/TrackingLink/GetChannel?access_token=6ed8a26ce0447cecdf12cc32bd24c3e9

Example Response

{
    version: "3.0",
    generatedDate: "2015-10-20T10:44:20.8591614+09:00",
    datas: [
        {
            channelNo: 1,
            channelName: "Ad@m",
            isPostback: false
        },
        {
            channelNo: 2,
            channelName: "InMobi",
            isPostback: true
        },
        {中略}
    ]
}

Response Details

version : 查询 api 版本
generatedDate : api 应答时刻
datas : 详细信息
channelNo : 渠道号码
channelName : 渠道名称
isPostback : Postback 设置与否

查询 Tracking Link 转换报告

可以查询 Tracking Link 的转换 (新增启动) 信息。

查询 :整体期间

查询 Tracking Link 的所有转换信息。

API

GET :
~/v3/TrackingLink/GetConversionDetail?access_token={发放的令牌值}&ck={转换价}

Optional Parameter

start_date : 开始查询日期 (yyyy-MM-dd )
end_date : 结束查询日期 (yyyy-MM-dd )

Example Request

GET :
https://report.ad-brix.com/v3/TrackingLink/GetConversionDetail?access_token=d00f4e0d76497033f5d82d53987c1060&ck=1095259

Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T16:59:29.1863185+09:00",
  "data": {
    "conversionName": "Tracking Link simple 3",
    "conversionKey": 1095259,
    "channelName": "Syrup ad",
    "channelNo": 6,
    "landingUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259",
    "appKey": 493312809,
    "thumbnailImage": "https://partners.igaworks.com/Content/theme/images/adbrix_app_default.png",
    "registeredUserId": "dev@igaworks.com",
    "registeredUserName": "开发组",
    "registeredDate": "2015-09-16T15:57:26.79",
    "thirdPartyConversionId": "",
    "thirdPartyConversionLabel": null,
    "clickCount": 25,
    "conversionCount": 0,
    "thirdPartyConversionCount": 0,
    "cvr": 0,
    "subConversionInfos": [
      {
        "appkey": 493312809,
        "conversionKey": 1095259,
        "subConversionKey": 0,
        "subConversionName": "basic",
        "thumbnailImage": "https://partners.igaworks.com/Content/theme/images/adbrix_app_default.png",
        "registeredDate": "2015-09-16T15:57:26.79",
        "updatedDate": "0001-01-01T00:00:00",
        "clickCount": 23,
        "conversionCount": 0,
        "cvr": 0,
        "thirdPartyConversionCount": 0,
        "subConversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259"
      },
      {
        "appkey": 493312809,
        "conversionKey": 1095259,
        "subConversionKey": 8414567,
        "subConversionName": "sub Tracking Link A",
        "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/1b47ba45-f038-4a80-b96d-03b6ecf66676.png",
        "registeredDate": "2015-09-16T16:03:36.293",
        "updatedDate": "0001-01-01T00:00:00",
        "clickCount": 2,
        "conversionCount": 0,
        "cvr": 0,
        "thirdPartyConversionCount": 0,
        "subConversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=8414567"
      },
      {
        "appkey": 493312809,
        "conversionKey": 1095259,
        "subConversionKey": 9916840,
        "subConversionName": "sub Tracking Link B",
        "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/4922d2e1-1e45-403d-8028-57d511651af8.png",
        "registeredDate": "2015-09-16T16:03:55.52",
        "updatedDate": "0001-01-01T00:00:00",
        "clickCount": 0,
        "conversionCount": 0,
        "cvr": 0,
        "thirdPartyConversionCount": 0,
        "subConversionUrl": "http://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=9916840"
      }
    ]
  }
}

Response Details

version : 查询 api 版本
generatedDate : api 应答时刻
datas : 详细信息
conversionName : 转换名称 (=Tracking Link 名称)
conversionKey : 转换价 (=Tracking Link 识别值)
channelName : Tracking Link 渠道名称
landingUrl : Landing URL
appKey : App Key
thumbnailImage : Tracking Link 缩略图 (选项:管理用)
registeredUserId : Tracking Link 生成的用户账户
registeredUserName : Tracking Link 生成的用户名
registeredDate : Tracking Link 生成时刻
thirdPartyConversionId : Google AdWords 集成账户
thirdPartyConversionLabel : Google AdWords 集成标签
clickCount : Session 总数 (=Tracking Link 点击数)
conversionCount : 转换总数 (=新增流入用户数)
thirdPartyConversionCount : 启动总数 (AdWords 使用时总计)
cvr : Tracking Link 转换率 (=转换总数/Session 总数*100)
subConversionInfos : 子转换信息 (=sub Tracking Link 信息)
appkey : App Key
conversionKey : 父母转换值 (=父母 Tracking Link 识别值)
subConversionKey : sub 转换值 (=sub Tracking Link 识别值)
subConversionName : sub 转换名称 (=sub Tracking Link 名称)
thumbnailImage : sub Tracking Link 缩略图 (选项:管理用)
registedDate : sub Tracking Link 生成时刻
updatedDate : sub Tracking Link 修正时刻
clickCount : sub Tracking Link 转换总数 (=sub Tracking Link 点击数)
conversionCount : sub Tracking Link 转换总数 (=sub Tracking Link 新增流入用户数)
cvr : sub Tracking Link 转换率 (=sub Tracking Link 转换总数/sub Tracking Link Session 总数*100)
thirdPartyConversionCount : sub Tracking Link 启动总数 (使用 AdWords 时统计)
subConversionUrl : sub 转换 URL (=sub Tracking Link URL)

查询 : 特定期间

查询特定 Tracking Link 的日期、时间的 Conversion 信息。

API

~/v3/TrackingLink/GetConversionPeriodicInfo?access_token={发放的令牌 Key}&ck={Tracking Link 识别值}&start_date={开始查询的日期}&end_date={结束查询的日期}&time_span={时间区分类型}

*time_span prameter : day-按日期报告, hour-按时间报告

Example Request

https://report.ad-brix.com/v3/TrackingLink/GetConversionPeriodicInfo?access_token=d00f4e0d76497033f5d82d53987c1060&ck=1095259&start_date=2015-09-14&end_date=2015-09-16&time_span=day

Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T15:32:21.840643+09:00",
  "data": {
    "conversionKey": 1095259,
    "conversionName": "Tracking Link simple 3",
    "channelNo": 6,
    "channelName": "Syrup ad",
    "conversionDatas": [
      {
        "reportAt": "20150914",
        "reportedHour": 0,
        "reportedDate": "0001-01-01T00:00:00",
        "clickCount": 0,
        "conversionCount": 0,
        "thirdPartyConversionCount": 0,
        "cvr": 0
      },
      {
        "reportAt": "20150915",
        "reportedHour": 0,
        "reportedDate": "0001-01-01T00:00:00",
        "clickCount": 0,
        "conversionCount": 0,
        "thirdPartyConversionCount": 0,
        "cvr": 0
      },
      {
        "reportAt": "20150916",
        "reportedHour": 0,
        "reportedDate": "0001-01-01T00:00:00",
        "clickCount": 0,
        "conversionCount": 0,
        "thirdPartyConversionCount": 0,
        "cvr": 0
      }
    ]
  }
}

Response Details

version : 查询 api 版本
generatedDate : api 应答时刻
data : 详细信息
conversionKey : 转换价 (=Tracking Link 识别值)
conversionName : 转换名称 (=Tracking Link 名称)
channelNo : Tracking Link 渠道号码
channelName : Tracking Link 渠道名称
conversionDatas : 转换数据
reportAt :  报告日期
reportedHour : 报告时刻
reportedDate : 报告日期
clickCount : sub Tracking Link Session 总数 (=sub Tracking Link 点击数)
conversionCount : sub Tracking Link 启动总数 (=sub Tracking Link 流入的新增用户数)
thirdPartyConversionCount : sub Tracking Link 启动总数 (使用 AdWords 时统计)
cvr : sub Tracking Link 转换率 (=sub Tracking Link 转换总数/sub Tracking Link Session 总数*100)

adbrix Open API

发放 Token

查询应用信息

查询 adbrix 报告

查询 Tracking Link 元数据信息

查询 Tracking Link 元数据信息

查询 :整体期间

查询 : 特定期间

Documentation Search

Related Articles

Another Sections

INDEX

Related Articles

[AOS] adbrix Facebook 广告设置 : Native Android、Unity Android

[AOS] adbrix 集成 : Native Android

[AOS] adbrix 集成 : Unity Android

[iOS] adbrix Facebook 广告设置 : Native iOS、Unity iOS