IMAGE (商品画像)
- YSAPI
-
IMAGE 商品画像
- yImageApi 商品画像に関するAPI
- yItemImageInfo 商品画像/追加画像情報クラス
yImageApi
商品画像に関するAPI(ImageAPI)の機能を利用するためのクラスです。
メソッド
- ySellingApi New( ref yAuth auth, string seller_id = "" )
- コンストラクタ
- auth
- YConnect認証クラス (参照渡し)
- seller_id
- Yahoo!ショッピング sellerId
- XmlDocument itemImageList(string stcat_key="",string query="",int start=1,int results=25,string sort= "+name")
- 商品画像一覧API
- stcat_key
- ストアカテゴリのページキーを指定します
- query
- 画像名に対して文字検索を行う際に検索ワードを指定します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- sort
- 一覧のソート項目を指定します
name : ファイル名
file_size : ファイルサイズ
upload_date : 更新日時
項目の前に以下の記号を付与することで、昇順降順を変更可能です - Return
- XMLデータ
- XmlDocument itemImageListAll(string stcat_key="",string query="",string sort= "+name")
- 商品画像一覧API (全件取得)
- stcat_key
- ストアカテゴリのページキーを指定します
- query
- 画像名に対して文字検索を行う際に検索ワードを指定します
- sort
- 一覧のソート項目を指定します
name : ファイル名
file_size : ファイルサイズ
upload_date : 更新日時
項目の前に以下の記号を付与することで、昇順降順を変更可能です - Return
- XMLデータ
- XmlDocument uploadItemImage(string filePath,string fileName)
- 商品画像アップロードAPI
- filePath
- 画像ファイルパス
- fileName
- 商品画像：商品コード.拡張子
商品詳細画像：商品コード_(1-5).拡張子
※拡張子は、jpg または gif - Return
- XMLデータ
- XmlDocument uploadItemImagePack(string filePath)
- 商品画像一括アップロードAPI
- filePath
- zipファイルを指定します
- Return
- XMLデータ
- XmlDocument deleteItemImage(string image_id)
- 商品画像削除API
- image_id
- カンマ","区切りで複数画像を削除することができます。（最大100件）
- Return
- XMLデータ
- XmlDocument libImageList(string directory="",string query="",int start=1,int results=25,string sort= "+name")
- 追加画像一覧API
- directory
- 追加画像ディレクトリ名を指定します
- query
- 画像名に対して文字検索を行う際に検索ワードを指定します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- sort
- 一覧のソート項目を指定します
name : ファイル名
file_size : ファイルサイズ
upload_date : 更新日時
項目の前に以下の記号を付与することで、昇順降順を変更可能です - Return
- XMLデータ
- XmlDocument libImageListAll(string directory="",string query="",string sort= "+name")
- 追加画像一覧API (全件取得)
- directory
- 追加画像ディレクトリ名を指定します
- query
- 画像名に対して文字検索を行う際に検索ワードを指定します
- sort
- 一覧のソート項目を指定します
name : ファイル名
file_size : ファイルサイズ
upload_date : 更新日時
項目の前に以下の記号を付与することで、昇順降順を変更可能です - Return
- XMLデータ
- XmlDocument uploadLibImagePack(string filePath, string directory= "パーツ")
- 追加画像一括アップロードAPI
- filePath
- zipファイルを指定します
- directory
- 追加画像ディレクトリ名を指定します
- Return
- XMLデータ
- XmlDocument deleteLibImage(string file_name)
- 追加画像削除API
- file_name
- カンマ","区切りで複数ファイルを削除することができます。（最大100件）
- Return
- XMLデータ
- XmlDocument libDirectoryList()
- 追加画像ディレクトリ一覧API
- Return
- XMLデータ
- XmlDocument addLibDirectory(string directory)
- 追加画像ディレクトリ登録API
- directory
- 追加画像ディレクトリ名を指定します
- Return
- XMLデータ
- XmlDocument moveLibDirectory(string file_name,string directory= "パーツ")
- 追加画像ディレクトリ変更API
- file_name
- 追加画像ファイル名を指定します
- directory
- 移動先の追加画像ディレクトリ名を指定します
- Return
- XMLデータ
- XmlDocument deleteLibDirectory(string directory)
- 追加画像ディレクトリ削除API
- directory
- 削除する追加画像ディレクトリ名を指定します
- Return
- XMLデータ
イベント
- void ItemImageListStartEventHandler(object sender, yListStartEventArgs e)
- 商品画像一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントオブジェクト)
- void ItemImageListRowEventHandler(object sender, yListRowEventArgs e)
- 商品画像一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントオブジェクト)
- void ItemImageListCompleteEventHandler(object sender, yListCompleteEventArgs e)
- 商品画像一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントオブジェクト)
- void LibImageListStartEventHandler(object sender, yListStartEventArgs e)
- 追加画像一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントオブジェクト)
- void LibImageListRowEventHandler(object sender, yListRowEventArgs e)
- 追加画像一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントオブジェクト)
- void LibImageListCompleteEventHandler(object sender, yListCompleteEventArgs e)
- 追加画像一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントオブジェクト)
yItemImageInfo
商品画像/追加画像情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- itemImageList/libImageListで取得したXML(/ResultSet/Result)
プロパティ
- string Id
- 画像ID（ストアアカウント_画像名の拡張子除く文字列）
- string Name
- 画像名
- Hashtable Url
- 画像URL（反映状態の画像を参照するURL） 未反映状態の画像は空になります
画像表示モードごとのURL Url['A']～Url['L'] - string Size
- オリジナル画像の横×縦サイズ
- int FileSize
- オリジナル画像のファイルサイズ（バイト数）
- Nullable<DateTime> UploadDate
- 更新日
- Nullable<DateTime> PublishDate
- 反映日
- int EditingFlag
- 編集フラグ 0 : 反映済み, 1 : 編集されてからフロント反映されていない状態
2017/06/17