旧リポーティングAPI

この API は非推奨となりました。新しい Marketing API に移行する猶予期間として短期間は使用可能な状態を継続します。

1. 概要

旧エンドポイントではXMLおよび JSON形式で広告に関するクリック、インストール、コンバーション等の計測値をリアルタイムで提供します。

広告主向け APIのデフォルト出力に含まれるもの: 有効になオファー(Tapjoyが許可し、広告主が有効にしたもの)すべてのデータが含まれます。有効でないオファーの情報も必要な場合、all_offers=1 パラメータを使用します(下記のパラメータ一覧を参照)。

アプリ開発者向け APIのデフォルト出力に含まれるもの: Tapjoy広告を利用するすべてのアプリのデータが含まれます。app IDがプライマリ広告のオファーIDとして利用され、キャンペーンがdisableとされてもデータはレポートに含まれいます。

2. 広告レポートAPI Key

このキーはパブリシャーレポートAPIキーとは異なります

広告レポートAPI Key はTapjoy ダッシュボードから:

画面上部のナビゲーションバーの設定 - アプリ設定 を選択
画面下部の プラットフォーム – API Keys – メディエーションキー タブまでスクロール
API Keys をクリック

広告レポートAPI Key に書かれている値が、旧リポーティングAPI用のキーとなります.

古い "V2″ Tapjoy ダッシュボード (dashboard.tapjoy.com) をお使いの場合、 https://dashboard.tapjoy.com/reporting/api の "Legacy Ad Reporting API Key" を使用して下さい。

不明な点に関してはTapjoyのアカウントマネージャもしくはサポートまでお問い合わせ下さい。

3. リクエストおよびレスポンス例

リクエストURLのformatパラメータにより、取得するデータ形式をXMLまたはJSONにできます。Data can be requested to be returned in XML or JSON, based on the format of the request url. リクエストに指定する必須およびオプションパラメータについては、下記のパラメータセクションを参照して下さい。

XML リクエスト、レスポンス例

https://api.tapjoy.com/reporting_data.xml?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=50&page=2&timezone=0

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
  <MarketingData>
    <Date>YYYY-MM-DD</Date>
    <Timezone>NUM</Timezone>
    <TotalOffers>NUM</TotalOffers>
    <PageSize>NUM</PageSize>
    <TotalPages>NUM</TotalPages>
    <CurrentPage>NUM</CurrentPage>
    <App>
      <Name>App Name</Name>
      <AppKey>00000000-0000-0000-0000-000000000000</AppKey>
      <url>http://offer-destination-url.com</url>
      <Platform>App Platform</Platform>
      <Rewarded>true</Rewarded>
      <OfferType>VideoOffer</OfferType>
      <PaidInstalls>0</PaidInstalls>
      <PaidInstallsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</PaidInstallsHourly>
      <PaidClicks>0</PaidClicks>
      <PaidClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</PaidClicksHourly>
      <Spend>0</Spend>
      <SpendHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</SpendHourly>
      <Sessions>0</Sessions>
      <SessionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</SessionsHourly>
      <NewUsers>0</NewUsers>
      <NewUsersHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</NewUsersHourly>
      <DailyActiveUsers>0</DailyActiveUsers>
      <OfferwallRevenue>0</OfferwallRevenue>
      <OfferwallRevenueHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</OfferwallRevenueHourly>
      <OfferwallImpressions>0</OfferwallImpressions>
      <OfferwallImpressionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</OfferwallImpressionsHourly>
      <OfferwallClicks>0</OfferwallClicks>
      <OfferwallClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</OfferwallClicksHourly>
      <OfferwallConversions>0</OfferwallConversions>
      <OfferwallConversionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</OfferwallConversionsHourly>
      <FeaturedOfferRevenue>0</FeaturedOfferRevenue>
      <FeaturedOfferRevenueHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</FeaturedOfferRevenueHourly>
      <FeaturedOfferImpressions>0</FeaturedOfferImpressions>
      <FeaturedOfferImpressionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</FeaturedOfferImpressionsHourly>
      <FeaturedOfferClicks>0</FeaturedOfferClicks>
      <FeaturedOfferClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</FeaturedOfferClicksHourly>
      <FeaturedOfferConversions>0</FeaturedOfferConversions>
      <FeaturedOfferConversionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</FeaturedOfferConversionsHourly>
      <TJMOfferwallRevenue>0</TJMOfferwallRevenue>
      <TJMOfferwallRevenueHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</TJMOfferwallRevenueHourly>
      <TJMOfferwallImpressions>0</TJMOfferwallImpressions>
      <TJMOfferwallImpressionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</TJMOfferwallImpressionsHourly>
      <TJMOfferwallClicks>0</TJMOfferwallClicks>
      <TJMOfferwallClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</TJMOfferwallClicksHourly>
      <TJMOfferwallConversions>0</TJMOfferwallConversions>
      <TJMOfferwallConversionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</TJMOfferwallConversionsHourly>
      <DirectPlayRevenue>0</DirectPlayRevenue>
      <DirectPlayRevenueHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</DirectPlayRevenueHourly>
      <DirectPlayImpressions>0</DirectPlayImpressions>
      <DirectPlayImpressionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</DirectPlayImpressionsHourly>
      <DirectPlayClicks>0</DirectPlayClicks>
      <DirectPlayClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</DirectPlayClicksHourly>
      <DirectPlayConversions>0</DirectPlayConversions>
      <DirectPlayConversionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</DirectPlayConversionsHourly>
      <Ecpa>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</Ecpa>
      <EcpaAggregate>0</EcpaAggregate>
      <EcpaGoal>0</EcpaGoal>
      <SecondaryConversions>0</SecondaryConversions>
      <SecondaryConversionsHourly>0</SecondaryConversionsHourly>
      <SecondaryOfferItemId>66d2dd3-1111-443a-1ac3-764111aaa88</SecondaryOfferItemId>
      <Event_A_Revenue>0</Event_A_Revenue>
      <Event_A_RevenueHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</Event_A_RevenueHourly>
      <Event_A_Impressions>0</Event_A_Impressions>
      <Event_A_ImpressionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</Event_A_ImpressionsHourly>
      <Event_A_Clicks>0</Event_A_Clicks>
      <Event_A_ClicksHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</Event_A_ClicksHourly>
      <Event_A_Conversions>0</Event_A_Conversions>
      <Event_A_ConversionsHourly>0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</Event_A_ConversionsHourly>
    </App>

    ...

  </MarketingData>

**JSON リクエスト、レスポンス例

https://api.tapjoy.com/reporting_data.json?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=5&page=9&timezone=-5

レスポンス:

{
    "Date" : "YYYY-MM-DD",
    "Timezone" : NUM,
    "TotalOffers" : NUM,
    "PageSize" : NUM,
    "TotalPages" : NUM,
    "CurrentPage" : NUM,
    "Apps" : [
      {
        "Name"                           : "App Name",
        "AppKey"                         : "00000000-0000-0000-0000-000000000000",
        "url"                            : "http://offer-destination-url.com",
        "Platform"                       : "App Platform",
        "Rewarded"                       : true,
        "OfferType"                      : "VideoOffer",
        "PaidInstalls"                   : 0,
        "PaidInstallsHourly"             : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "PaidClicks"                     : 0,
        "PaidClicksHourly"               : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Spend"                          : 0,
        "SpendHourly"                    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Sessions"                       : 0,
        "SessionsHourly"                 : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "NewUsers"                       : 0,
        "NewUsersHourly"                 : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DailyActiveUsers"               : 0,
        "OfferwallRevenue"               : 0,
        "OfferwallRevenueHourly"         : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallImpressions"           : 0,
        "OfferwallImpressionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallClicks"                : 0,
        "OfferwallClicksHourly"          : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallConversions"           : 0,
        "OfferwallConversionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferRevenue"           : 0,
        "FeaturedOfferRevenueHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferImpressions"       : 0,
        "FeaturedOfferImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferClicks"            : 0,
        "FeaturedOfferClicksHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferConversions"       : 0,
        "FeaturedOfferConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallRevenue"            : 0,
        "TJMOfferwallRevenueHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallImpressions"        : 0,
        "TJMOfferwallImpressionsHourly"  : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallClicks"             : 0,
        "TJMOfferwallClicksHourly"       : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallConversions"        : 0,
        "TJMOfferwallConversionsHourly"  : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayRevenue"              : 0,
        "DirectPlayRevenueHourly"        : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayImpressions"          : 0,
        "DirectPlayImpressionsHourly"    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayClicks"               : 0,
        "DirectPlayClicksHourly"         : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayConversions"          : 0,
        "DirectPlayConversionsHourly"    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Ecpa"                           : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "EcpaAggregate"                  : 0,
        "EcpaGoal"                       : 0,
        "SecondaryConversions"           : 0,
        "SecondaryConversionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "SecondaryOfferItemId"          : "000000-0000-0000-0000-00000000000",
        "Event_A_Revenue"                : 0,
        "Event_A_RevenueHourly"          : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Impressions"            : 0,
        "Event_A_ImpressionsHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Clicks"                 : 0,
        "Event_A_ClicksHourly"           : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Conversions"            : 0,
        "Event_A_ConversionsHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
      },

      ...

    ]
  }

4. リクエストパラメータ

パラメータ名	値	説明
email	sample%40example.com	アカウントおよびAPI Keyに紐付くURL encodeされたemailアドレス — 必須
api\_key	e.g. "1ceb9db808404321b2dbc1e88cbef9cf"	API Key — 必須
date	e.g. YYYY-MM-DD	データを取得する日付 — 必須
page	e.g. 3	レスポンスが複数ページに渡る場合(レスポンスのメタデータで総ページ数は示されます)のレスポンスデータとして取得するページ番号。デフォルトはオファーの数がpage\_sizeより多い場合は最初のページ。
page\_size	e.g. 50	レスポンスデータに含まれるオファーの一ページあたりの最大数。デフォルトは50。
all\_offers	1	レスポンスに有効無効を含むすべてのキャンペーンを含む場合は1 — このパラメータがない場合は有効なキャンペーンのみのデータが返却される
timezone	e.g. 0	GMTからのタイムゾーンオフセット。デフォルト値はアカウントのタイムゾーン

5. 注意点

A. 頻度制限

このAPIの呼び出しは一分当たり一回以上にしてはいけません。

B. タイムゾーン

リクエストURLにtimezoneパラメータでタイムゾーンを指定しない場合、アカウントのタイムゾーン設定のデータが返ります。timezoneパラメータはUTCからの希望するタイムゾーンへのオフセットを整数値で時間、または秒数で指定します。レスポンスには"Timezone"フィールドが含まれるため、データが計算されたタイムゾーンを確認できます。

C. ページネーション

このAPIの一度の呼び出しのレスポンスに含まれるオファーの最大値は100です。それを超えるオファーのデータを取得する場合には、pageパラメータをリクエストに加えて下さい。各レスポンスには "TotalOffers"、"PageSize"、"TotalPages"、および "CurrentPage" が含まれまるため、適切な呼びだしによりすべての情報を取得できます。

旧リポーティングAPI
1. 概要
2. 広告レポートAPI Key
3. リクエストおよびレスポンス例
4. リクエストパラメータ
5. 注意点