本文へジャンプします。

ニフティクラウド APIリファレンス

ModifyImageAttribute

処理概要

指定したカスタマイズイメージの詳細情報を更新します。1回のリクエストで、1つのカスタマイズイメージの情報を更新できます。

カスタマイズイメージを指定するためには、イメージIDが必要です。削除済みのイメージIDを指定した、管理外のイメージIDを指定したなど、無効なイメージIDを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ImageId 更新対象のイメージID
Type : String
10021
Attribute 更新対象の項目名
Type : String
値 : description (メモを更新) | imageName (イメージ名を更新) | niftyContactUrl(問い合わせ先URLを更新) | detailDescription(説明を更新)
imageName
Value 更新値
Type : String
  customimage01
LaunchPermission.Add.n.UserId ※指定不可
Type : String
   
LaunchPermission.Remove.n.UserId ※指定不可
Type : String
   
LaunchPermission.Add.n.Group ※指定不可
Type : String
   
LaunchPermission.Remove.n.Group ※指定不可
Type : String
   
ProductCode.n ※指定不可
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
ModifyImageAttributeResponse ModifyImageAttribute レスポンス
Type : ModifyImageAttributeResponse
Ancestor : なし
Children : requestId
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : ModifyImageAttributeResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
return 更新ステータス
Type : xsd:boolean
値 : true(成功) | false(失敗)
Ancestor : ModifyImageAttributeResponse
Children : なし
True

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=ModifyImageAttribute&ImageId=10021&Attribute=imageName&Value=customimage01&CommonParams

応答サンプル

<ModifyImageAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <return>true</return>
</ModifyImageAttributeResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上