レポートエンドポイント

レポートエンドポイントを使用すると、多数のサービスからのデータを1つのレポートにまとめることができます。インストール、収益、広告費用、SKAdNetworkデータを、日別、アプリ別、広告ネットワーク別に分けてリクエストしてください。

JSONレポートを取得する

GET https://automate.adjust.com/reports-service/report

レポートサービスからフィルタリングされたデータをJSON形式で返します。

フィルター

フィルター	種類	説明	例
`dimensions`*	`String`	パラメーターのグループ化に使用されるコンマ区切り値。詳細については、下のディメンションの表をご覧ください。	`dimensions=app,os_name,week,campaign_id_network`
`metrics`*	`String`	コンマ区切りされたKPI。詳細については、下の指標の表をご覧ください。	`metrics=cost,installs,ecpi_network`
`date_period`*	`String`	レポートの開始日と終了日。次の3通りの形式がサポートされています。論理日付絶対日付相対日付	論理日付： `this_month_until_yesterday` `today` `yesterday` `this_week` `last_week` `this_month` `last_month` 絶対日付： `2020-12-31:2021-01-01` 相対日付： `-10d:-3d (from 10 days ago to 3 days ago)`
`cohort_maturity`	`String`	`immature`: 未成熟コホートを含む、全てのコホートの累積指標の現在値を表示します。 `mature`: 成熟コホートの累積指標の値を表示し、未成熟コホートには0を表示。	`cohort_maturity=immature`
`utc_offset`	`String`	レポートで使用されるタイムゾーン	`utc_offset=+01:00`
`attribution_type`	`String`	アトリビューションとして計上されたエンゲージメントのタイプ。 `click` (デフォルト) `impression` `all`	`attribution_type=click`
`attribution_source`	`String`	アプリ内アクティビティがユーザーのインストールソース（`first`）に割り当てられられるか、あるいはインストールソースとその後のリアトリビューションのソース（`dynamic`）の間で分割されるかを決定します。デフォルトの設定は`dynamic`です。	`attribution_source=first`
`reattributed`	`String`	リアトリビュートされたユーザーのみをフィルタリングします。リアトリビューションは、アプリをインストール済みのユーザーが、Adjustが計測する新しいソースを経由して戻ってきた場合に計測されます。 `all` (デフォルト) `false` `true`	`reattributed=false`
`iap_revenue_mode`	`String`	エンドポイントが返した総計広告収益の割合。利用可能なオプションは以下のとおりです： `GROSS_100` `GROSS_85` `GROSS_70` `GROSS_60`	`iap_revenue_mode=GROSS_70`
`ad_revenue_sources`	`String`	コンマで区切られた広告収益ソースのリスト。	`ad_revenue_sources=unknown`
`os_names`	`String`	コンマで区切られたOS名のリスト。	`os_names=ios,android`
`ad_spend_mode`	`String`	計算で適用される広告費用ソースを決定。詳細については、広告費用ソースがデータに与える影響をご覧ください。 `adjust` `network` `mixed`	`ad_spend_mode=network`
`sandbox`	`Boolean`	サンドボックスデータまたはプロダクションデータのどちらを使用するか。デフォルトの設定は`false`です。	`sandbox=true`
`sort`	`String`	コンマで区切られた、レポートの並び替えに使用する指標/ディメンションのリスト。降順で並べ替えるには`-`を使用します。	`sort=-clicks,installs`
`index`	`String`	コンマで区切られた、レポートのインデックスに使用するディメンションのリスト。	`index=network,campaign,adgroup`
`format_dates`	`Boolean`	`false`に設定されている場合、全ての日付ディメンションはISOフォーマットで返されます。	`format_dates=false`
`period_over_period`	`String`	レポートデータの比較期間。	`period_over_period=previous_week`
`currency`	`String`	お金に関連する指標のコンバージョンに使用される通貨。	`currency=USD`
`[dimension]__in`	`String`	任意のディメンションについて、ディメンション値（完全一致）をフィルターするコンマで区切られた値のリスト。	`campaign__in=abc,def`
`[dimension]__not_in`	`String`	あらゆるディメンションについて、このコンマ区切りリストに含まれる値でディメンションの値をフィルター（完全一致は除く）。	`campaign__not_in=abc,def`
`[dimension]__contains`	`String`	任意のディメンションについて、この部分文字列が含まれるディメンションの値を検索（大文字と小文字の区別なし）。	`campaign__contains=ios`
`[dimension]__exclude`	`String`	全てのディメンションについて、ディメンション値のサブストリング検索を除外（大文字と小文字の区別なし）。	`campaign__exclude=ios`
`[dimension]__starts_with`	`String`	指定されたプレフィックスで始まるディメンションに一致するサブストリング検索（大文字と小文字の区別なし）。	`campaign__starts_with=ios`
`[dimension]__not_starts_with`	`String`	指定されたプレフィックスで始まらないディメンションに一致するサブストリング検索（大文字と小文字の区別なし）。	`campaign__not_starts_with=ios`
`[dimension]__ends_with`	`String`	指定されたサフィックスで終わるディメンションに一致するサブストリング検索（大文字と小文字の区別なし）。	`campaign__ends_with=ios`
`[dimension]__not_ends_with`	`String`	指定されたサフィックスで終わらないディメンションに一致するサブストリング検索（大文字と小文字の区別なし）。	`campaign__not_ends_with=ios`
`[metric]__lt`	`String`	「この数値より小さい（<）」の条件で、任意の指標の値をフィルター。	`skad_installs__lt=100`
`[metric]__lte`	`String`	「この数値以下（≦）」の条件で任意の指標の値をフィルター。	`skad_installs__lte=100`
`[metric]__gt`	`String`	「この数値より大きい（>）」の条件で任意の指標の値をフィルター。	`skad_installs__gt=100`
`[metric]__gte`	`String`	「この数値以上（≧）」の条件で任意の指標の値をフィルター。	`skad_installs__gte=100`
`[metric]__eq`	`String`	「この数値と等しい（=）」の条件で指標の値をフィルター。	`skad_installs__eq=100`
`[metric]__ne`	`String`	「等しくない（≠）」で任意の指標に関連する値をフィルター。	`skad_installs__ne=100`

ディメンション

ディメンションでは、ユーザーが1つまたは複数のパラメーターを使用して指標をグループに分類できます。例えば、日付、国または地域、ネットワーク別のインストール数などです。

ディメンション	データタイプ	説明	例
`hour`	`Date`	値をISO形式で返す場合は`format_dates=false`を使用します。 `YYYY-MM-DDTHH:MM:SS`	`2021-05-11T17:00:45`
`day`	`Date`	値をISO形式で返す場合は`format_dates=false`を使用します。 `YYYY-MM-DD`	`2021-05-11`
`week`	`Date`	値をISO形式で返す場合は`format_dates=false`を使用します。 `YYYY-MM-DD - YYYY-MM-DD`	`2021-05-09 - 2021-05-15`
`month`	`Date`	値をISO形式で返す場合は`format_dates=false`を使用します。 `YYYY-MM`	`2021-05`
`year`	`Date`	値をISO形式で返す場合は`format_dates=false`を使用します。 `YYYY`	`2021`
`quarter`	`String`	値をISO形式で返す場合は`format_dates=false`を使用します。 `Q<quarter_number> YYYY`	`Q2 2021`
`os_name`	`String`	指定できる値： `android` `bada` `blackberry` `ios` `linux` `macos` `server` `symbian` `unknown` `webos` `windows` `windows-phone`
`device_type`	`String`	指定できる値： `bot` `console` `ipod` `mac` `pc` `phone` `server` `simulator` `tablet` `tv` `unknown`
`app`	`String`	アプリの名前
`app_token`	`String`	Adjustシステム内でのアプリID
`store_id`	`String`	ストアのアプリID	`com.random.app`
`store_type`	`String`	インストールされたアプリの入手元ストア	`google_play`
`currency`	`String`	通貨名	`Euro`
`currency_code`	`String`	3文字のISO 4217値	`EUR`
`network`	`String`	アドネットワーク名	Organic、 AppLovin、Facebook Installs、 Instagram Installs
`campaign`	`String`	リンクサブレベル1。通常はキャンペーン名とIDを含む文字列値。
`campaign_network`	`String`	ネットワークからのキャンペーン名。
`campaign_id_network`	`String`	ネットワークからのキャンペーンID
`adgroup`	`String`	リンクサブレベル 2。通常はアドグループ名とIDを含む文字列値。
`adgroup_network`	`String`	ネットワークからのアドグループ名。
`adgroup_id_network`	`String`	ネットワークからのアドグループID
`source_network`	`String`	ソースネットワークの名前。ネットワークに依存するオプションの値。
`source_id_network`	`String`	ソースネットワークのID。
`creative`	`String`	リンクサブレベル3。通常はクリエイティブ名とIDを含む文字列値。
`creative_network`	`String`	ネットワークからのクリエイティブ名。
`creative_id_network`	`String`	ネットワークからのクリエイティブID
`country`	`String`	国または地域名	`United States of America`
`country_code`	`String`	2文字のISO 3166値	`US`
`region`	`String`	ビジネス地域	`APAC`
`partner_name`	`String`	Adjustシステム内でのパートナーの名前	`AppLovin`
`partner_id`	`String`	Adjustシステム内でのパートナーのID	`34`
`partner`	`String`	パートナーの固有のslug。	`applovin`
`channel`	`String`	`partner_name`と`network`の組み合わせ
`platform`	`String`	デバイスのOS /プラットフォーム。Adjustがサポートしているプラットフォームのリストは、以下をご覧ください。	`android`

プラットフォーム

android
android-tv
bada
blackberry
facebook
fire-tv
ios
linux
macos
server
symbian
webos
windows
windows-phone

指標

指標は、Adjustを使用して実行、計測するキャンペーンのパフォーマンスを評価、比較するために使用されます。

各APIリクエストには少なくとも1つの指標が必要です。最も一般的な指標には、以下のものがあります。

installs
clicks
impressions

指標の全リストはDatascape指標用語集をご覧ください。また、フィルターデータのエンドポイントを使用して、指標を検索することも可能です。

レスポンスの形式

{
   "rows": [
      {
         "attr_dependency": {},
         "app": "App Name",
         "partner_name": "AppLovin",
         "campaign": "Campaign Name (Campaign ID)",
         "campaign_id_network": "Campaign ID",
         "campaign_network": "Campaign Name",
         "installs": "64",
         "cost": "1000"
      }
   ],
   "totals": {
      "installs": 64,
      "cost": 1000
   },
   "warnings": []
}

レスポンスコード

このエンドポイントは、以下のレスポンスを返します：

レスポンス	説明	注意
`200`	成功	レポート情報を返す
`204`	内容なし（No content）	レスポンスオブジェクトが空の場合に返される
`400`	不正なリクエスト（Bad request）	リクエストに不正があるか、サポートされていないパラメーターが含まれている場合に返される
`401`	無許可（Unauthorized）	認証情報が正しくないか欠けている場合に返される
`403`	禁止（Forbidden）	閲覧許可がない情報にアクセスしようとした場合に返される
`429`	リクエスト過多（Too many requests）	同時リクエストが50回を超えた場合に返される
`503`	サービス利用不可（Service unavailable）	サーバーにリーチできなかった場合に返される
`504`	ゲートウェイタイムアウト（Gateway timeout）	クエリが応答を返すのに時間がかかりすぎた場合に返される

例

$ curl \
--header 'Authorization: Bearer <adjust_api_token>' \
--location --request GET 'https://automate.adjust.com/reports-service/report?ad_spend_mode=network&app_token__in={app_token1},{app_token2}&date_period=2021-05-01:2021-05-02&dimensions=app,partner_name,campaign,campaign_id_network,campaign_network&metrics=installs,network_installs,network_cost,network_ecpi'

{
   "rows": [
      {
         "attr_dependency": {
            "campaign_id_network": "unknown",
            "partner_id": "-300",
            "partner": "Organic"
         },
         "app": "Test app",
         "partner_name": "Organic",
         "campaign": "unknown",
         "campaign_id_network": "unknown",
         "campaign_network": "unknown",
         "installs": "10",
         "network_installs": "0",
         "network_cost": "0.0",
         "network_ecpi": "0.0"
      }
   ],
   "totals": {
      "installs": 10.0,
      "network_installs": 0.0,
      "network_cost": 0.0,
      "network_ecpi": 0.0
   },
   "warnings": [],
   "pagination": null
}