ブックマーク管理
お知らせ
このドキュメントは機械翻訳で作成された下書きであり、現在レビュー中です。機械翻訳の特性上、一部の内容が不正確であったり、韓国語の原文と異なる場合があります。より正確な情報については、韓国語のド キュメントをご参照ください。
バージョン別機能範囲のご案内
- v1: ブックマーク関連機能はサポートしていません。
- v2: ブックマーク一覧照会機能のみ制限的にサポートしています。
- v3: 一覧照会機能の高度化に加え、ブックマークの追加・修正・削除機能が追加されました。
- 共通認証: すべてのバージョンの API は、クエリストリングパラメータ（
?access_token=）による共通認証方式を使用します。エラー判定基準に関する共通仕様は、API v3 マイグレーションガイドの 主要な変更点 セクションをご 参照ください。
v2 エラーレスポンス仕様（Laravel フレームワークスタイル）
v2 のブックマーク API のエラー処理は、HTTP 200 ステータスコードと内部に { "error": 1 } を返す一般的な VOD API とは異なります。以下の例のように、実際に対応する HTTP ステータスコードと具体的なエラーオブジェクト（{ message, errors }）構造を返します。
- 不正な
upload_file_keyの送信: HTTP 422 +{ "message": "The given data was invalid.", "errors": {...} } - 存在しない
client_user_idの送信: HTTP 404 +{ "message": "Record not found" }
ブックマーク一覧照会（アップロードファイルキー基準）
- 既存（v1）: 未サポート
- 既存（v2）:
GET/vod/bookmarks - 変更（v3）:
GET/media-contents/{upload_file_key}/bookmarks
変更点
- 識別子パラメータの位置変更: v2 でクエリパラメータとして渡していた
upload_file_keyが、v3 ではパスパラメータ形式に変更されました。 - レスポンスフィールドの追加: 一意の識別子（
id）と時間情報（created_at、updated_at）フィールドが追加されました。
リクエストパラメータおよびレスポンス構造の詳細
リクエストクエリパラメータ
v2 では同一エンドポイントで media_content_key による照会も可能でしたが、v3 では media_content_key をパスパラメータとして使用する別エンドポイント（/media-content-keys/{media_content_key}/bookmarks）が新設され、upload_file_key 基準の照会のみサポートされます。
- v2:
media_content_key、upload_file_key、client_user_id - v3:
client_user_id
レスポンス構造の比較
- v2
{
"data": [
{
"kind": 0,
"label": "bookmark_title",
"position": 1,
"value": "bookmark_content"
}
]
}
- v3
{
"data": [
{
"id": 1,
"kind": 0,
"label": "bookmark_title",
"position": 120,
"value": "bookmark_content",
"created_at": "2026-02-27T06:34:22+00:00",
"updated_at": "2026-02-28T06:34:22+00:00"
}
]
}
ブックマーク一覧照会（メディアコンテンツキー基準）
- 既存（v1/v2）: 未サポート（v2 は上記のアップロードファイルキー基準 API のクエリパラメータで機能を代替していました）
- 変更（v3）:
GET/media-content-keys/{media_content_key}/bookmarks
新機能のご案内
v3 で論理的に分離・新設されたエンドポイントです。識別子である media_content_key をパスパラメータとして使用し、ブックマーク一覧を照会します。
リクエストパラメータおよびレスポンス構造の詳細
リクエストクエリパラメータ
| パラメータ | データ型 | 必須 | 説明 |
|---|---|---|---|
client_user_id | String | 必須 | お客様のユーザーID |
レスポンス構造の仕様
レスポンス仕様は、ブックマーク一覧照会（アップロードファイルキー基準）のレスポンス構造と完全に同じです。
ブックマーク追加
- 既存（v1/v2）: 未サポート
- 変更（v3）:
POST/media-contents/{upload_file_key}/bookmarks
リクエストボディおよびレスポンス構造の詳細
ブックマーク修正
- 既存（v1/v2）: 未サポート
- 変更（v3）:
PUT/media-contents/{upload_file_key}/bookmarks/{bookmark_id}
リクエストボディおよびレスポンス構造の詳細
ブックマーク削除
- 既存（v1/v2）: 未サポート
- 変更（v3）:
DELETE/media-contents/{upload_file_key}/bookmarks/{bookmark_id}
レスポンス構造の詳細
レスポンス構造の仕様
{
"data": [],
"status": "ok"
}