プログラミング PR

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

  /

Keepa APIのレスポンスの1つ、「Tracking Creation Object」の公式レファレンスを日本語訳しました。

商品の価格トラッキングをするAPIのレスポンスオブジェクトで、価格アラートのしきい値や更新間隔の情報などが含まれています。

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

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

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

【Keepa APIの使い方】公式レファレンス日本語訳のまとめ 当ブログで投稿してきたKeepa APIの公式レファレンス(英語)の日本語訳解説のまとめ記事です。 Google翻訳でページ一括...
目次
  1. 概要
  2. Tracking Creation Objectを返すリクエスト
  3. レスポンスの形式
  4. NotificationTypeについて

概要

tracking creation objectは、価格ウォッチを作成するために使用されます。

ロケールに関係なく、ASIN ごとに追跡できるのは 1 つだけです。

単一の追跡作成オブジェクトには、すべてのロケールの希望価格を含めることができます。

Tracking Creation Objectを返すリクエスト

 Add Trackingリクエスト

Add TrackingリクエストはTracking Productsという価格トラッキングに関するAPIリクエストにうちの1つです。

価格をトラッキングするASINを追加する機能を持っています。

詳しくは下記記事のAdd Trackingの項目をご参考ください。

【Keepa APIの使い方】公式レファレンスを日本語訳してみました【Tracking Products】 Keepa APIのリクエストの1つ、「Tracking Products」の公式レファレンスを日本語訳しました。 Keepaの...

レスポンスの形式

Tracking object の形式

// Tracking creation object
{
    "asin": String,
    "ttl": Integer,
    "expireNotify": Boolean,
    "desiredPricesInMainCurrency": Boolean,
    "mainDomainId": Integer,
    "updateInterval": Integer,
    "metaData": String,
    "thresholdValues": TrackingThresholdValue array,
    "notifyIf": TrackingNotifyIf array,
    "notificationType": Boolean array,
    "individualNotificationInterval": Integer
}

asin

追跡する商品の ASIN。

例: B00M0QVG3W

ttl

追跡の有効期限が切れて削除されるまでの存続時間 (時間単位)。

Add Trackingリクエストを通じて値を設定する場合、その値はリクエストの時刻を基準とします。
追跡オブジェクトを取得するときは、createDate を基準とします。

可能な値:

  • 任意の正の整数: 生存時間 (時間単位)
  • 0: 有効期限はありません
  • 任意の負の整数:
    • 追跡がすでに存在する場合: 元の ttl を維持します。
    • 追跡が新しい場合: ttl として絶対値を使用します。

expireNotify

追跡の有効期限が切れた場合、またはシステムによって削除された場合（製品が非推奨になった場合など）に通知をトリガーします。

desiredPricesInMainCurrency

すべての希望価格が mainDomainId の通貨で表示されているかどうかを示します。

false の場合、変換されます。

mainDomainId

この追跡のメインの Amazon ロケールで、希望するすべての価格に使用される通貨を決定します。

Amazon ロケールの整数値。
可能な値: [ 1: com | 2: co.uk | 3: de | 4: fr | 5: co.jp | 6: ca | 8: it | 9: es | 10: in | 11:com.mx]

updateInterval

システムが製品アップデートをトリガーする頻度を決定する更新間隔 (時間単位)。

1時間に設定すると、正確に 60 分ごとに更新がトリガーされるわけではありませんが、可能な限り効率的にそれに近くなります。

1日を通して 24 回更新されますが、更新は完全には配信されません。

可能な値: 0 と 25 の間の任意の整数。
※筆者注 文意から1~24の任意の整数と思われます。原文「between 0 and 25.」

metaData

このトラッキングのメタデータ (最大長は 500 文字)。

ユーザー参照やメモなどのテキストをこの追跡に割り当てるために使用されます。このフィールドはオプションです。

thresholdValues

すべてのロケールの価格または価値に関連した追跡基準の設定が含まれます。
後述の TrackingThresholdValue を参照してください。

このフィールドはオプションです。

notifyIf

すべてのロケールの在庫切れなど、特定のメタ追跡基準が含まれます。
後述の TrackingNotifyIf を参照してください。

このフィールドはオプションです。

notificationType

NoticeType 列挙型の長さのブール配列である必要があります (= 7、以下を参照)。

通知を送信するチャネルを決定します。

NoticeType インデックスを使用します (下記を参照)。

True は、チャネルが使用されることを意味します。

このフィールドはオプションであり、デフォルトでは Webhook 通知が設定されます。

重要事項

当社の Tracking API は現在、プッシュ Webhook または API プル リクエストを介した通知のみをサポートしています。

例: API 経由のみ通知: [ false、false、false、false、false、true、false ]

individualNotificationInterval

追跡固有のrearm timer。
詳細については、こちらをご覧ください
※筆者注 rearm timerは指定価格に達した場合、アラートを一定間隔で再通知する機能です。

  • -1 = ユーザー アカウントのデフォルトの通知タイマーを使用します (Web サイトの設定から変更可能)
  • 0 = 希望価格を複数回通知しない
  • 0 より大きい = x 分後に希望の価格を再通知します。

TrackingThresholdValueについて

価格または価値に関連した追跡基準の設定が含まれます。

形式：

// TrackingThresholdValue object
{
    "thresholdValue": Integer,
    "domain": Integer,
    "csvType": Integer,
    "isDrop": Boolean,
}

thresholdValue

しきい値 (または希望の価格)。

それぞれの Amazon ロケールの最小通貨単位 (ユーロ セントや円など) の整数として表されます。

domain

このしきい値が属する Amazon ロケールの整数値。

ロケールに関係なく、しきい値は常に mainDomainId の通貨で表されます。

可能な値: [ 1: com | 2: co.uk | 3: de | 4: fr | 5: co.jp | 6: ca | 8: it | 9: es | 10: in | 11:com.mx]

csvType

このしきい値のPrice Typeの整数値 (product objectの csv フィールドを参照)

Price Typeって何？

Amazonの価格や新品価格などの価格タイプのことです。
例えば、

  • インデックス0(1番目) : Amazonの価格
  • インデックス1(2番目) : 新品の価格
  • インデックス2(3番目) : 中古のの価格
  • インデックス3(4番目) : ランキング

といったように多数の情報が配列の形で含まれています。
その数、現状でも34種類!!

詳しく知りたい方は、下記記事一番最後の「csv」の項目をご確認ください。

【Keepa APIの使い方】公式レファレンスを日本語訳してみました【Product Object】 Keepa APIのレスポンスの1つ、「Product Object」の公式レファレンスを日本語訳しました。 商品情報を検索する...

isDrop

この追跡しきい値が値の低下を追跡するか (true)、値の増加を追跡するか (false) を示します。

TrackingNotifyIfについて

在庫切れなど、特定のメタ追跡基準が含まれます。

形式：

// TrackingNotifyIf object
{
    "domain": Integer,
    "csvType": Integer,
    "notifyIfType": Integer,
}

domain

この NotifyIf が属する Amazon ロケールの整数値。

可能な値: [ 1: com | 2: co.uk | 3: de | 4: fr | 5: co.jp | 6: ca | 8: it | 9: es | 10: in | 11:com.mx]

csvType

この NotifyIf のPrice Typeの整数値 (product objectの csv フィールドを参照)
※筆者注 Price Typeについては少し上にスクロールしたところで解説しています。

notifyIfType

利用可能な通知メタ トリガー タイプ。

可能な値:

  • 0: 在庫切れ
  • 1: 再入荷

NotificationTypeについて

利用可能な通知チャネル。

注: 現在、API 追跡には API のみが利用可能です。

5 – API: Webhook へのプッシュまたは API リクエストによるプル

Keepa Time minutesとは？

すべてのタイムスタンプに使用される時刻形式です。

圧縮されていないタイムスタンプ (Unix エポック時間) に変換するには、21564000 を加算してから 60000 を掛けます (ミリ秒の場合、または秒の場合は 60)。

以上です！

消費トークンなどリクエストの詳細については下記記事を参考にしてみてください。

【Keepa APIの使い方】公式レファレンスを日本語訳してみました【Tracking Products】 Keepa APIのリクエストの1つ、「Tracking Products」の公式レファレンスを日本語訳しました。 Keepaの...
Keepa
RELATED POST