オークション

販促イベント検索

リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V1/saleCampaign

ヤフオク!の販促イベントデータを提供します。

リクエストパラメータ

RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
appid(必須) string アプリケーションのIDです。詳細はこちらをご覧ください。
output string XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
  • xml :xmlレスポンス(デフォルト)
  • php :PHPserializeレスポンス
  • json :JSONPレスポンス
(※PHPserialize、JSONP専用のエントリポイントは今後、非推奨となります。こちらのリクエスト指定をご利用ください。)
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
affiliate_type string yid(Yahoo! JAPANアフィリエイト)とvc(バリューコマースアフィリエイト)の選択
  • yid :Yahoo! JAPANアフィリエイト
  • vc :バリューコマースアフィリエイト
affiliate_id string アフィリエイトIDを入力します。
  • affiliate_type=yidの時 :Yahoo! JAPANアフィリエイトID
  • affiliate_type=vcの時 :バリューコマースアフィリエイトID
event_type string 取得したい販促情報の種類を指定します。 ( , 区切りで複数選択可能)
  • sale :セール
  • campaign :キャンペーン
  • special :特集
  • topics :トピックス
event_id integer 結果リストに含まれるイベントIDによる絞り込み検索 ( , 区切りで複数選択可能)
sort string 販促イベント情報の並べ替えを指定します。
  • score :おすすめ順
  • date :日付順
start integer データ取得の開始位置です(デフォルト値は1)。
results integer 検索結果の取得件数です。デフォルト・最大値共に50となります。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/saleCampaign?appid=<あなたのアプリケーションID>&results=10


レスポンスフィールド

販促イベント検索APIのスキーマの記述は、以下になります。

フィールド説明
/ResultSet クエリーレスポンスのすべてを含み、以下の属性を持ちます。

  • totalResultsAvailable:該当件数の総個数です。
  • totalResultsReturned:返された値の個数です。
  • firstResultPosition:最初のデータが何個目に当たるかです。

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Event 各個別販促イベント情報レスポンスを含みます。
/ResultSet/Result/Event/EventCode イベントコードです。
/ResultSet/Result/Event/EventTitle 販促イベント名です。
/ResultSet/Result/Event/EventType 販促イベント情報の種類です。
/ResultSet/Result/Event/PcUrl 販促イベント情報ページへのURLまたはアフィリエイトURLです。(PC版)
/ResultSet/Result/Event/SpUrl 販促イベント情報ページへのURLまたはアフィリエイトURLです。(スマートフォン版)
/ResultSet/Result/Event/MbUrl 販促イベント情報ページへのURLまたはアフィリエイトURLです。(モバイル版)
/ResultSet/Result/Event/EventTerm/Start 販促イベント情報公開開始時期(RFC)です。
/ResultSet/Result/Event/EventTerm/End 販促イベント情報公開終了時期(RFC)です。
/ResultSet/Result/Event/Image 販促用画像情報です。
/ResultSet/Result/Event/Image/ImageUrl 画像のURLです。
/ResultSet/Result/Event/Image/Width 画像の幅です。
/ResultSet/Result/Event/Image/Height 画像の高さです。
/ResultSet/Result/Event/Description 販促イベント情報詳細です。
/ResultSet/Result/Event/Description 販促イベント情報詳細です。
/ResultSet/Result/Event/GenreName 販促対象の商品カテゴリです。
/ResultSet/Result/Event/Target 販促の対象ユーザの分類です。
/ResultSet/Result/Event/Target/TargetCategory 販促の対象ユーザの利用者区分です。

  • 0:出品&落札者
  • 1:出品者
  • 2:落札者

/ResultSet/Result/Event/Target/TargetSex 販促の対象ユーザの性別です。

  • 0:男性
  • 1:女性
  • 2:両方

/ResultSet/Result/Event/Target/TargetAge 販促の対象ユーザの年代です。(カンマ区切りで複数選択)

  • 1:10代
  • 2:20代
  • 3:30代
  • 4:40代
  • 5:50代
  • 6:60代

/ResultSet/Result/Event/Target/TargetHml 販促の対象ユーザのターゲット区分です。(カンマ区切りで複数返却)

  • 0:ライトユーザー
  • 1:ミドルユーザー
  • 2:ヘビーユーザー

/ResultSet/Result/Event/DeviceFlag デバイス選択フラグです。(カンマ区切りで複数返却)

  • 0:PC
  • 1:スマホWeb
  • 2:スマホアプリ
  • 3:タブレットWeb
  • 4:タブレットアプリ




サンプルレスポンス

<ResultSet firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
  <Result>
    <Event>
      <EventTitle>至高のプレミアム酒を手に入れよう!</EventTitle>
      <EventType>special</EventType>
      <PcUrl>
        <![CDATA[http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/]]>
      </PcUrl>
      <SpUrl>
        <![CDATA[http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/]]>
      </SpUrl>
      <MbUrl>
        <![CDATA[http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/]]>
      </MbUrl>
      <EventTerm>
        <Start>2013-11-16 00:00:00</Start>
        <End>2013-11-30 24:00:00</End>
      </EventTerm>
      <Image>
        <ImageUrl>
          <![CDATA[ http://i.yimg.jp/images/auct/salespromotion/2013_2/0909_premiumalcohol/320x200.png ]]>
        </ImageUrl>
        <Width>320</Width>
        <Height>200</Height>
      </Image>
      <Description>ビール、ワイン、ブランデーなどのお酒と、秋の味覚をご紹介します。</Description>
      <GenreName>食品、飲料</GenreName>
      <Target>
        <TargetCategoly>0</TargetCategoly>
        <TargetSex>2</TargetSex>
        <TargetAge>2,3,4,5,6</TargetAge>
        <TargetHml>0,1,2</TargetHml>
      </Target>
      <DeviceFlag>0,1,2,3,4</DeviceFlag>
    </Event>
  </Result>
</ResultSet>

サンプルレスポンス(PHPserialize)

a:1:{
  s:9:"ResultSet";
  a:4:{
    s:19:"firstResultPosition";
    s:1:"1";
    s:21:"totalResultsAvailable";
    s:3:"1";
    s:20:"totalResultsReturned";
    s:1:"1";
    s:6:"Result";
    a:2:{
      s:5:"Event";
      a:10:{
        s:10:"EventTitle";
        s:16:"至高のプレミアム酒を手に入れよう!";
        s:9:"EventType";
        s:4:"special";
        s:5:"PcUrl";
        s:26:"http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/";
        s:5:"SpUrl";
        s:26:"http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/";
        s:5:"MbUrl";
        s:26:"http://topic.auctions.yahoo.co.jp/sale_campaign/food_drink/premium_liquor/";
        s:9:"EventTerm";
        a:2:{
          s:5:"Start";
          s:19:"2013-11-16 12:00:00";
          s:3:"End";
          s:19:"2013-11-30 24:00:00";
        }
        s:5:"Image";
        a:10:{
          i:0;
          a:3:{
            s:8:"ImageUrl";
            s:27:"http://i.yimg.jp/images/auct/salespromotion/2013_2/0909_premiumalcohol/320x200.png";
            s:5:"Width";
            s:3:"320";
            s:6:"Height";
            s:3:"200";
          }
        }
      }
      s:11:"Description";
      s:16:"ビール、ワイン、ブランデーなどのお酒と、秋の味覚をご紹介します。";
      s:9:"GenreName";
      s:18:"食品、飲料";
      s:6:"Target";
      a:4:{
        s:14:"TargetCategoly";
        s:1:"0";
        s:9:"TargetSex";
        s:1:"2";
        s:9:"TargetAge";
        s:11:"2,3,4,5,6";
        s:9:"TargetHml";
        s:1:"0,1,2";
      }
      s:10:"DeviceFlag";
      s:9:"0,1,2,3,4";}
    }
  }
}

サンプルレスポンス(JSONP)

loaded({
  "ResultSet":{
     "@attributes":{
       "firstResultPosition":"1",
       "totalResultsAvailable":"1",
       "totalResultsReturned":"1"
      },
      "Result":{
        "Event":{
          "EventTitle":"%u81F3%u9AD8%u306E%u30D7%u30EC%u30DF%u30A2%u30E0%u9152%u3092%u624B%u306B%u5165%u308C%u3088%u3046%uFF01",
          "EventType":"sale",
          "PcUrl":"http:\/\/topic.auctions.yahoo.co.jp\/sale_campaign\/food_drink\/premium_liquor\/",
          "SpUrl":"http:\/\/topic.auctions.yahoo.co.jp\/sale_campaign\/food_drink\/premium_liquor\/",
          "MbUrl":"http:\/\/topic.auctions.yahoo.co.jp\/sale_campaign\/food_drink\/premium_liquor\/",
          "EventTerm":{
            "Start":"2013-11-01 18:40:08",
            "End":"2013-11-30 18:40:08"
          },
          "Image":[{
            "ImageUrl":"http:\/\/topic.auctions.yahoo.co.jp\/sale_campaign\/food_drink\/premium_liquor\/",
            "Width":"320",
            "Height":"200"
          }],
          "Description":"%u30D3%u30FC%u30EB%u3001%u30EF%u30A4%u30F3%u3001%u30D6%u30E9%u30F3%u30C7%u30FC%u306A%u3069%u306E%u304A%u9152%u3068%u3001%u79CB%u306E%u5473%u899A%u3092%u3054%u7D39%u4ECB%u3057%u307E%u3059%u3002",
          "GenreName":"%u98DF%u54C1%u3001%u98F2%u6599",
          "Target":{
            "TargetCategoly":"0",
            "TargetSex":"0",
            "TargetAge":"2,3,4,5,6",
            "TargetHml":"0,1,2"
          },
          "DeviceFlag":"0,1,2,3,4"
        }
      }
    }
  }
)



エラー

販促イベント検索はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。




利用制限

※このWeb APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)

※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)

まずはヘルプページのお問い合わせフォームからご相談ください。