Remergeはアプリのリターゲティングプラットフォームです。管理画面や分析力に加えて、稼働中のキャンペーン用のRemergeレポートAPIから毎日の粒状レベル解析に基づく社内BIまで、JSONベースのレポートを引き出すことが可能です。
一般
ご注意ください：
-
RemergeレポートAPI へは、以下に示すように、ターミナル (またはAPIクライアント) を経由してのみアクセスできます。
- Reporting APIはWebブラウザからはアクセスできません 。
- Remergeでは、6か月間の限られた期間のみデータを保存します。したがって、上記の期間よりも古いデータを取得したい場合には、お客様ご自身でデータログを作成していただくことをお勧めします。
入稿規定
お客様のパフォーマンスは、6つのディメンションで分類されます。タイムスタンプ、国、アプリ、キャンペーン、キャンペーンタイプ、関連広告です。結果を簡単にインポート、細分化、提供された分野に沿ってお客様が選択したBIプラットフォームと連携することができます。パラメーターや領域に関する詳細な情報については、以下のインデックスをご参照ください。
エンドポイント
APIは以下のエンドポイントからアクセスできます：
https://api.remerge.io/reportリクエストおよびレスポンス
リクエストパラメータ
RemergeレポーティングAPIはデータクエリのシンプルなインターフェイスを提供します。必要なパラメータは、開始日と終了日だけです。
注意: 前日のデータを取得するには 、 終了日として本日の日付を選択してください (例: 2021年12月08日のデータを取得するには開始日を2021年12月08日、終了日を2021年12月09日として設定)。
| パラメータ名 | 内容 | 例 | 必須 |
|---|---|---|---|
| *start_date | レポート開始日（YYYY-MM-DD） | 2021-12-08 | x |
| *end_date | レポート終了日（YYYY-MM-DD） | 2021-12-09 | x |
| dimensions |
指定がない場合、デフォルトでは集計データをオーディエンス、国、キャンペーン、キャンペーンタイプ、広告別に分けられます。使用可能なディメンション：オーディエンス、国、キャンペーン、キャンペーンタイプ、広告、広告ラベル、およびプラットフォーム。 |
国、プラットフォーム | |
| Filter |
キャンペーンタイプごとにリクエストをフィルタリングできます。例： https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&campaign_type=retargeting |
リターゲティング |
有効なリクエストは次でご確認ください。https://api.remerge.io/report?start_date=2017-01-10&end_date=2017-01-11&dimensions=campaign,ad
注意：
- クエリ内のすべてのシンボルが正しく端末に転送されるように、テキスト編集プログラム（SublimeやAtomなど）を使用することをお勧めします。
- リクエストURLでディメンションを制限しない限り、レスポンスは可能性のあるすべてのディメンションを生成します。
認証
例
サインインリクエスト
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -X POST
-d '{"user" : { "email" : "your@email.com","password": "password"}}' https://api.remerge.io/users/sign_in
必要なトークンをJSONで返す
{"email":"your@email.com","token":"J-QeJxyza7JH19QUDb4","user_id":1234,"user_name":"Peter Example","user_token":"J-QeJ49Yasdf219QUDb4"}
有効なレポーティングリクエストのための必須リクエストヘッダー
| パラメータ名 | 内容 | 例 | 必須 |
|---|---|---|---|
| Request Header | コンテンツタイプ | 'Content-Type: application/json' | x |
| Request Header | 許諾 | 'Accept: application/json' | x |
| Request Header | 認証トークン | 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"' | x |
| Request Type | POST | POST | x |
リクエスト例
以下は、データ転送ツールcurl を使用した、RemergeレポーティングAPIへのPOSTリクエストの例です：
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"'-X POST "https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&dimensions=audience %2Ccountry% 2Ccampaign %2Cad% 2Cad_label%2Cplatform"
レスポンスフィールド
レスポンスは、結果の配列と要素数を含むJSONオブジェクトを返します。各配列要素は、次のフィールドで構成されます：
| パラメータ名 | 内容 | 例 | |
|---|---|---|---|
| timestamp | UTC（協定世界時）タイムスタンプ | 2017-01-11T00:00:00.000Z | |
| event.platform | プラットフォーム（iOS /Android） | ios | |
| event.country | RTB（リアルタイムビディング）地域別情報 | de | |
| event.campaign | 内部向けRemergeキャンペーンID | 42 | |
| event.campaign_name | 外部向けRemergeキャンペーン | Test Campaign | |
| event.campaign_type | キャンペーンタイプ | Install/Impact/Retargeting | |
| **event.cost_currency | 内部向けRemergeキャンペーン通貨 | EUR | |
| ***event.audience | App Storeリファレンス | 12345678 | |
| event.ad_id | クリエイティブID | 1406561 | |
| event.ad_name | 画像/動画アセットのファイル名を指定します。 | banner_300_50.png | |
| event.ad_label_id | クリエイティブラベル ID | 18304 | |
| event.ad_label_name | クリエイティブラベル名 | non_purchasers_it | |
| ****event.ad_creative_url | クリエイティブURL | https://assets.remerge.io/ad_assets/files/000/006/696/original/banner_300_50.png?1478088208 | |
| event.impressions | アプリ.国.キャンペーンレベルのデイリーインプレッション数 | 2 | |
| event.clicks | アプリ.国.キャンペーンレベルのデイリークリックカウント | 1 | |
| event.app_open_rate | クリック数に対するアプリ起動率（%） | 83.57 | |
| event.cost | アプリ.国.キャンペーンレベルのお客様の通貨でのコスト | 0.12 | |
| event.conversions | アプリ.国.キャンペーンレベルのデイリーターゲットコンバージョンイベント数 | 1 | |
| event.ap_conversions | アプリ.国.キャンペーンレベルのデイリー属性別ターゲットコンバージョンイベント数 | 5 | |
| event.unique_user | アプリ.国.キャンペーンレベルのデイリーユニークユーザー数 | 2 |
JSONレスポンスの例 (同じクエリの2つの表示オプション)
オプション1：
オプション2：
指定された間隔にデータが存在しない場合、リクエストは空の結果配列とカウント：0を返します。
可能性のあるエラーリスト
| ステータス | メッセージ | 説明 |
|---|---|---|
| 200 | OK | JSONで返されたクエリ結果 |
| 401 | Unauthorized | 提供された認証トークンが無効 |
| 422 | start_date: Format YYYY-MM-DD required | 開始日の形式が不正 |
| 422 | end_date: Format YYYY-MM-DD required | 終了日の形式が不正 |
| 422 | start_date: must be a valid date | 実在しない日付、例：2015-33-09 |
| 422 | end_date: must be a valid date | 実在しない日付、例：2015-33-09 |
| 422 | end_date: end date must be greater or equal to the start date | 終了日が開始日より前の日付 |
| 422 | queryID: queryId already exists | 送信したリクエストがAPIで処理中 (例: 1ユーザーあたりのクエリ限度比率は1） |
| 504 | Gateway Timeout | リクエストのサーバー処理に時間がかかりすぎています。このエラーは通常クエリ間隔が長すぎるために発生します。この場合には、最大14日より短い間隔にして再試行してください。 |
注釈
*APIタイムスタンプ - デフォルト設定では開始日と終了日は、該当日の00:00に設定されています。例えば、該当する日を正確に検索したい場合、該当日を開始日とし、その翌日を終了日として検索します。一度につき一つの日付のみリクエストするようにしてください (例: それぞれの日は昨日の日付でリクエストし、内部のデータベースに保存)。
** キャンペーンごとに異なる通貨が使用されているキャンペーン別にレポートを分割するようにしてください。
*** Remergeでは、アプリケーションを通してオーディエンスという用語を使用します(文脈によっては、オーディエンスがセグメントを意味するのとは異なります)。レポートを取得すると、RemergeレポートAPI は、オーディエンスと呼ばれるフィールドを返します。これは単純に、そのレポートにアプリ全体の静的データが含まれていることを意味します。
**** ダイナミック広告の場合、実際のクリエイティブURLはフィードから動的に取得されるため、表示されるクリエイティブURLはプレースホルダにすぎません。残念ながら、このレポートでは表示できません。