アプリ所有者向けアプリリスト API

概要:AppsFlyer アカウントに関連付けられているアクティブなアプリと保留中のアプリを取得します。

mceclip0.png

アドネットワークの場合は、アドネットワーク用アプリリストAPIを使用してください

参考記事広告主向け API リスト

アプリリストの取得API

以下のセクションに、API を使用するために必要な情報を記載しています。

アプリリスト基本情報の取得

API リストの基本情報を取得

カテゴリ アイテム

説明

リクエスト HTTP メソッド GET
経路

https://hq1.appsflyer.com/api/mng/apps

認証ヘッダー  

 レスポンス

結果

JSON 形式で返されます

リクエスト制限
  • 20リクエスト / 分
  • 100リクエスト / 日
レコード数の制限

1リクエストにつき、1,000レコードまで取得可能です。1,000以上のレコードが返される場合には、この記事内で紹介されているページネーションのリクエストを使用してください。

API リクエスト

API リクエストは、メソッド、経路、必須の機能パラメーター、オプションのページネーションパラメーターで構成されています。また、API トークンは認証ヘッダーに含まれます。  

メソッド

GET https://hq1.appsflyer.com/api/mng/apps

アプリリストの必須パラメーターの取得:

クエリパラメーター

説明
   この API には必須のクエリパラメーターはありません


ページネーションの仕組みについて

随時機能するページネーションの仕組みが実装されています。  

ページネーションの仕様: 

  • リクエスト(ページ)毎に最大1,000レコードまで返します。
  • レスポンスJSON には、以下のページネーション関連のキーが含まれています:
    • meta.total_items:全ページ合算でのレコード数です。これは、照会されている機能が付与されているアプリの数を表します。
    • ページネーションリンク(下記 JSON を参照)には、以下のキーが含まれます:
      • links.prev:それよりも前のリクエストがあった場合 - 前のページを生成するために使用されたリクエストが入ります。
      • links.self:現在のリクエスト:現在の JSON (ページ)を生成するために使用されたリクエスト
      • links.next:次のページを取得するためのリクエストです。次へのキーがない場合は、これが最終ページです。 

次のいずれかのページネーションの制御方法を使用してください。

  • [ベストプラクティス] JSON 内のリンクを使用するlinks.next キーが存在する場合は、それを使用して次のページを取得するリクエストを作成します。links.next のキーがないJSON を受け取るまでは、この作業を続けてください
  • limitoffset のパラメーターをtotal_itemsのキーを組み合わせたプログラムを実装してください。

ページネーションリンク JSON の例

  • 次の例には、データセクションの2つのレコードで構成される2回目のリクエストの結果が含まれています (表示されていません)。 
  • 返されるレコードの総数は6です。
  • links.next キーには、2ページ目 (レコード5と6) を返すリクエストが含まれています。 
{                                                                                         
    "data": {[...]},   
    "meta": {
        "total_items": 6
    },
    "links": {
        "prev": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=2",
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=2&limit=2",
        "next": "https://hq1.appsflyer.com/api/mng/apps?offset=4&limit=2"
    }
}

ページネーション機能のパラメーター(任意):

クエリパラメーター

説明
limit

コール毎に返されるレコード数

  • 最大値:1,000
  • limitを送信しない場合、自動的に1,000に設定されます。
  • 例: limit=2
  • 必須:いいえ
offset

コールで返される最初のレコードです。レコード番号は0から始まります。 

  • offsetを送信しない場合、自動的に0に設定されます。
  • 例:offset=2
  • 必須:いいえ

JSON レスポンス

キー

説明

id

アプリ ID (例:id123456789, com.myapp.com

type

常に戻る app 

name

アプリ名が返されます。

platform

iOS or Android が返されます。

currency

アプリ固有の通貨コード 

time_zone

アプリ固有のタイムゾーン

total_items

アカウントに格納されているアプリの数

links

ページネーション機能(パラメーターのセクションを参照してください)

  • prev: 前のページを生成するために使用されたコールが返されます。
  • self: そのページを生成するために使用されたコールが返されます。
  • next: 次のページを生成するために使用するコールが返されます。

アプリリスト取得の cURL の例とそのレスポンス

Curl リクエスト

この例は、任意のページネーションパラメーターを含む完全なコール内容が記載されています。 

cURL --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?limit=1000&offset=0' \
-H 'Authorization: Bearer {API V2.0 token having more than 700 characters 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.def.app",
            "type": "app",
            "attributes": {
                "name": "com.def.app",
                "platform": "android",
                "currency": "JPY",
                "time_zone": "UTC"
            }
        }
    ],
    "meta": {
        "total_items": 6
    },
    "links": {
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=1000"
           }
}

HTTP のレスポンスコード

コード 

メッセージ

備考 / トラブルシューティング

200 OK

有効なデータが返されました

200 OK

症状:データ返却なし

アクション:bearer ヘッダー内に認証トークンがあることを確認してください。

400 Bad request

JSON内に含まれているメッセージを確認してください。

401 Unauthorized

メッセージ:認証トークンの形式が正しくありません

正しいトークンであることを確認してください。トークン文字数は700字以上です。

404 Not found
  • ネットワークやファイアウォールに関する問題を処理してください。 
  • AppsFlyer のIP アドレスが許可リストに登録されていることを確認してください
  • 必ず直近に発行された最新のトークンを使用してください。
  • データが見つかりませんでした:アプリが見つかりません。 
429 Too many requests

レート制限を超えました