Google App ScriptsでKeepa APIを使用するにあたり、公式レファレンスを日本語訳したので備忘録として記載しておきます。
普段はGoogle翻訳でページ丸ごと変換していますが、Keepaのサイトの構成上うまく変換できなかったので。
公式レファレンスはこちらです。
それでは、↓から日本語訳スタートです！
- 「参考」で囲った部分は筆者の補足です。
- 適宜サブタイトルの追加や、意訳を実施しています。
- Keepaから翻訳の許可を頂いております。
こちら↓↓↓の記事に全てのKeepa APIに関する日本語訳記事をまとめているので、他のレファレンスも確認したい場合はご参考ください！
Keepa API リクエストの作り方
はじめに
JavaとPHPのクライアントを提供し、迅速な統合を実現しています。JavaやPHPを使用していない場合でも、洞察や例を得るために役立つことがあります。コミュニティ開発のPythonクライアントも利用可能です。
- Java
- PHP
- Python
上記3つは簡単にAPIを使用できるライブラリがあるよ、ということらしいです。
Java, PHP, Pythonを使用する場合は、ライブラリの使い方を検索したほうが簡単に使い始められると思います。
ただどの言語の場合も、リクエストする際に使用するトークンの仕様や、料金プランは確認しておいた方が良いです。
料金プランについて
価格プランの仕組みについてはこちらをご覧ください。
価格プランについては下記記事でも解説しているのでご参考ください。
リクエストの方法:
APIには、このカテゴリの個々のスレッドで説明されている多数のエンドポイントが用意されています。
- APIのURLは常に↓から始まります。
https://api.keepa.com/ - すべてのリクエストには、パラメータとしてAPIアクセスキーが必要です。アクセスキーはここで見つけて変更できます。
- すべてのリクエストはHTTPS GETとして発行され、gzipエンコーディングを受け入れる必要があります。可能な場合は、Keep-Alive接続を使用します。
- スループットを向上させるために、複数のリクエストを並行して行うことができます。
応答形式
応答は常にJSONです。すべてのレスポンスには、現在のAPIアクセスに関する情報が含まれています。
"refillRate": Integer,
"refillIn": Integer,
"tokensLeft": Integer,
"tokensConsumed": Integer,
"tokenFlowReduction": Double,
"error": {"type": String, "message": String, "details": String }- refillRate
アクティブなサブスクリプションによって生成されたトークンの数。 - refillIn
トークンバケットが補充されるまでの時間[ミリ秒単位] 。
(トークンは1分ごとに発生) - tokensConsumed
この要求が消費したトークンの数。 - tokenFlowReduction
APIを介して製品をトラッキングすると、実際のトークンの補充率がこの値 (整数に丸められた値) だけ減少します。 - error
エラー情報を含みます。エラーが発生した場合にのみ設定されます。エラーは、リクエスト全体が失敗したことを意味しません (バッチ要求など) 。
これらの情報を使用して、リクエストを計画できます。
未使用のトークンは60分後に期限切れになります。
トークンについては下記記事で詳しく解説しています！
応答可能なHTTPステータスコード:
- 200 – OK
要求は正常に実行されました。 - 400 – Bad Request
要求が不正な形式であるか、正常に実行できませんでした。 - 402 – Payment Required
使用したAPIキーでのアクセスは許可されていません。 - 405 – Method Not Allowed
要求パラメータが許容範囲外です。 - 429 – Too Many Requests
トークン不足です。 - 500 – Internal Server Error
このリクエストの実行中に予期しないエラーが発生しました。
200以外のステータスコードでも、エラーストリームでトークンバケット情報を受け取ります。
応答の残りの部分はさまざまであり、個々のスレッドで説明されています。
-以下を参照してください。
以上です！
肝心の個別のリクエストのレファレンスは、また別記事で紹介しています。
