プロダクト・トレンド・アナリティクスAPI
重要: 必要なパラメーターのみコールしてください。弊社は、多くのアプリケーションやクライアントを同時にサポートするAPIのセットを使用しています。これらのAPIは随時更新または改善される場合があります。
https://qa-gateway.richrelevance.com/mvt-api/datatrends/
注記: URLには環境(ゲートウェイ、ステージング・ゲートウェイ、又はQAゲートウェイ)、バージョン、及びパラメーターが必要です。URLリスエストの例については以下を参照してください。
OAuth署名
POST {baseUrl}/oauth2/token
提供されたクライアン証明書を使用して認証を行い、Authorization Bearer Tokenをリクエストしてください。他のエンドポイントへのアクセスを可能にするトークンを得るためには/oauth2/tokenエンドポイントを最初にコールしてください。弊社サイドからはclient_idとclient_secretを使用して送られます。このAPIからのレスポンスにはクライアントのトークンが含まれます。このトークンはマニュアルで無効にしない限り有効です。レスポンスはJSONとして提供されます。
商品APIおよびカタログAPIへのすべてのリクエストでは「Authorization: bearer MY_TOKEN」を送信してください。トークンの有効期限が切れた場合は、client_idとclient_securityを使用して新しいトークンを再取得してください。
名称 | 必須 / オプション | 説明 |
---|---|---|
grant_type | 必須(文字列) | アクセス用のトークン・タイプです。 必ずclient_credentialsです。 |
client_id | 必須(文字列) | クライアントのIDです。 |
client_secret | 必須(文字列) |
パートナーに代わりクライアントのアプリケーションを認証する一意のキーです。 例: clientSecret=wbhz6c41 |
例
正しいレスポンス:
{ "token_type": "bearer", "access_token": "AABBCCDD" }
エラー・レスポンス:
{ "error_description": "Invalid client authentication", "error": "invalid_client" }
または
{ "error_description": "Invalid grant_type", "error": "unsupported_grant_type" }
リアルタイム・プロダクト・トレンド
レポート・タイプ: productTrends
手法: GET
パラメーター:
注記: パラメーター名はすべて大文字小文字を区別します。
名称 | 必須 / オプション | 入力 | 説明 |
---|---|---|---|
timeWindow | 必須 | 数値 | 時間枠を分で表します。有効な入力: 15、30、60、240、480、720 |
trendType | 必須 | 文字列 | 有効な入力: clicks、views、purchases |
例:
curl -H 'Authorization: bearer tokenGeneratedFromTheAboveStep'
"Accept: application/json"
\
-H "Content-Type: application/json"
-X GET 'https://gateway.richrelevance.com/mvt-api/datatrends/?timeWindow=15&trendType=views'
レスポンス例
{ "siteId": 338, "reportType": "Last30MinsTopProdPurchReport", "topProducts": [ { "id": 2933934308, "externalId": "prod191580033", "name": "Anti-Aging Rapid Response Booster, Packette", "brand": "La Prairie", "imageId": "www.neimanmarcus.com/product_assets/C/2/3/J/T/NMC23JT_mh.jpg", "count": 19, "trend": 0, "trendList": [ 1, 1, 2, 6, 8, 11, 11, 11, 12, 13 ], "salePrice": 0, "discount": "0%" } ] }
レスポンス・パラメーター
名称 | 例 | 説明 |
---|---|---|
id |
2933934308 |
内部商品IDです。 |
externalID |
prod191580033 |
クライアントから提供される商品カタログIDです。 |
name |
Anti-Aging Rapid Response Booster, Packette |
クライアントから提供される商品名です。 |
brand | La Prairie | 商品の割り当てられたブランドです。クライアントから提供されます。 |
imageId | wms.com/product_assets/C/2/3/J/T/NMC23JT_mh.jpg | 商品カタログで提供される商品の画像です。 |
count |
19 |
特定の時間枠内に発生する指標のリクエストの回数です。 |
trend | 0 | 商品の販売傾向を、上向き = 1、下降気味= ?、変化なし = 0で表します。 |
trendList | 1, 1, 2, 6, 8, 11, 11, 11,12,13 |
特定の時間枠内でリクエストされた指標のデータ・ポイントです。これらのデータ・ポイントを使いスパークラインを表示できます。 |
salePrice | 0 | カタログに記載されている商品のセール価格です。現時点では実際に購入可能なセール価格を表していないので注意してください。 |
discount | 0% | カタログに記載されている商品の割引率です。現時点では実際に購入可能な割引率を表していないので注意してください。 |