指標のプラットフォーム対応状況（API）

LabelGrid 公開 API 経由でストリーミングアナリティクスをリクエストし、単一のプラットフォームで絞り込むと、レスポンスはそのプラットフォームがリクエストした指標を実際に提供しているかどうかを示します。これにより、統合側で「まだデータがない」と「このプラットフォームはこの指標を提供していない」を区別できます。

availability フィールド

任意のアナリティクスリクエストにプラットフォームフィルター（例: filter[platform]=SPOTIFY）を追加すると、レスポンスには通常の data の隣に availability フィールドが含まれます。

• available — プラットフォームがこの指標を提供しています。data は通常どおり値が入ります。
• not_available_for_platform — プラットフォームがこの指標を提供していません。data は空で返されます。これはエラーではなく想定どおりの動作です。

availability フィールドは、単一のプラットフォームで絞り込んだ場合にのみ表示されます。プラットフォームフィルターのないリクエストは、availability キーなしで、従来どおり data を返します。

data の形は変わりません。availability はその隣に追加されるため、既存の統合は変更なしでそのまま動作します。

単一指標のエンドポイント

各単一アナリティクスエンドポイントは、data の隣にトップレベルの availability 値を 1 つ返します。

{
  "availability": "not_available_for_platform",
  "data": []
}

アナリティクスサマリーのエンドポイント

/アナリティクス/summary エンドポイントは複数のセクションを一度に返します。セクションごとに 1 エントリを持つ並列の availability マップを含むため、プラットフォームがどのセクションを提供し、どのセクションが空で返るかを判別できます。

{
  "availability": {
    "streams": "available",
    "listeners": "available",
    "streams_by_country": "available",
    "streams_by_gender": "available",
    "streams_by_age": "available",
    "saves": "not_available_for_platform"
  },
  "data": { }
}

どのプラットフォームがどの指標を提供するか

プラットフォーム（filter[platform]）	提供される指標
SPOTIFY	すべてのアナリティクス指標
APPLE_MUSIC（ITUNES も使用可能）	ストリーム数、リスナー数、国別ストリーム数、性別別ストリーム数、年齢別ストリーム数

Apple Music の場合、このリストにない指標は空の data とともに not_available_for_platform を返します。Spotify はすべてのアナリティクス指標を提供します。

統合での扱い方

• 空の data を「アクティビティなし」とみなす前に、availability を確認してください。not_available_for_platform を伴う空の結果は、プラットフォームがその指標をまったく提供していないことを意味します。
• /アナリティクス/summary で複数の指標を一度にリクエストする場合は、セクションごとに availability マップの対応するキーを確認してください。
• プラットフォームで絞り込まない場合、availability フィールドはありません。レスポンスは、従来どおり全プラットフォームを合算したビューになります。

関連

• API の概要 — 認証、エンドポイント、および完全なリファレンス
• アナリティクス — アナリティクスダッシュボードと各タブの表示内容