メインコンテンツまでスキップ

パフォーマンスデータがあるアプリケーション一覧

このエンドポイントは、パフォーマンスデータを要求できるアカウント上のアプリケーションを返します。他のパフォーマンス系エンドポイントが期待する正確な applicationName の値と、各アプリケーションが対応している指標を確認するために使用してください。

エンドポイント​

メソッドURL
GEThttps://ws.catappult.io/api/statistics/availableApplications

認証​

この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります (生成方法についてはこちらを参照してください)。

⚠️
必要なアカウントタイプ

パフォーマンスデータを取得できるのは、Developer タイプのアカウントのみです。

ヘッダー​

ヘッダー型必須説明
Api-Keystring必須API リクエストの認証に使用されます。値は Aptoide Connect API キーです。

クエリパラメータ​

このエンドポイントはクエリパラメータを受け取りません。

レスポンス​

成功​

API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、アプリケーションの JSON 配列が返されます。空の配列は、そのアカウントにパフォーマンスデータを持つアプリケーションが存在しないことを意味します。

フィールド型説明
applicationNamestring他のパフォーマンス系エンドポイントに applicationName として渡すパッケージ名。
applicationTitlestringアプリケーションの表示名。
applicationIconUrlstringアプリケーションアイコンの URL。
operatingSystemNamestringこのエントリが対象とするプラットフォーム (android または ios)。同一のパッケージ名がプラットフォームごとに 1 回ずつ現れることがあります。
showSalesDatabooleanこのアプリケーションで revenue を要求できるかどうか。
showInstallsDatabooleanこのアプリケーションで installs を要求できるかどうか。
showDownloadsDatabooleanこのアプリケーションで downloads を要求できるかどうか。
minFromDatestringパフォーマンスデータが存在する最も古い日付。
maxToDatestringパフォーマンスデータが利用可能な最も新しい日付。上限がない場合は null。
isCurrentOwnerbooleanアカウントが現在このアプリケーションを所有しているかどうか。
billingobjectアプリケーションの課金連携。hasBilling と method を含みます。
💡
同一のパッケージ名が 2 回現れることがあります

パッケージ名はプラットフォームごとに一意であり、それ単独で一意ではありません。そのため、Android と iOS の両方で公開されているアプリケーションは、同じ applicationName と異なる operatingSystemName を持つ 2 つのエントリとして表示されます。どちらかを選択するには、他のパフォーマンス系エンドポイントに operatingSystem を渡してください。

レスポンス例​

[
    {
        "applicationIconUrl": "https://cdn-catappult.aptoide.com/icon/example-icon.png",
        "applicationName": "com.example.test",
        "applicationTitle": "Example App",
        "billing": {
            "hasBilling": true,
            "method": "catappult-sdk",
            "verifiedMethod": "sdk"
        },
        "isCurrentOwner": true,
        "marketingRating": null,
        "maxToDate": null,
        "minFromDate": "2024-05-09 06:50:41",
        "operatingSystemName": "android",
        "showDownloadsData": false,
        "showIncludedMarketingValueSummary": false,
        "showInstallsData": true,
        "showSalesData": true,
        "showSalesSummary": false
    }
]
⚠️
利用可否フラグはデータの存在を保証するものではありません

showSalesData、showInstallsData、showDownloadsData は、そのアプリケーションの連携が対応している内容を示すものです。承認済みかつ配信中のバージョンがないアプリケーションでは、これらのフラグが true であっても、パフォーマンス系エンドポイントは許可された種別が空のリストとともに INVALID-TYPE エラーを返します。

エラー​

コードHTTP ステータス説明対処方法
—401 UnauthorizedAPI キーが認識されませんでしたキー、およびアカウントが承認済みかを確認してください
SUBSCRIPTION-REQUIRED402 Payment Requiredアクティブなアカウントサブスクリプションがありませんアカウントのサブスクリプションを有効化してください
DAILY-QUOTA-REACHED429 Too Many Requests1 日のリクエスト上限を超過しましたUTC 午前 0 時に上限がリセットされた後に再試行してください