ユーザークリップの編集
クリップを編集するAPIについて説明します。
- 機能 :
- 指定されたクリップを編集します。
リクエストメソッド
GETまたはPOST
リクエストパラメータ
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| api_key | APIキー | APIを利用するためのキー（詳しくは@niftyクリップAPIキーについてを参照してください） | ○ | 文字列 | - |
| clip_id | クリップID | クリップの取得やクリップの検索で得られるクリップのIDです | △(※1) | 数値 | - |
| url | URL | 登録するURL | △(※1) | (※2) | - |
| title | クリップのタイトル | クリップのタイトル | - | (※2) | ページのタイトル |
| tag | タグ | クリップに付けるタグ。複数のtagを&で繋ぐことが可能です。 | - | (※2) | - |
| comment | コメント | クリップに付けるコメント | - | (※2) | - |
| public_flag | 他の人への公開 | 他の人に公開するかどうか。公開する場合は1、非公開にする場合は0を指定してください。 | - | 数値 | 1 |
| alt | フォーマット | 共通仕様の要求メッセージを参照してください | - | 文字列 | XML |
| callback | コールバック関数名 | 共通仕様の要求メッセージを参照してください | - | 文字列 | - |
※1）「clip_id」または「url」のどちらかを必ず指定してください。
※2）「URL」「クリップのタイトル」「タグ」「コメント」は文字列をUTF-8でURLエンコードしてください。
既存のクリップを編集する場合は、以下のURLにアクセスします。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
サンプルレスポンス
以下は、リクエストに対するレスポンスのサンプルです。
