プレースメント・レポートAPI
重要: 必要なパラメーターのみコールしてください。弊社は、多くのアプリケーションやクライアントを同時にサポートするAPI一式を使用しています。これらのAPIは随時更新または改善される場合があります。
https://gateway.richrelevance.com/mvt-api/placements/v1'/
注記: URLには環境(ゲートウェイ、ステージング・ゲートウェイ、又はQAゲートウェイ)、バージョン、及びパラメーターが必要です。URLリスエストの例については以下を参照してください。
説明: このAPIを使用しプレースメントを追加、検証、削除できます。
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" }
プレースメント・レポート
例:
curl -H 'Authorization: bearer tokenGeneratedFromTheAboveStep'
"Accept: application/json" -H "Content-Type: application/json"
-X GET 'https://gateway.richrelevance.com/mvt-api/placementAnalytics/placements/v1/'
レスポンス例
{"date":"2018-09-23", "siteId":XXXX, "channelId":"all", "currency":"EUR", "region_id":"8851", "pageTypeName":"wish_list_page", "placementName":"recs_1", "views":3 "clicks":0, "items":0, "orders":0 "clkTruRate":0.0, "attrSales":0.0}
レスポンス・パラメーター
名称 | 例 | 説明 | |
---|---|---|---|
date |
2018-09-23 |
リクエストの日付です。 |
|
siteID |
1234 |
サイトに割り当てられたIDです。 |
|
channelID |
all, mobile |
指定されたチャネルのIDです。 |
|
currency | EUR | 結果に対し使用する通貨です。 | |
regionID | 9999 | 指定されたリージョンのIDです。 | |
pageTypeName |
item-page |
プレースメントが配置されているページ・タイプの名称です。 |
|
placementName | itemrecs_1 | データがリクエストされているプレースメントの名称です。 | |
views | 数値 | ビュー数です。 | |
clicks | 数値 | クリック数です。 | |
items | 数値 | レコメンデーションによる注文商品数です。 | |
orders | 数値 | レコメンデーションによる注文件数です。 | |
clkTruRate | 数値 | クリックスルー率です。 | |
attrSales | 数値 | リッチレリバンス売上寄与額(レコメンデーションによる売上の合計)です。 |