Ranklet4

JSON API ​

INFO

JSON API は法人プランまたは専有プランでご利用いただけます。無料プランでは利用できません。

JSON API を利用すると、ランキングのデータを JSON 形式で取得し、Web サーバー側で独自にレンダリングすることで、自由なランキング表示を実装できます。

API の有効化 ​

  1. ランキングの編集画面でAPIタブを選択します
  2. このランキングのJSON APIを公開するのトグルスイッチを有効にします
  3. 必要に応じてフィルタリングオプションを設定します
  4. ランキングを保存・公開します

エンドポイント ​

ランキングの JSON データは以下の URL で取得できます。

法人プラン ​

https://pro.ranklet4.com/widgets/{ランキングID}.json

専有プラン ​

https://{専用ドメイン}/widgets/{ランキングID}.json

ランキング ID は、ランキング編集画面の API タブで確認できます。エンドポイント URL の横にあるCopyボタンでクリップボードにコピーできます。

レスポンス形式 ​

JSON API は以下のようなランキングレコードの配列を返します。

json
[
  {
    "rank": 1,
    "url": "https://example.com/page1",
    "title": "ページタイトル",
    "description": "ページの説明文",
    "thumbnailUrl": "https://...",
    "rawImageUrl": "https://...",
    "metric": 12345,
    "rankletMeta": {}
  },
  {
    "rank": 2,
    "url": "https://example.com/page2",
    "title": "ページタイトル2",
    ...
  }
]

各フィールドの説明 ​

フィールド説明
rank順位
urlページの URL
titleページのタイトル
descriptionページの説明文
thumbnailUrlサムネイル画像の URL
rawImageUrl元の代表画像の URL
metricページビュー数（設定で除外可能）
rankletMetaRanklet メタデータ

フィルタリングオプション ​

ページビュー（メトリック）を含める ​

トグルスイッチでレスポンスに PV 数（metricフィールド）を含めるかどうかを制御できます。

除外するプロパティ ​

レスポンスから除外したいプロパティ名を 1 行に 1 つずつ入力します。

rawImageUrl
description
rankletMeta

上記の例では、rawImageUrl、description、rankletMetaフィールドがレスポンスから除外されます。

API レスポンスプレビュー ​

画面右側のプレビューパネルで、現在の設定でのレスポンス内容をリアルタイムに確認できます。

注意事項 ​

  • API の JSON データは認証なしで誰からでもアクセスできる状態で公開されます。ただし、公開される内容はウィジェットに表示されるデータと同一です。
  • API で取得したデータを独自に表示する場合、ランキングウィジェットのような表示数やクリック数の計測を Ranklet4 側で行うことはできません。

Copyright © 2025-2026 ideamans Inc.