ご利用マニュアル

Request 非公開化

作成者: レコメンドサポート担当|2021.11.01

アイテム情報の非公開化を行うAPIです。

Request 非公開化(type = hidden)

Request

アイテム情報の非公開化を行います。非公開化は即時反映されます。

非公開化は恒久的なもので、情報の更新(type = setitem)リクエストがあった場合でも、レコメンドに再表示されません。

パラメタ

要否

説明

type

必須

処理種別。非公開化の場合は hidden を指定

account

必須

アカウント名

recommend

必須

レコメンド名

codes

必須

アイテムコード文字列。カンマ区切りで複数指定可能

アイテムの再表示

  1. レコメンド管理画面「アイテム管理 > アイテム一覧」 より【非表示アイテム】を選択し、再表示したいアイテムを検索
  2. 該当アイテム「アイテムコード」を押下し、アイテム情報を開く
  3. 「非表示を取り消す」ボタンを押下

複数のアイテムをまとめて取り消しを行うことはできません。ご了承ください。

Headers

Content-Type: application/json
Authorization: bearer [アクセストークン]

Body

{
"type": "hidden",
"account": [アカウント名],
"recommend": [レコメンド名],
"codes": [アイテムコード,,,]
}

利用例

  1. ユーザ認証を実施して、access_token を取得してください
    "access_token": "187113305cfd78f0afe3dfeb94a3f6b0a1e7ae1410a96abaaa1965477dd4dc16"
  2. 以下のURLへPOSTでリクエストを送信してください
    https://api.rcmd.jp/connector/items/manage
    リクエストヘッダには以下をご指定ください。1で取得した access_token はここで利用します。
    Content-Type: application/json
    Authorization: bearer
    187113305cfd78f0afe3dfeb94a3f6b0a1e7ae1410a96abaaa1965477dd4dc16
    非公開化の場合は type に “hidden” をご指定ください。
    account にアカウント名、recommend にレコメンド名、codes に非表示化したいアイテムのコードを指定してください。
    {
    "type": "hidden",
    "account": "test_account",
    "recommend": "test",
    "codes": "item_code1, item_code2,,,,"
    }
  3. 成功の場合はリターンコード 200 が返却され、2で指定したアイテムコードのアイテムが非公開化されます。