楽天API：R-Cabinetフォルダ一覧取得
akinoriR-Cabinetのフォルダ一覧を取得するAPI
R-Cabinetのフォルダ一覧を取得するAPI。
楽天APIではRMSやCSV更新と違いフォルダ名は使わずフォルダIDを利用し指示する事になります。このAPIでは【フォルダID】を取得できるため、画像の登録/更新/削除を行うためにとても重要なパーツとなります。
APIメソッド：cabinet.folders.get
この機能を利用すると、フォルダの一覧を取得することができます。
フォルダの登録、更新、削除後の情報が本機能の取得情報に反映されるまでの時間は最短10秒です。
ページング機能(offset, limit)を用いて情報取得している時にはフォルダの登録、更新、削除はお控えください。情報が正しく取得できない場合があります。
Endpoint / HTTP Method
| Endpoint | HTTP Method |
|---|---|
| https://api.rms.rakuten.co.jp/es/1.0/cabinet/folders/get | GET |
Request
HTTP Header
| No | Key | Value | Note |
|---|---|---|---|
| 1 | Authorization | ESA Base64(serviceSecret:licenseKey) | |
Query parameters
| No | Parameter | Description | Type | Mandatory | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | offset | 検索結果取得ページ数 | Integer | 0,1 | 1を基準値とした検索結果取得ページ数 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を10に設定した場合 offset=1、limit=10 → 1件目～10件目のデータを取得する offset=2、limit=10 → 11件目～20件目のデータを取得する offset=3、limit=10 → 21件目～30件目のデータを取得する 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を20に設定した場合 offset=1、limit=20 → 1件目～20件目のデータを取得する offset=2、limit=20 → 21件目～40件目のデータを取得する offset=3、limit=20 → 41件目～60件目のデータを取得する |
|
| 2 | limit | 検索結果取得上限数 | Integer | 0,1 | 検索結果の1ページあたりの取得上限数 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を10に設定した場合 offset=1、limit=10 → 1件目～10件目のデータを取得する offset=2、limit=10 → 11件目～20件目のデータを取得する offset=3、limit=10 → 21件目～30件目のデータを取得する 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を20に設定した場合 offset=1、limit=20 → 1件目～20件目のデータを取得する offset=2、limit=20 → 21件目～40件目のデータを取得する offset=3、limit=20 → 41件目～60件目のデータを取得する ※値は100まで指定可能です。 |
Response
HTTP Header
| No | Key | Value |
|---|---|---|
| 1 | Content-Type | text/xml |
HTTP Body
XML:result
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | result.status | ステータス | XML:status | - | 1 | interfaceId=cabinet.folders.get |
| 2 | result.cabinetFoldersGetResult | フォルダ内画像情報取得結果 | XML:cabinetFoldersGetResult | - | 1 |
XML:cabinetFoldersGetResult
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | cabinetFoldersGetResult.resultCode | 結果コード | Integer | 4 | 1 | |
| 2 | cabinetFoldersGetResult.folderAllCount | 全フォルダ数 | Integer | 5 | 1 | |
| 3 | cabinetFoldersGetResult.folderCount | 返却フォルダ数 | Integer | 5 | 1 | |
| 4 | cabinetFoldersGetResult.folders | フォルダ情報リスト | XML:folders | - | 1 |
XML:folders
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | folders.folder | フォルダ情報 | XML:folder | - | 1 ... n | |
XML:folder
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | folder.FolderId | フォルダID | Integer | 10 | 1 | |
| 2 | folder.FolderName | フォルダ名 | String | 50 | 1 | |
| 3 | folder.FolderNode | フォルダノード | Integer | 1 | 1 | 1 or 2 or 3 |
| 4 | folder.FolderPath | フォルダパス | String | 153 | 1 path1/path2/path3 区切り文字は"/"です。 |
|
| 5 | folder.FileCount | 格納画像数 | Integer | 10 | 1 | |
| 6 | folder.FileSize | フォルダ内の画像の合計サイズ (KB) | Decimal | 10,3 ※少数点第3位まで |
1 | |
| 7 | folder.TimeStamp | フォルダ更新日時 | DateTime | 19 | 1 | |
＼ 最新情報をチェック ／
初めまして。R-Cabinetのフォルダ一覧を取得するAPIは販売されていますでしょうか？
現在は実験中ということで弊社店舗のみで実験稼働をさせておりますが、画像サムネイル取得機能を実装しております。
フォルダの一覧であれば。この機能の拡張で対応できると思われます。
具体的にどのような情報の取得を必要とされているか教えて頂けますでしょうか。
現在の認識では、フォルダの一覧 = フォルダ名のリスト ととらえておりますが、その認識で良かったでしょうか。
下記情報を頂けますと、弊社の機能で足りるか判断できますので、お手数をおかけいたしますが情報提供をお願いいたします。
・R-Cabinetの契約タイプ ※容量追加をしているか否か
・取得したい内容に画像は含むか
・取得したいフォルダ一覧はCabinetの全体か一部か
・商品画像のフォルダ構成にルールはあるか
共に、プログラミングの方法によって動作速度が大きく変わる項目です。
お手数をおかけいたしますが、ご回答いただけますと幸いです。
また、現在弊社アプリをモニターしていただける方を探しております。
ご利用いただく中で、バグも含め、不便なところや追加してほしい機能など多々ご要望が出てくるものと思います。
追加してほしい機能につきましては、どう実装していくかご相談させていただきながら実装可否の判断をいたします。
モニターいただける方には、そういった弊社のこれから作る追加機能も含め、初期費用なし月間1万円(税別)で永続的にご提供させていただきたいと考えています。
※モニター参加は50社ほどにしたいと考えております。
また、現在は私の周りの方のみモニターしていただいている状態のため、マニュアルの準備が整っておりません。
その為、アプリのお渡しまで1か月程度頂く可能性がございます事、ご了承ください。
ご質問ありがとうございました。