概要: アドネットワークは、自分の連携済みパートナーアカウントに紐付けられている広告主アプリのメタデータを取得できます。
アプリリストの取得API
以下のセクションにて、APIを使用するために必要な情報を記載しています。
アプリリスト取得の仕様
カテゴリ | Item |
説明 |
---|---|---|
リクエスト | HTTP method | GET |
Path |
https://hq1.appsflyer.com/api/mng/apps |
|
認証ヘッダー |
|
|
レスポンス |
結果 |
JSON形式で返されます。 |
リクエスト制限 |
|
|
レコード数の制限 |
1リクエストにつき、1000レコードまで取得可能です。1000以上のレコードが返される場合には、この記事内で紹介されているページネーションのリクエストを使用してください。 |
APIリクエスト
APIリクエストは、method、path、必須の機能パラメーター、オプションのページネーションパラメータで構成されています。また、APIトークンは認証ヘッダーに含まれます。
メソッド
GET https://hq1.appsflyer.com/api/mng/apps?capabilities={capabilities}
クエリパラメーター |
説明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
機能 |
アクセス許可と連携権限を持っているアプリの一覧と数を取得するには、以下に記載されている機能パラメーターを設定してください。
例:Protect360のレポートAPIに関する権限を持っているアプリの一覧を取得したい場合 → |
ページネーションの仕組みについて
随時機能するページネーションの仕組みが実装されています。
ページネーションの仕様:
- リクエスト(ページ)毎に最大1000レコードまで返します。
- レスポンスJSONには、以下のページネーション関連のkeyが含まれています:
-
meta.total_items:
全ページ合算でのレコード数です。これはあなたが 機能 権限を付与されているアプリの数を示しています。 - ページネーションリンク(下記JSONを参照)には、以下のkeyが含まれます:
- links.prev:それよりも前のリクエストがあった場合 - 前のページを生成するために使用されたリクエストが入ります。
- links.self:そのリクエスト - そのJSON(ページ)を生成するために使用されたリクエストが入ります。
- links.next:次のページを取得するためのリクエストです。next のkeyがない場合、これが最終ページです。
-
meta.total_items:
次のいずれかのページネーションの制御方法を使用してください。
- [推奨]
JSON内のlinks を使用してください:もしlinks.nextのkeyが存在する場合は、それを使用して次のページを取得するためのリクエストを作成してください。links.nextのkeyがないJSONを受け取るまでは、この作業を続けてください。 - limitとoffsetのパラメータをtotal_itemsのkeyを組み合わせたプログラムを実装してください。
ページネーションのlinksのJSON例
- 次の例は、最初のリクエストの結果を含んでおり、データセクション(非表示)に2つのレコードを含む2番目のリクエストで構成されています。
- 返されるレコードの総数は6です。
- links.nextのkeyには次のページ(レコード5と6)を返すリクエストが含まれています。
{
"data": {[...]},
"meta": {
"total_items": 6
},
"links": {
"prev": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=2",
"self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=2&limit=2",
"next": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=4&limit=2"
}
}
クエリパラメーター |
説明 |
---|---|
limit |
コール毎に返されるレコード数を指定可能です。
|
offset |
コールで返される最初のレコードです。レコード番号は0から始まります。
|
JSONレスポンス
Key |
説明 |
---|---|
id |
App IDが返されます。(例: |
type |
常にapp という値が返されます。 |
name |
アプリ名が返されます。 |
platform |
iOS or Android が返されます。 |
currency |
広告主側で設定した、アプリ固有の通貨単位が返されます。 |
time_zone |
広告主側で設定した、アプリ固有のタイムゾーン設定が返されます。 |
total_items |
アドネットワークがリクエストした機能オプションを持っているアプリの数が返されます。 |
links |
ページネーション機能(パラメータのセクションを参照してください)
|
アプリリスト取得のCurlの例とそのレスポンス
Curl リクエスト
この例は、任意のページネーションパラメータを含む完全なコール内容が記載されています。
curl --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&limit=1000&offset=0' \
-H 'Authorization: Bearer {API V2.0 token available to the admin in the dashboard.}' \
JSONレスポンス
{
"data": [
{
"id": "com.appsflyer.xpend_qa1",
"type": "app",
"attributes": {
"name": "com.appsflyer.xpend_qa1",
"platform": "android",
"currency": "USD",
"time_zone": "UTC"
}
},
{
"id": "com.abc.app",
"type": "app",
"attributes": {
"name": "com.abc.app",
"platform": "android",
"currency": "USD",
"time_zone": "UTC",
"enable_retargetting": true
}
},
{
"id": "com.xyz.app",
"type": "app",
"attributes": {
"name": "com.xyz.app",
"platform": "android",
"currency": "JPY",
"time_zone": "UTC"
}
}
],
"meta": {
"total_items": 3
},
"links": {
"self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=1000"
}
}
HTTPのレスポンスコード
Code |
メッセージ |
備考 / トラブルシューティング |
---|---|---|
200 | OK |
有効なデータが返されました |
200 | OK |
事象:データが返されない。 対処法:bearerヘッダー内に認証トークンがあることを確認してください。 |
400 | Bad request |
|
401 | Unauthorized |
メッセージ:認証トークンの形式が正しくありません。 正しいトークンであることを確認してください。トークン文字数は700字以上です。 |
404 | Not found |
|
429 | リクエストが多すぎます |
レート制限を超えました |