Keepa APIのレスポンスの1つ、「Notification Object」の公式レファレンスを日本語訳しました。
商品の価格トラッキングをするAPIのレスポンスオブジェクトで、トラッキング通知に関する情報が含まれています。
それでは、↓から日本語訳スタートです！
- 「参考」で囲った部分は筆者の補足です。
- 適宜サブタイトルの追加や、意訳を実施しています。
- Keepaから翻訳の許可を頂いております。
こちら↓↓↓の記事に全てのKeepa APIに関する日本語訳記事をまとめているので、他のレファレンスも確認したい場合はご参考ください！
概要
Notice オブジェクトは価格アラートを表します。通知は 24 時間後に削除されます。
Notification Objectを返すリクエスト
Tracking Products のnotification request
Tracking ProductsはKeepaのトラッキング機能を使用するAPIです。
※トラッキング機能はASINの価格が指定した条件を満たした際に通知する機能
トラッキングはKeepaのWebサイトからも設定できますが、WebサイトとAPIのトラッキングは独立しており、登録上限などは共有していないようです。
詳しくは下記記事で解説しています。
Notification Objectを返すコマンド
※筆者注
Tracking Productsリクエストは、トラッキングを作成したり参照したり削除したりする複数のコマンド(call)で構成されています。
その内の一部がNotification Objectを返します。
- Get Notifications call
- API ページ で設定された URL への HTTP POST Webhook 呼び出し、または Set Webhook callによる
Notification Objectの形式
// Notification object
{
"asin": String,
"title": String,
"image": String,
"ttl": Integer,
"createDate": Integer,
"domainId": Integer,
"notificationDomainId": Integer,
"csvType": Integer,
"trackingNotificationCause": Integer,
"currentPrices": Integer array,
"sentNotificationVia": Boolean array,
"metaData": String,
"trackingListName": String
}asin
通知された商品ASIN。
例: B00M0QVG3W
title
製品のタイトル。
注意: まれに HTML マークアップが含まれる場合があります。
image
商品のメイン画像名。
Amazon イメージの完全なパス:
https://images-na.ssl-images-amazon.com/images/I/_image name_
createDate
通知の作成日 (KeepaTime minutes)。
domainId
追跡のメインの 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]
notificationDomainId
通知をトリガーし、この通知で提供される現在の価格の通貨を決定する Amazon ロケール。
Amazon ロケールの整数値。 可能な値:
可能な値: [ 1: com | 2: co.uk | 3: de | 4: fr | 5: co.jp | 6: ca | 8: it | 9: es | 10: in]
csvType
通知をトリガーしたPrice Type。
Product objectの csv フィールドを参照
Price Typeって何？
Amazonの価格や新品価格などの価格タイプのことです。
例えば、
- インデックス0(1番目) : Amazonの価格
- インデックス1(2番目) : 新品の価格
- インデックス2(3番目) : 中古のの価格
- インデックス3(4番目) : ランキング
といったように多数の情報が配列の形で含まれています。
その数、現状でも34種類!!
詳しく知りたい方は、下記記事一番最後の「csv」の項目をご確認ください。
trackingNotificationCause
通知の通知起因。
後述のTrackingNotificationCauseを参照してください。
currentPrices
この通知が作成された時点の製品の価格/値が含まれます。
Price Typeのインデックスを使用します (Product objectの csv フィールドを参照)。
※筆者注 Price Typeについては少し上にスクロールした所で解説しています。
価格は、それぞれの Amazon ロケールの最小通貨単位 (ユーロ セントや円など) の整数です。
指定された期間内にオファーがなかった場合 (在庫切れなど)、価格の値は -1 になります。
有効期限通知を追跡する場合は null です。
sentNotificationVia
この通知がどの通知チャネルを通じて配信されたかを示します。
NoticeType インデックスを使用します (下記を参照)。
True は、チャネルが使用されたことを意味します。
metaData
通知をトリガーした追跡オブジェクトのメタデータ。
trackingListName
追跡によってこの通知がトリガーされた追跡リストの名前 (最大長は 64 文字)。
TrackingNotificationCauseについて
通知の原因。
次の値が可能です。
- 0 – 期限切れ: 追跡の有効期限が切れました
- 1 – DESIRED_PRICE: 希望の価格/価値が初めて満たされました
- 3 – PRICE_CHANGE_AFTER_DESIRED_PRICE:
希望の価格/値がすでに一度満たされ、追跡が再設定された後に価格/値が変更されましたが (→ tracking creation object の IndividualNotificationInterval)、それ以降は希望のしきい値を超えていません。 - 4 – OUT_STOCK: 指定された価格タイプ (csvType) の製品は現在在庫切れです。
- 5 – IN_STOCK: 指定された価格タイプ (csvType) の製品が在庫に戻りました。
- 6 – DESIRED_PRICE_AGAIN: 値がしきい値を超え、追跡が再設定された後、希望の価格/値が再び満たされました。
NotificationTypeについて
利用可能な通知チャネル。
注: 現在、API 追跡には API のみが利用可能です。
5 – API: Webhook へのプッシュまたは API リクエストによるプル
Keepa Time minutesとは？
すべてのタイムスタンプに使用される時刻形式です。
圧縮されていないタイムスタンプ (Unix エポック時間) に変換するには、21564000 を加算してから 60000 を掛けます (ミリ秒の場合、または秒の場合は 60)。
以上です！
消費トークンなどリクエストの詳細については下記記事を参考にしてみてください。
