パッケージ com.sdk.java.dmm.api.item

クラス ItemSearch


  • public class ItemSearch
    extends AbstractDmm<ItemSearchResult>

    商品検索を実行するためのクラスです。
    使用するにあたって下記の事項に注意してください。
    サイトは必須です。
    フロアが指定されている場合は、サービスは必須です。
    絞りこみ項目が指定されている場合は、絞り込みIDが必須です。

    下記は使用方法になります。

     ItemSearch itemSearch = new ItemSearch();
     itemSearch.setSite(Site.DMM);
     itemSearch.setService("digital");
     itemSearch.setFloor("video");
     ItemSearchResult result = itemSearch.execute();
     
    • フィールドの詳細

      • site

        private Site site
        サイト
      • service

        private String service
        サービス
      • floor

        private String floor
        フロア
      • hits

        private Integer hits
        取得件数
      • offset

        private Integer offset
        検索開始位置
      • keyword

        private String keyword
        キーワード
      • cid

        private String cid
        商品ID
      • article

        private Article article
        絞りこみ項目
      • articleId

        private String articleId
        絞り込みID
      • gteDate

        private LocalDateTime gteDate
        発売日絞り込み_以上
      • lteDate

        private LocalDateTime lteDate
        発売日絞り込み_以下
      • monoStock

        private MonoStock monoStock
        在庫絞り込み
    • コンストラクタの詳細

      • ItemSearch

        public ItemSearch​(String apiId,
                          String affiliateId)
        商品検索オブジェクトを生成します。
        パラメータ:
        apiId - API_ID
        affiliateId - AFFILIATE_ID
    • メソッドの詳細

      • setSite

        public ItemSearch setSite​(Site site)
        サイトを設定する。
        必須項目です。必ず設定してください。
        一般(DMM.com)かアダルト(FANZA)。
        パラメータ:
        site - サイト
        戻り値:
        ItemSearch
      • setService

        public ItemSearch setService​(String service)
        サービスを設定する。
        フロア検索APIから取得できるサービスコードを指定。
        例:digital
        パラメータ:
        service - サービス
        戻り値:
        ItemSearch
      • setFloor

        public ItemSearch setFloor​(String floor)
        フロアを設定する。
        フロア検索APIから取得できるフロアコードを指定。
        フロアを設定する場合は、サービスが必須です。
        例:videoa
        パラメータ:
        floor - フロア
        戻り値:
        ItemSearch
      • setSort

        public ItemSearch setSort​(ItemSearchSort sort)
        ソート順を設定する。
        初期値:RANK
        人気:RANK
        価格が高い順:PRICE_DESC
        価格が安い順:PRICE_ASC
        新着:DATE
        評価:REVIEW
        パラメータ:
        sort - ソート順
        戻り値:
        ItemSearch
      • setKeyword

        public ItemSearch setKeyword​(String keyword)
        キーワードを設定する。
        UTF-8で指定
        例:上原亜衣
        パラメータ:
        keyword - キーワード
        戻り値:
        ItemSearch
      • setCid

        public ItemSearch setCid​(String cid)
        商品IDを設定する。
        商品に振られているcontent_id
        例:15dss00145
        パラメータ:
        cid - 商品ID
        戻り値:
        ItemSearch
      • setArticle

        public ItemSearch setArticle​(Article article)
        絞りこみ項目を設定する。
        絞り込み項目を設定する場合は、絞り込みIDが必須です。
        女優:ACTRESS
        作者:AUTHOR
        ジャンル:GENRE
        シリーズ:SERIES
        メーカー:MAKER
        パラメータ:
        article - 絞りこみ項目
        戻り値:
        ItemSearch
      • setArticleId

        public ItemSearch setArticleId​(String articleId)
        絞り込みIDを設定する。
        絞り込み項目のIDは各検索APIから取得可能です。
        絞り込みIDを設定する場合は、絞り込み項目が必須です。
        例:1011199
        パラメータ:
        articleId - 絞り込みID
        戻り値:
        ItemSearch
      • setGteDate

        public ItemSearch setGteDate​(LocalDateTime gteDate)
        発売日絞り込みを設定する。
        このパラメータで指定した日付以降に発売された商品を絞り込むことができます。
        パラメータ:
        gteDate - 発売日絞り込み(以上)
        戻り値:
        ItemSearch
      • setGteDate

        public ItemSearch setGteDate​(String gteDate)
                              throws DmmIllegalArgumentException
        発売日絞り込みを設定する。
        このパラメータで指定した日付以降に発売された商品を絞り込むことができます。
        例:2019-05-26T21:50:10
        パラメータ:
        gteDate - 発売日絞り込み(以上)
        戻り値:
        ItemSearch
        例外:
        DmmIllegalArgumentException - 引数が不正な場合にスローされる
      • setLteDate

        public ItemSearch setLteDate​(LocalDateTime lteDate)
        発売日絞り込みを設定する。
        このパラメータで指定した日付以前に発売された商品を絞り込むことができます。
        パラメータ:
        lteDate - 発売日絞り込み(以下)
        戻り値:
        ItemSearch
      • setLteDate

        public ItemSearch setLteDate​(String lteDate)
                              throws DmmIllegalArgumentException
        発売日絞り込みを設定する。
        このパラメータで指定した日付以降に発売された商品を絞り込むことができます。
        例:2016-04-30T23:59:59
        パラメータ:
        lteDate - 発売日絞り込み(以上)
        戻り値:
        ItemSearch
        例外:
        DmmIllegalArgumentException - 引数が不正な場合にスローされる
      • setMonoStock

        public ItemSearch setMonoStock​(MonoStock monoStock)
        在庫絞り込みを設定する。
        初期値:絞り込みなし
        在庫あり:STOCK
        予約受付中:RESERVE
        DMM通販のみ:MONO
        マーケットプレイスのみ:DMP
        ※通販サービスのみ指定可能
        パラメータ:
        monoStock - 在庫絞り込み
        戻り値:
        ItemSearch
      • paramCheck

        private void paramCheck()
                         throws DmmIllegalParameterException
        パラメータの相関チェックを行う。
        入力値が不正な場合は、DmmIllegalParameterExceptionをスローする。
        例外:
        DmmIllegalParameterException - パラメータが不正な場合にスローされる