CSVレポートのエンドポイント CSVレポートサービス(CSV Reports Service)は、KPIサービスの合計レポート、KPIサービスのコホート、SKAdNetwork、広告費用などの様々なソースからCSV形式の集計データを取得するためのAPIを提供します。
レポートエンドポイントを使用すると、多数のサービスからのデータを1つのレポートにまとめることができます。インストール、収益、広告費用、SKAdNetworkデータを、日別、アプリ別、広告ネットワーク別に分けてリクエストしてください。
このエンドポイントを使用するには、Adjust APIトークンが必要です。この手順を使用してAdjust API認証 を設定し、管理してください。
APIのユーザー権限には、Adjustユーザーアカウントのユーザー権限 が反映されます。
https://dash.adjust.com/control-center/reports-service/csv_report
GET
メソッドは、レポートサービスからフィルタリングされたデータをJSON形式で返します。APIは、リクエストで渡されたパラメーターごとにデータの列を返します。デフォルトでは、パラメーターのslugが列ヘッダーとして使用されます。リクエスト内でreadable_names=true
を渡すことによって、読み取り可能な名前を返すことができます。
読み取り可能な名前はアップストリーム側の要件によって変化する可能性があります。一貫性を確保するために、長期間実行するレポートにはslugを使用します。
イベントエンドポイント を使用することで、イベントslugを取得できます。
全て展開する
dimensions
*文字列 パラメーターのグループ化に使用されるコンマ区切り値。詳細については、下のディメンションの表をご覧ください。 dimensions=app,os_name,week,campaign_id_network
metrics
*文字列 コンマ区切りされたKPI。詳細については、下の指標の表をご覧ください。 metrics=cost,installs,ecpi_network
date_period
*文字列 レポートの開始日と終了日。次の3通りの形式がサポートされています。
論理日付 :
this_month_until_yesterday
today
yesterday
this_week
last_week
this_month
last_month
絶対日付 :
相対日付 :
readable_names
Boolean 読み取り可能な名前とともに列を返すかどうか。デフォルトの設定は false
です。 readable_names=true
cohort_maturity
文字列
immature
– 未成熟コホートを含む、全てのコホートの累積指標の現在値を表示します。
mature
– 成熟コホートの累積指標の値を表示し、未成熟コホートには0を表示します。
cohort_maturity=immature
utc_offset
文字列 レポートで使用されるタイムゾーン utc_offset=+01:00
timezone_id
文字列 レポートで使用されるタイムゾーンのID timezone_id=1
hour__between
文字列 1日の特定の時間帯の結果をフィルタリングします。 hour__between=-10h:-0h
attribution_type
文字列 アトリビューションされたエンゲージメントのタイプ。
click
(デフォルト)
impression
all
attribution_type=click
attribution_source
文字列 アプリ内アクティビティがユーザーのインストールソース( first
)に割り当てられられるか、あるいはインストールソースとその後のリアトリビューションのソース(dynamic
)の間で分割されるかを決定します。デフォルトの設定はdynamic
です。 attribution_source=first
reattributed
文字列 アトリビュートされたユーザーのみをフィルタリングします。リアトリビューションは既にアプリをインストール済みのユーザーが新しいAdjust計測のソースを通して戻ってきた場合を意味します。
reattributed=false
ad_revenue_mode
文字列 エンドポイントが返した総計広告収益の割合。利用可能なオプション:
GROSS_100
GROSS_85
GROSS_70
GROSS_60
ad_revenue_mode=GROSS_70
ad_revenue_sources
文字列 コンマで区切られた広告収益ソースのリスト。 ad_revenue_sources=unknown
os_names
文字列 コンマで区切られたOS名のリスト。 os_names=ios,android
ad_spend_mode
文字列 計算で適用される広告費用ソースを決定します。 広告費用ソースがデータに与える影響 を参照してください。
ad_spend_mode=network
sandbox
Boolean サンドボックスデータまたはプロダクションデータを使用するか。デフォルトの設定は false
です。 sandbox=true
sort
文字列 コンマで区切られた、レポートの並び替えに使用する指標/ディメンションのリスト。降順で並べ替えるには -
を使用します。 sort=-clicks,installs
index
文字列 コンマで区切られた、レポートのインデックスに使用するディメンションのリスト index=network,campaign,adgroup
format_dates
Boolean false
に設定されている場合、全ての日付ディメンションはISOフォーマットで返されます。 format_dates=false
period_over_period
文字列 レポートデータの比較期間 。 period_over_period=previous_week
currency
文字列 お金に関連する指標のコンバージョンに使用される通貨。 currency=USD
[dimension]__in
文字列 任意の ディメンションについて、このコンマ区切りリストに含まれる値でディメンションの値をフィルターします(完全一致)。 campaign_in=abc,def
[dimension]__not_in
文字列 任意の ディメンションについて、このコンマ区切りリストに含まれる値でディメンションの値をフィルターします(完全一致は除く)。 campaign__not_in=abc,def
[dimension]__contains
文字列 任意の ディメンションについて、この部分文字列が含まれるディメンションの値を検索します(大文字と小文字の区別なし)。 campaign__contains=ios
[dimension]__exclude
文字列 任意の ディメンションについて、この部分文字列が含まれないディメンションの値を検索します(大文字と小文字の区別なし)。 campaign__exclude=ios
[dimension]__starts_with
文字列 指定されたプレフィックスで始まるディメンションに一致するサブストリング検索(大文字と小文字の区別なし)。 campaign__starts_with=ios
[dimension]__not_starts_with
文字列 指定されたプレフィックスで始まらないディメンションに一致するサブストリング検索(大文字と小文字の区別なし)。 campaign__not_starts_with=ios
[dimension]__ends_with
文字列 指定されたサフィックスで終わるディメンションに一致するサブストリング検索(大文字と小文字の区別なし)。 campaign__ends_with=ios
[dimension]__not_ends_with
文字列 指定されたサフィックスで終わらないディメンションに一致するサブストリング検索(大文字と小文字の区別なし)。 campaign__not_ends_with=ios
[metric]__lt
文字列 任意の 指標について、「この数値より小さい(<)」の条件で指標の値をフィルターします。 skad_installs__gt=100
[metric]__lte
文字列 任意の 指標について、「この数値以下(≦)」の条件で指標の値をフィルターします。 skad_installs__gte=100
[metric]__gt
文字列 任意の 指標について、「この数値より大きい(>)」の条件で指標の値をフィルターします。 skad_installs__gt=100
[metric]__gte
文字列 任意の 指標について、「この数値以上(≧)」の条件で指標の値をフィルターします。 skad_installs__gte=100
[metric]__eq
文字列 任意の 指標について、「~に等しい(=)」の条件で指標の値をフィルターします。 skad_installs__eq=100
metric__ne
文字列 任意の 指標に関連する値の「等しくない(≠)」フィルター skad_installs__ne=100
ディメンションでは、ユーザーが1つまたは複数のパラメーターを使用して指標をグループに分類できます。例えば、日付、国または地域、ネットワーク別のインストール数などです。
hour
日付 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 YYYY-MM-DDTHH:MM:SS 2021-05-11T17:00:45 day
日付 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 YYYY-MM-DD 2021-05-11 week
日付 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 YYYY-MM-DD - YYYY-MM-DD 2021-05-09 - 2021-05-15 month
日付 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 YYYY-MM 2021-05 year
日付 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 YYYY-MM 2021 quarter
文字列 日付値。値をISO形式で返す場合は、 format_dates=false
を使用します。 Q YYYY Q2 2021 os_name
文字列 指定できる値:
android
bada
blackberry
iOS
linux
macos
server
symbian
unknown
webos
windows
windows-phone
- device_type
文字列 指定できる値:
bot
console
ipod
mac
pc
phone
server
simulator
tablet
tv
unknown
- app
文字列 アプリの名前 - app_token
文字列 Adjustシステム内でのアプリID - store_id
文字列 ストアのアプリID com.random.app store_type
文字列 インストールされたアプリの入手元ストア google_play currency
文字列 通貨名 Euro currency_code
文字列 3文字のISO 4217値 EUR campaign
文字列 トラッカーサブレベル1 通常はキャンペーンの名前とIDを含む 文字列値 - campaign_network
文字列 ネットワークからのキャンペーン名 - campaign_id_network
文字列 ネットワークからのキャンペーンID - adgroup
文字列 トラッカーサブレベル2 通常はアドグループの名前とIDを含む文字列値 - adgroup_network
文字列 ネットワークからのアドグループ名 - adgroup_id_network
文字列 ネットワークからのアドグループID - source_network
文字列 ソースネットワークの名前。ネットワークに依存するオプションの値。 - source_id_network
文字列 ソースネットワークのID。 - creative
文字列 トラッカーサブレベル3 通常はクリエイティブの名前とIDを含む文字列値 - creative_network
文字列 ネットワークからのクリエイティブ名 - creative_id_network
文字列 ネットワークからのクリエイティブID - country
文字列 国または地域名 United States of America country_code
文字列 2文字のISO 3166値 US region
文字列 ビジネス地域 APAC partner_name
文字列 Adjustシステム内でのパートナーの名前 AppLovin partner_id
整数 Adjustシステム内でのパートナーのID 34 partner
文字列 パートナーの固有のslug。 AppLovin channel
文字列 partner_name
とnetwork
の組み合わせ - platform
文字列 デバイスの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 指標用語集 をご覧ください。また、filters_dataエンドポイント を使用して、指標の一覧を確認することも可能です。
このエンドポイントは、以下のレスポンスを返します:
200 成功 (Success) レポート情報を返す 204 内容なし(No content) レスポンスオブジェクトが空の場合に返される 400 不正なリクエスト(Bad request) リクエストに不正があるか、サポートされていないパラメーターが含まれている場合に返される 401 無許可(Unauthorized) 認証情報が正しくないか欠けている場合に返される 403 禁止(Forbidden) 閲覧許可がない情報にアクセスしようとした場合に返される 429 リクエスト過多(Too many requests) 同時リクエストが50回を超えた場合に返される 503 サービス利用不可(Service unavailable) サーバーにリーチできなかった場合に返される 504 ゲートウェイ タイムアウト(Gateway timeout) クエリが応答を返すのに時間がかかりすぎた場合に返される
CSVレポートエンドポイントは、CSV形式でデータを返します。
app,partner_name,campaign,campaign_id_network,campaign_network,installs,network_cost
String,String,String,String,String,Number,Number
app
文字列 アプリの名前 partner_name
文字列 パートナーの名前 campaign
文字列 キャンペーンのIDの名前 campaign_id_network
文字列 キャンペーンのID campaign_name
文字列 キャンペーンの名前 installs
数値 インストールの数 network_cost
数値 行の合計ネットワークコスト
curl \
--header 'Authorization: Bearer <adjust_api_token>' \
--location --request GET 'https://dash.adjust.com/control-center/reports-service/csv_report?cost_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_cost'
app,partner_name,campaign,campaign_id_network,campaign_network,installs,network_cost
App Name,AppLovin,Campaign Name (Campaign ID),Campaign ID,Campaign Network,64,1000