service/userProfile
重要: 必要なパラメーターのみコールしてください。弊社は、多くのアプリケーションやクライアントを同時にサポートするAPIのセットを使用しています。これらのAPIは随時更新または改善される場合があります。
https://recs.richrelevance.com/userProfile/api/v1/service/userProfile/APIKEY/USERID
URLが正しく機能するためにはAPIキートパラメータが必要です。URLリスエストの例については以下を参照してください。
説明: ユーザーのプロファイル情報を返します。
OAuth署名
User Profile Serviceリクエストには標準のOAuth 1.0署名アルゴリムズによる署名が必要です。.
OAuth実装に使用されるほとんどの言語には数多くのライブラリーがあります。以下の例ではサインポスト・ライブラリーを使用していますが、お使いのライブラリを使用してください。
|
クライアントAPIキー及びシークレット
クライアント・キーやクライアント・シークレットを作成する際には、弊社担当者までお問い合わせください。clientApiKeyはclientSecretはclientApiKeyに対する特定の値でダッシュボードから確認できますが、Eメールか電話でお知らせします。
client_secretは安全に保管してください。絶対に他者と共有せず、HTTPSでのみ使用してください。
アクセス用のトークン
ライブラリによってはaccessTokenやaccessTokenSecretの値が必要です。お使いのライブラリでこれらの値が必要な場合は、この値を空白にしてください。
パラメーター
注記: パラメーターはすべて大文字小文字を区別します。
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| apiKey | 必須 | |
| userId | 必須 | |
| fields | 必須 |
返される、カンマ区切りのプロファイル・フィールドのサブセット一覧です。幾つかのフィールドについては以下で詳細に説明していますが、ここで一覧表示されている内容は参照用です。このフィールドの既定値は以下のとおりです。 itemViews,purchases 値を「all」にすると以下のすべてのフィールドを返します。
|
リクエスト例
/userProfile/api/v1/service/userProfile/de89fba2959239b2/1870225?field=all |
apiキーがde89fba2959239b2のサイトのインスツルメンテーション・イベントのユーザー1870225に対しすべてのフィールドを返します。
/userProfile/api/v1/service/userProfile/de89fba2959239b2/1870225?field=viewedItems,clickedItems |
apiキーがde89fba2959239b2のサイトのインスツルメンテーション・イベントのユーザー1870225に対しビュー及びクリック・イベントを返します。
/userProfile/api/v1/service/userProfile/de89fba2959239b2/*?rrUserGuid=414c617d-ba8b-4735-90c9-9c526ac2fee5&field=viewedItems,clickedItems |
apiキーがde89fba2959239b2のサイトのインスツルメンテーション・イベントのユーザー1870225に対しrrUserGuid 414c617d-ba8b-4735-90c9-9c526ac2fee5と一緒に確認されたビュー及びクリック・イベントを返します。
レスポンス
{ "userId": "john123b", "mostRecentRRUserGuid": null, "timeOfFirstEvent": 1419150606233, "referrerUrls": [ { "sessionId": "session1", "timestamp": 1419150617261, "url": "ref2" }, { "sessionId": "session1", "timestamp": 1419150616261, "url": "ref1" } ], "userSegments": [ { "sessionId": "session1", "timestamp": 1419150628318, "segments": [ "seg3", "seg1" ] }, { "sessionId": "session1", "timestamp": 1419150627318, "segments": [ "seg2" ] } ], "userAttributes": [ { "sessionId": "session1", "timestamp": 1419150628318, "values": { "attr": [ "val3", "val4" ], "attr2": [ "val5", "val6" ] } }, { "sessionId": "session1", "timestamp": 1419150626277, "values": { "attr": [ "val1", "val2" ] } } ], "verbNouns": [ { "sessionId": "session1", "timestamp": 1419150619265, "verb": "v2", "noun": "na1" }, { "sessionId": "session1", "timestamp": 1419150618261, "verb": "v1", "noun": "n1" } ], "viewedItems": [ { "sessionId": "session1", "timestamp": 1419150607260, "itemId": "viewProduct2" }, { "sessionId": "session1", "timestamp": 1419150606233, "itemId": "viewProduct1" } ], "viewedCategories": [ { "sessionId": "session1", "timestamp": 1419150609261, "categoryId": "viewCategory2" }, { "sessionId": "session1", "timestamp": 1419150608261, "categoryId": "viewCategory1" } ], "viewedBrands": [ { "sessionId": "session1", "timestamp": 1419150611261, "brand": "viewBrand2" }, { "sessionId": "session1", "timestamp": 1419150610261, "brand": "viewBrand1" } ], "clickedItems": [ { "sessionId": "session1", "timestamp": 1419150613261, "itemId": "click2" }, { "sessionId": "session1", "timestamp": 1419150612261, "itemId": "click1" } ], "searchedTerms": [ { "sessionId": "session1", "timestamp": 1419150615261, "searchTerm": "search2" }, { "sessionId": "session1", "timestamp": 1419150614261, "searchTerm": "search1" } ], "addedToCartItems": [ { "sessionId": "session1", "timestamp": 1419150623266, "items": [ { "itemId": "la1", "quantity": 4, "priceInCents": 3001 }, { "itemId": "la2", "quantity": 7, "priceInCents": 4002 } ] }, { "sessionId": "session1", "timestamp": 1419150622266, "items": [ { "itemId": "l1", "quantity": 3, "priceInCents": 1001 }, { "itemId": "l2", "quantity": 6, "priceInCents": 2002 } ] } ], "orders": [ { "sessionId": "session1", "timestamp": 1419150625270, "items": [ { "itemId": "pla1", "quantity": 4, "priceInCents": 3001 }, { "itemId": "pla2", "quantity": 7, "priceInCents": 4002 } ] }, { "sessionId": "session1", "timestamp": 1419150624266, "items": [ { "itemId": "pl1", "quantity": 3, "priceInCents": 1001 }, { "itemId": "pl2", "quantity": 6, "priceInCents": 2002 } ] } ], "countedEvents": [ { "value": "e1", "count": 3, "mostRecentTime": 1419150628318 }, { "value": "e2", "count": 1, "mostRecentTime": 1419150626277 } ]} |
| フィールド | 説明 |
| userId | プロファイルに使用するクライアント指定のユーザーIDです。 |
| mostRecentRRUserGuid | このプロファイルで見られた直近のrrUserGuidです。異なるデバイス間でのクッキーの同期に使用することができます。 |
| timeOfFirstEvent | このプロファイルに対し最初に記録されたイベントの時刻です。過去の時刻が廃棄されるため、この時刻は必ずしもプロファイル内のイベント・リストから回収可能なものではありません。 |
| viewedItems | 当該ユーザーの直近のitemView（アイテム閲覧）イベントの一覧です。通常は、クライアントのウェブサイトのアイテム・ページでのユーザーの閲覧内容と一致しています。イベント毎にsesshonId、itemId（外部ID）、イベントのタイプスタンプを返します。 |
| clickedItems | 当該ユーザーが直近でクリックしたレコメンデーション・アイテムのID一覧です。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| searchedTerms | 当該ユーザーが直近の検索で使用した文字列の一覧です。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| viewedCategories | 当該ユーザーの直近のcategoryView（カテゴリー閲覧）イベントの一覧です。通常は、クライアントのカテゴリー・ページでの閲覧内容と一致しています。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| viewedBrands | 当該ユーザーの直近のbrandView（ブランド閲覧）イベントの一覧です。通常は、クライアントのブランド・ページでの閲覧内容と一致しています。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| addedToCartItems | 当該ユーザーの直近のcartAdd（カートに追加）イベントの一覧です。イベント毎にitemId、数量、priceInCentsを記録します。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| orders | 当該ユーザーの直近の購入イベントの一覧です。イベント毎にitemId、数量、priceInCentsを記録します。viewedItemsでは、sesshonIdとtimestampは同じ意味になります。 |
| userSegments | インスツルメンテーションで確認された当該ユーザーの直近のユーザー・セグメントの一覧です。このフィールドには直近のセグメントを先頭に確認されたセグメントが返されます。 |
| userAttributes | インスツルメンテーションで確認された直近のユーザー属性値の組み合わせの一覧です。 |
| verbNoun | インスツルメンテーションで確認された直近の動詞/名詞イベントの一覧です。 |
| countedEvents | インスツルメンテーションで確認された直近のカウント対象イベントの一覧です。確認された回数と直近のイベントの時刻が含まれます。 |