プログラミング PR

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

  /

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

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

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

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

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

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

概要

追跡オブジェクトは価格監視を表します。

ロケールに関係なく、ASIN ごとに存在できる追跡オブジェクトは 1 つだけです。
単一の追跡オブジェクトに、すべてのロケールの希望価格を含めることができます。

追跡オブジェクトには、TrackingThresholdValue と TrackingThresholdIf という 2 つの子オブジェクトがあります。

※筆者注 TrackingThresholdIf → TrackingNotifyIf が正しいっぽいです。
下記ではTrackingThresholdIオブジェクトは出てこないので。

Tracking Objectを返すリクエスト

Tracking Products リクエスト

Tracking ProductsはKeepaのトラッキング機能を使用するAPIです。
※トラッキング機能はASINの価格が指定した条件を満たした際に通知する機能

トラッキングはKeepaのWebサイトからも設定できますが、WebサイトとAPIのトラッキングは独立しており、登録上限などは共有していないようです。

詳しくは下記記事で解説しています。

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

レスポンスの形式

Tracking object の形式

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

asin

追跡対象商品 ASIN 例: B00M0QVG3W

createDate

追跡の作成日 (Keepa Time minutes)。

isActive

追跡がアクティブかどうか。

対応する API アカウントの料金が十分に支払われなくなった場合、追跡は自動的に無効になります。

ttl

追跡の有効期限が切れて削除されるまでの存続時間 (時間単位)。
追跡オブジェクトを取得するときは、createDate を基準とします。

可能な値:

  • 任意の正の整数: 生存時間 (時間単位)
  • 0: 有効期限はありません

expireNotify

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

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 文字)。

ユーザー参照やメモなどのテキストをこの追跡に割り当てるために使用されます。

trackingListName

この追跡オブジェクトが属する追跡リストの名前 (最大長は 64 文字)。

thresholdValues

すべてのロケールの価格または値に関連する追跡基準のすべての設定が含まれます。

後述の TrackingThresholdValue を参照してください。

notifyIf

すべてのロケールの在庫切れなど、特定のメタ追跡基準が含まれます。

後述のTrackingNotifyIf を参照してください。

notificationType

どのチャネルを通じて通知を送信するかを決定します。

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

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

重要：
当社の Tracking API は現在、プッシュ Webhook または API プル リクエストを介した通知のみをサポートしています。
他のチャンネルもすぐに続きます。

notificationCSV

この追跡に関する過去の通知の履歴。過去の各通知は、次の形式の 5 つのエントリで構成されます。

[AmazonLocale, Product.CsvType, NotificationType, TrackingNotificationCause, KeepaTime]

individualNotificationInterval

追跡固有のリアーム タイマー。
このトピックの詳細については、ここを参照してください。
※筆者注 rearm timerは指定価格に達した場合、アラートを一定間隔で再通知する機能です。

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

TrackingThresholdValueの形式

価格または価値に関連する追跡基準のすべての設定が含まれます。
フォーマット：

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

thresholdValueCSV

しきい値（または希望価格）の履歴。

形式: KeepaTime、値

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