ミュージックサーチAPI仕様

【更新履歴】
2009/07/16

  • 出力項目にステータスを追加しました。

  • 2009/07/13
  • 出力項目に3キャリア共通リンクコードを追加しました。
  • 1. 検索方法

    下記URLへ必要なGETパラメータを付与しアクセスすることでXML情報を返却します。
    http://xml.accesstrade.net/at/ws.html

    2. 必須パラメータ

    パラメータ 備考
    ws_type searchdigital_atm APIタイプ、固定値です。
    ws_ver 1 バージョン、固定値です。
    ws_id ** 管理画面で取得したWS_ID

    3. 選択必須パラメータ

    ※何れか一つの指定が必須となります。
    ※genre -> genre1 誤りがあったため修正します。(2008/10/03)
    パラメータ 備考
    item_id 70098-123456 商品ID、カンマ区切りで複数指定が可能です。
    category 100 カテゴリー、カンマ区切りで複数指定が可能です。
    カテゴリー一覧を参照してください。
    genre1 300 ジャンル、カンマ区切りで複数指定が可能です。
    ジャンル一覧を参照してください。
    program_id 112345 プログラムID(マーチャントID)
    カンマ区切りで複数指定が可能です。
    search %e5%8d%92%e6%a5%ad
    (卒業)
    検索キーワード、UTF-8でエンコード
    item %e5%8d%92%e6%a5%ad
    (卒業)
    商品名、UTF-8でエンコード
    item_kana アイ 商品名の半角カナ文字、UTF-8でエンコード、前方一致検索
    item_eiji AI 商品名の半角英字(大文字)、前方一致検索
    singer %e3%82%86%e3%81%9a
    (ゆず)
    歌手名、UTF-8でエンコード
    singer_kana アイ 歌手名の半角カナ文字、UTF-8でエンコード、前方一致検索
    singer_eiji EX 歌手名の半角英字(大文字)、前方一致検索

    4. 任意パラメータ

    パラメータ名 パラメータ 設定例 備考
    form 公式/非公式 0 0:公式 1:非公式
    fee_u_max 単価上限 50 整数値指定、単価50円以下のデータが検索対象になります
    fee_u_min 単価下限 10 整数値指定、単価10円以上のデータが検索対象になります
    fee_m_max 月額上限 525 整数値指定、月額525円以下のデータが検索対象になります
    fee_m_min 月額下限 105 整数値指定、月額105円以上のデータが検索対象になります
    latest 最新フラグ 1 整数値指定、0:旧作 1:新作
    carrier キャリア 111 整数値指定。左桁より,docomo,au,softbank
    1:対応,0:非対応
    row 1ページ内件数 5 1~30の範囲で指定可能、整数値指定
    page 指定ページ 2 2ページ目以降の明細を取得する際に指定、指定なしの場合は1ページが表示される。
    sort1 ソート 1 整数値指定 ソート一覧参照

    5. 出力項目

    ※genre -> genre1 誤りがあったため修正します。(2008/10/03)
    パラメータ名 設定値 内容
    AllResult - 検索結果タグ
    Request - 入力パラメータの結果タグ
    ws_type searchdigital_atm サービスタイプ(固定値:必須)
    ws_ver 1 サービスバージョン(固定値:必須)
    ws_id 入力値 パートナーID(WS_ID:必須)
    item_id 入力値 一意なKEY
    form 入力値 0:公式/1:非公式
    category 入力値 カテゴリー(※カテゴリ一覧参照
    genre1 入力値 ジャンル(※ジャンル一覧参照
    fee_u_min 入力値 単価下限
    fee_u_max 入力値 単価上限
    fee_m_min 入力値 月額下限
    fee_m_max 入力値 月額上限
    vol - ※未使用
    latest 入力値 0:旧作 1:新作
    issue - ※未使用
    carrier 入力値 0:非対応 1:対応(docomo,au,softbank)
    program_id 入力値 プログラムID
    search 入力値 検索キーワード
    item 入力値 商品名
    item_kana 入力値 商品名カナ
    item_eiji 入力値 商品名ABC
    singer 入力値 歌手名
    singer_kana 入力値 歌手名カナ
    singer_eiji 入力値 歌手名ABC
    author - ※未使用
    author_kana - ※未使用
    author_eiji - ※未使用
    paint - ※未使用
    paint_kana - ※未使用
    paint_eiji - ※未使用
    row 入力値 表示件数
    page 入力値 表示ページ
    sort1 入力値 ソート
    TotalCount 検索結果の数
    TotalPage 検索結果の総ページ数
    CurrentCount 現在のページに含まれる検索数
    CurrentPage 現在のページ
    ErrorCode エラーコード
    ErrorMsg エラーメッセージ エラーがあればメッセージが表示される。
    Digital - デジタルタグ
    ItemId 検索結果 商品ID(ユニークキー)
    ItemName 検索結果 商品名
    ItemNameKana 検索結果 商品名カナ
    ItemNameEiji 検索結果 商品名ABC
    ServiceName 検索結果 サービス名
    Formal 検索結果 0:公式/1:非公式
    Category 検索結果 カテゴリーID
    CategoryName 検索結果 カテゴリー名
    Genre1 検索結果 ジャンル1
    GenreName1 検索結果 ジャンル名1
    Genre2 検索結果 ジャンル2
    GenreName2 検索結果 ジャンル名2
    Genre3 検索結果 ジャンル3
    GenreName3 検索結果 ジャンル名3
    FeeUnit 検索結果 単価
    FeeMonthly 検索結果 月額
    Author 検索結果 ※未使用
    AuthorKana 検索結果 ※未使用
    AuthorEiji 検索結果 ※未使用
    Paint 検索結果 ※未使用
    PaintKana 検索結果 ※未使用
    PaintEiji 検索結果 ※未使用
    Publisher 検索結果 ※未使用
    Volume 検索結果 ※未使用
    Singer 検索結果 歌手名
    SingerKana 検索結果 歌手名カナ
    SingerEiji 検索結果 歌手名ABC
    Ranking 検索結果 ランキング
    LatestFlag 検索結果 最新フラグ(0:旧作 1:新作)
    IssueFlag 検索結果 発行前フラグ(0:発行済み 1:発行前)
    ImageUrl 検索結果 商品画像URL
    Width 検索結果 横サイズ
    Height 検索結果 縦サイズ
    LinkCode 検索結果 3キャリア共通リンクコード(docomo,au,softbank対応)
    LinkCode_I 検索結果 リンクコード(i-mode)
    LinkCode_E 検索結果 リンクコード(ezweb)
    LinkCode_S 検索結果 リンクコード(softbank)
    Carrier_I 検索結果 i-mode対応状況(0:未対応 1:対応)
    Carrier_E 検索結果 ezweb対応状況(0:未対応 1:対応)
    Carrier_S 検索結果 softbank対応状況(0:未対応 1:対応)
    CatchCopy 検索結果 キャッチコピー
    Explanation 検索結果 説明文
    RewardType 検索結果 報酬タイプ(0:クリック 1:定額 2:売上)
    RewardRate 検索結果 報酬率
    Reward 検索結果 報酬額
    Status 検索結果 ステータス(2:提携中)
    ProgramId 検索結果 プログラムID
    ProgramName 検索結果 プログラム名
    Description 検索結果 プログラム概要
    • レスポンスデータには,未入力の項目もありますので事前に取得した結果を確認してください。

    6. 検索例

    ws_idは管理画面で取得されたws_idに置き換えてください。

    ■ カテゴリー:(500)着うた(R)フルで、商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchdigital_atm&ws_id=****&category=500

    ■ カテゴリー:(500)着うたフル(R)で、歌手名カナ:アイで商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchdigital_atm&ws_id=****&category=500&singer_kana=%EF%BD%B1%EF%BD%B2


    カテゴリー一覧

    7. カテゴリー

    カテゴリーID カテゴリー名
    100 デジタルコンテンツ(※未使用)
    200 電子書籍(※未使用)
    300 着うた(R)
    400 着メロ(R)
    500 着うたフル(R)


    ジャンル一覧

    8. ジャンル

    ジャンルID ジャンル名
    300 ロック
    301 ヒップホップ
    302 ソウル・R&B
    303 ジャズ
    304 フォーク
    305 Jポップ
    306 レゲエ
    307 クラシック
    308 アニメ
    309 サウンドトラック
    310 演歌


    ソート一覧

    9. ソート条件

    ソート項目
    商品名(昇順) 1
    商品名カナ(昇順) 2
    商品名ABC(昇順) 3
    報酬額(降順) 4
    カテゴリーID(昇順) 5
    プログラムID(昇順) 6
    ランキング(昇順) 7
    ランダム検索 8
    歌手名カナ(昇順) 9
    歌手名ABC(昇順) 10


    ※「着うた(R)」「着うたフル(R)」は株式会社ソニー・ミュージックエンタテインメントの登録商標です
    TOPへ |  ATMWSサンプルの使用について |  API仕様 |  絵文字一覧 |  ダウンロード