プログラミング PR

【Keepa APIの使い方】公式レファレンスを日本語訳してみました【有料プランの仕様】

Keepa APIの実行回数はトークンと呼ばれる要素で制限されています。

しかし、Keepaの有料プランをアップグレードすることで、その制限を緩くすることができます。
つまり、APIの実行回数=リサーチ速度を増加させることができるということです!

この記事ではKeepa APIの有料プランの仕様を開設した公式レファレンス「How our API Plans work」を日本語訳しながら解説していきます。

そもそも、トークンって何?という人はこちらの記事をご覧ください。

【Keepa APIの基本】トークンについて詳しく解説! Keepa APIを実行すると販売数やセラーID等、有用な情報を取得できます。 しかしながら、APIの実行回数はトークンと呼ばれ...

それでは、↓から日本語訳スタートです!

  • 「参考」で囲った部分は筆者の補足です。
  • 適宜サブタイトルの追加や、意訳を実施しています。
  • Keepaから翻訳の許可を頂いております。

こちら↓↓↓の記事に全てのKeepa APIに関する日本語訳記事をまとめているので、他のレファレンスも確認したい場合はご参考ください!

【Keepa APIの使い方】公式レファレンス日本語訳のまとめ 当ブログで投稿してきたKeepa APIの公式レファレンス(英語)の日本語訳解説のまとめ記事です。 Google翻訳でページ一括...

サブスクリプションの基本情報について

サブスクリプションの基本仕様

プランはすべて1ヶ月前払いで自動更新です*。

サブスクリプションはいつでもキャンセルできます。

トークン バケット アルゴリズム(wikipediaリンク)を介して API へのアクセスを制限します。
これにより、偶発的にすべてのリクエスト回数を使い果たすことがないため、プランの有効期間全体でリクエストのバーストと一定のレートのリクエストが可能になります。
※筆者注 「プログラムミスでうっかりリクエスト回数使い果たして以後しばらくつかえなくなっちゃった!」がないよということ。

プランは、1 分あたりに生成されるトークンの数によって区別されます。
未使用のトークンは 60 分後に期限切れになります。

*PayPal 経由でお支払いの場合、自動継続支払いはありません

サブスクリプションの例

1 分あたり 60 トークンのプランでは、毎分 60 トークンが生成されます。
各トークンは 60 分間有効であるため、トークン バケットの容量は 3600 トークンです。

トークンはユーザーがリクエストしているかに関わらず、24時間365日生成されます。

生成されたすべてのトークンを 31 日間のプランで使用すると、合計で 2,678,400 個の製品をリクエストできます。

一部の API リクエストでは、異なる量のトークンが必要です。
コストは後述するリストのとおりです。

トークンは60分間しか有効ではなく、APIリクエストしていない間も生成されます。

つまり、60分以上リクエストを実行しないとトークンが次々無駄になっていくということです。

そのため自己所有PCやVPSを使用して、リクエストを定期実行するプログラムを組むのが効率的にはベストです!

サブスクリプションの詳細について

キャンセル

サブスクリプションは、ダッシュボードからいつでもキャンセルできます。

キャンセルすると、サブスクリプション期間の終わりに終了することになります

キャンセルしたサブスクリプションを再度有効にすることはできません。
代わりに、新しいプランにサブスクライブする必要があります。

キャンセル=自動更新の停止 のようです。

つまり、キャンセルしても更新期間終了まではサブスクリプションが利用できます。

アップグレード/ダウングレード

プランを切り替えることで、サブスクリプションを変更できます。

サブスクリプション レベルはいつでもアップグレードできます。

ダウングレードも可能ですが、28 日に 1 回のみです。

新しいプランはすぐに有効になります。
請求サイクルは同じままで、アップグレードの場合は比例配分された金額がすぐに請求され、ダウングレードの場合は Keepa アカウントにクレジットが付与されます (返金不可)。

例:

毎月 1 日に請求が行われ、プランの請求サイクルのちょうど半分 (つまり、3 月 15 日) にサブスクリプションをアップグレードしたとします。

その場合、既存のプランの 10 ユーロの月額料金が既に請求されており、現在の請求サイクルの半分が使用されています。

新しいプランに切り替えると、コストが 25 ユーロ高くなり、以前のプランの未使用部分は 5 ユーロのクレジットになります。

請求サイクルの残りの期間 (つまり、3 月の残りの期間) の新しいプランの費用は 12.50 ユーロになります。

したがって、安価なプランから高価なプランへの切り替えの比例配分された合計コストは 7.50 EUR です。 この金額はすぐに請求されます。

大した内容ではないのですが、文字で説明されるとこんがらがってきますね…。

簡単に言うと、サブスクリプション期間中にグレード変更してもすぐ有効になるし、請求額も日割りなので、いつグレード変更してもOKということです。

よくある、「月末にグレード変更しないと損!」とかいう仕様でなくて好感度が高いです(笑)

サブスクリプションの複数契約

既存のサブスクリプションをアップグレードする代わりに、追加のプランを契約できます。

すべてのサブスクリプションは同時にアクティブになり、各サブスクリプションには独自の請求サイクルと請求情報がありますが、同じ支払い方法と API キーを共有します。

面白い仕様ですね。

例えば現状「20トークン/分」の次は「60トークン/分」で「40トークン/分」のプランはないですが、「20トークン/分」を2つ契約すれば疑似的に40トークンプランを実現できます。

APIキーも同じなのでプログラミング的な管理も楽!

一方請求サイクルは別になるようなので、支払管理には少しだけ注意です。
(同じ日付で契約すれば多少は管理が楽な気がします)

サブスクリプションの支払いについて

当社は、決済プロバイダー Stripe.comを通じてクレジット カードによる支払いを受け付けています。

お客様の完全なクレジット カード情報にアクセスすることはありません。

他の支払い方法が必要な場合は、info@keepa.com までご連絡ください。
割引はありません。

サブスクリプションの管理(ダッシュボード)

プランを購入するとAPI ページ で以下のことが実施できます。

  • API アクセスのステータスを表示
  • サブスクリプションを管理
  • 支払いと請求の詳細を変更
  • 新しい API アクセス キーを生成
  • 領収書を取得

利用可能なリクエスト一覧

レファレンスだけだとリクエストの役割が分からないので、簡単な説明を加えて表にまとめました。

こちらのリンクは、レファレンスを日本語訳して解説した当ブログ記事へのリンクです。

リクエスト名称リクエストの説明消費トークン
Request ProductsASINから販売数などの商品情報を検索1トークン~ / 1ASIN
Request Seller InformationセラーIDからセラー名や出品ASINを取得1~50トークン / 1セラー
Product Searchesキーワードから商品情報を検索10トークン / 40ASIN
Most Rated Sellers評価の高いセラーを抽出50トークン
Request Best SellersカテゴリIDからAmazonランキング上位の商品を抽出50トークン
Lightning DealsタイムセールのASINを抽出500トークン
Browsing DealsKeepaの値下げ商品データベースからASINを検索5トークン / 150ASIN
Product Finder販売数などの条件からASINを抽出10 + 1トークン/100ASIN
Graph Image APIKeepaのグラフ画像を取得1トークン / 1ASIN
Category LookupAmazonのカテゴリ名&IDを一覧化1トークン
Category SearchesキーワードからAmazonのカテゴリを検索1トークン
Retrieve Token Status現在の残トークン&回復レートを取得0トークン

以上です!