プログラミング PR

【Keepa APIの使い方】公式レファレンスを日本語訳してみました【Retrieve Token Status】

Keepa APIのリクエストの1つ、「Retrieve Token Status」の公式レファレンスを日本語訳しました。

現在のトークン情報を取得するだけなので面白みはないですが、APIを使用したツール作成時にはお世話になると思います。

Keepa APIのトークンの仕様を知りたい方はこちらの記事をご参考ください。

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

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

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

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

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

リクエストの基本情報

消費トークン

0トークン(トークン消費無し)

現在のトークンのステータスを取得します。

リクエストのQueryパラメータ

/token?key=<yourAccessKey>
  • <yourAccessKey>
    APIキー

リクエストのレスポンス

応答には、他のすべての API 要求と同様に、現在の API アクセスに関する情報が含まれます。

"refillRate": Integer,
"refillIn": Integer,
"tokensLeft": Integer,
"tokenFlowReduction": Double,
"tokensConsumed": Integer
  • refillRate:
    1 分あたりに生成されるトークンの数。
  • refillIn:
    トークン バケットが補充されるまでのミリ秒単位の時間 (毎分発生)。
    ※筆者注
    次に回復するまでの時間であり、トークンが満杯になるまでの時間ではないことに注意!!
    毎分発生するので、最大1分 = 60,000msec の値になります。
  • tokensLeft:
    現在残っているトークンの数。
    リクエストが送信されたときに正のトークン残高がある限り、リクエストは常に実行されるため、この値は負になる可能性があります。
  • tokenFlowReduction:
    tracked productsに基づくトークン フロー削減率。
    API を介して製品を追跡すると、実際のトークン補充率がこの値 (整数に四捨五入) だけ減少します。
  • tokensConsumed:
    このリクエストが消費したトークンの数。

例えばトークン10トークンしか残っていないときに、100トークン必要なリクエストを実行した場合、リクエストは正常に実行されトークン残高が-90になります。

できるだけ一度に多くのリクエストを送りたい場合は、残トークンが少ない状態から一気に多くのトークンを消費するリクエストを送るのが良いです。

以上です!