openapi: 3.0.0 info: x-logo: url: https://cms.millvi.com/logo.svg altText: Millvi logo href: https://help.millvi.jp/hc/ja/articles/18887828836505 description: > millvi VOD API は millvi VOD プラットフォームを外部アプリケーションから利用できるプログラミングインターフェースです。コンテンツや変換レシピといった、動画配信に必要なリソースを簡単に扱うことができ、迅速に高品質な動画配信を行うことが出来ます。 # ご利用方法について millvi API は、CRM API と VOD API に分かれており、それぞれ担う機能が異なります。CRM API では、契約情報や利用量に関わる部分を提供しており、当APIではコンテンツ管理に関わる部分の機能のみを提供しております。 コンテンツ管理を実行するためには、配信者の認証情報（Bearer Token）が必要となります。詳しくは下記の[認証情報](#section/認証情報について)を参照ください。 # API利用における注意事項 - 短時間でのループ処理で負荷をかけるようなタスクはご遠慮ください。弊社側で高負荷の検知があった場合、利用方法についてご相談させていただく場合があります。 - 本APIドキュメントに記載されている仕様以外の設定では正しく動作しないことがあります。 # 共通仕様 ### 異常系 API がエラーになった場合、以下のようにエラーコードとエラーメッセージが返ってきます。
詳細については[エラーコード](#tag/error)をご参照ください。 ``` { "errorCode": "MVOD_CMN_0005", "reason": "必須パラメーターが存在しません。[param_name]" } ``` # 認証情報について リクエストヘッダー情報に、トークンをご利用ください。 当APIでは、Bearer Token (OAuth2.0) を採用しています。
CRM API 側で、配信者用のトークンを取得していただき、そのトークンをこちらのAPIでご利用ください。 ※配信者用トークンの取得方法は[こちら](https://docs.millvi.com/webapi/crm/index.html#tag/dist_token) リクエストヘッダー情報に、トークンをご利用ください。 ``` curl -H GET "https://${end_point}/vod/end_point" \ -H "Authorization: Bearer {access_token}" ``` title: millvi VOD API contact: name: カスタマーサクセス部 email: support@millvi.jp url: https://millvi-cs.com/support/ servers: - url: https://api.millvi.com/vod tags: - name: contents x-displayName: コンテンツ description: コンテンツ管理で利用するAPIについて記述します。 - name: subtitle_service x-displayName: 字幕 description: | 字幕管理で利用するAPIについて記述します。
字幕は動画コンテンツにのみ利用可能です。 ### 注意事項 設定可能な字幕開始・終了時刻の最大値は、それぞれ99時間59分59秒998と99時間59分59秒999になります。
字幕データの追加・編集・削除操作の途中でエラーが発生した場合は、成功した範囲の操作はロールバックされずに反映されます。 - name: chapter_service x-displayName: チャプター description: | チャプター管理で利用するAPIについて記述します。
チャプターは動画コンテンツにのみ利用可能です。 ### 注意事項 設定可能なチャプター開始・終了時刻の最大値は、それぞれ99時間59分59秒998と99時間59分59秒999になります。 - name: file_upload_service x-displayName: アップロード description: > ファイルのアップロードで利用するAPIについて記述します。 ### 注意事項 一時アップロード先に保存したデータは、アップロード完了から2日間使用できます。2日経過すればアップロードしたファイルは削除されますので、アップロードURL取得APIのレスポンスに含まれるkeyを利用して、各種管理系APIで適切に処理を実施して下さい。 - name: recipes x-displayName: レシピ description: > レシピ管理で利用するAPIについて記述します。
レシピとはコンテンツ変換時のエンコード設定を指します。
標準で以下のレシピが準備されています。標準で準備されているレシピは編集/削除ができません。 | recipe_id | category | name | audio_bit_rate | video_bit_rate | width x height | frame_rate | | :---: | :---: | :---: | ---: | ---: | ---: | ---: | | 1 | video | 高画質 | 128000
128000
128000 | 8000000
4500000
2000000 | 2560x1440
1920x1080
1280x720 | 30
30
30 | | 2 | video | 標準 | 128000
128000 | 2000000
1000000 | 1280x720
854x480 | 30
30 | | 3 | video | 低画質 | 128000
96000 | 1000000
500000 | 854x480
640x360 | 30
30 | | 4 | audio | 音声標準 | 96000 | - | - | - | - name: embedkey x-displayName: Embedキー description: > Embedキーを取得するAPIについて記述します。
Embedキーはコンテンツ視聴のために必要な情報をハッシュ化した値となります。Embedキーを適切な形式でプレイヤーに渡すことで、コンテンツを視聴することができます。 - name: batch x-displayName: バッチ処理 description: バッチ処理 - name: player x-displayName: プレイヤー description: | コンテンツの視聴に利用するAPIについて記述します。 ### 注意事項 APIのドメインが管理用APIとは異なります。 - name: usage x-displayName: 利用量取得 description: 転送量・ストレージ取得 - name: secret_key_service x-displayName: セキュリティ管理 description: | セキュリティ管理に利用するAPIについて記述します。 - name: private_contents x-displayName: コンテンツ系その他 description: 非公開のコンテンツ系API - name: preview x-displayName: 簡易視聴ページ description: 簡易視聴ページに利用するAPIについて記述します。 - name: iframe x-displayName: iframe description: 視聴用のiframeで利用するAPIについて記述します。 - name: player_customization_service x-displayName: プレイヤーカスタマイズ description: | プレイヤーのカスタマイズに利用するAPIについて記述します。
標準で以下のプレイヤーが準備されています。標準で準備されているプレイヤーは編集/削除ができません。 | player_id | player_type | player_name | | :---: | --- | --- | | 1 | video | デフォルトVIDEOプレイヤー | | 2 | pdf | デフォルトPDFプレイヤー | | 3 | audio | デフォルト音声プレイヤー | - name: contents_security_service x-displayName: コンテンツセキュリティ設定 description: > コンテンツセキュリティ設定を管理するAPIについて記述します。
標準で以下のセキュリティ設定が準備されています。標準で準備されているセキュリティ設定は削除ができません。（編集は可能） | security_config_name | security_config_id | allowed_ip_address | allowed_domain | | :---: | --- | --- | --- | | デフォルト | null | null | null | - name: live_content_service x-displayName: ライブコンテンツ description: ライブコンテンツ管理で利用するAPIについて記述します。 - name: live_channel_service x-displayName: ライブチャンネル description: | ライブチャンネルで利用するAPIについて記述します。
ライブコンテンツを作成した後に、ライブ配信の開始/停止/情報取得する用途で利用します。 - name: analytics_service x-displayName: 分析 description: | 分析で利用するAPIについて記述します。
- name: playlist_service x-displayName: プレイリスト description: プレイリスト管理で利用するAPIについて記述します。 - name: folder_service x-displayName: フォルダ description: VODコンテンツ用のフォルダ管理で利用するAPIについて記述します。 - name: jobs x-displayName: ジョブ description: ジョブ管理で利用するAPIについて記述します。 - name: notifications_destination x-displayName: 通知先設定 description: | 通知先設定管理で利用するAPIについて記述します。
paths: /admin/contents/{user_id}: get: tags: - admin operationId: get-admin-contents parameters: - name: user_id in: query description: ユーザID schema: type: string description: ユーザID deprecated: false nullable: true - name: content_id in: query description: コンテンツのIDで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのIDで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: title in: query description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: コンテンツの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: tags in: query description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 schema: type: string description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 deprecated: false nullable: true - name: status in: query description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 schema: type: string description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_types in: query description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 schema: type: string description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 deprecated: false nullable: true - name: media_types in: query description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 schema: type: string description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 deprecated: false nullable: true - name: parent_content_id in: query description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 schema: type: string description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 deprecated: false minLength: 1 nullable: true - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 - name: sort_by in: query description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 schema: type: string enum: - duration - public_setting.start - updated_at - created_at - score - title - storage_amount description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: page_size in: query description: 1ページあたりのコンテンツ数 schema: type: integer description: 1ページあたりのコンテンツ数 deprecated: false maximum: 200 minimum: 1 default: 20 - name: page in: query description: ページ番号 schema: type: integer description: ページ番号 deprecated: false minimum: 1 default: 1 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: user_id: type: string description: ユーザーID deprecated: false content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。yyyy-mm-dd hh:mm:ss。
タイムゾーンはJSTです
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。yyyy-mm-dd hh:mm:ss。
タイムゾーンはJSTです
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: '2022-03-01 00:00:00' end: '2022-04-01 00:00:00' contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true contentType: application/json description: サムネイル情報 deprecated: false nullable: true pdf_info: type: object properties: pdf_file_path: type: string description: 変換前のファイルパス deprecated: false image_file_path: type: string description: 変換後のファイルパス deprecated: false nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true required: - pdf_file_path example: pdf_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.pdf image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json description: PDF情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - user_id - content_id - title - status - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: '2022-03-01 00:00:00' end: '2022-04-01 00:00:00' media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true pdf_info: pdf_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.pdf image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 origin_file_dimension: width: 1920 height: 1080 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: '' deprecated: false page: type: integer description: ページ番号 deprecated: false nullable: true required: - total_count - items example: total_count: 1 items: - user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: '2022-03-01 00:00:00' end: '2022-04-01 00:00:00' media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true pdf_info: pdf_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.pdf image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 origin_file_dimension: width: 1920 height: 1080 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg page: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0022 properties: errorCode: type: string enum: - MVOD_CNT_0022 description: エラーコード reason: type: string enum: - parent_content_idにはフォルダコンテンツのIDもしくはrootを指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/admin/contents?user_id=a4f648808d00ce7fdc2ccc7477a66620be490c3&content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&title=タイトル&description=説明文&tags=タグ１,タグ2&status=FAILED_TO_UPLOAD,NOT_READY_TO_CONVERT,READY_TO_CONVERT,WAIT_TO_CONVERT,CONVERTING,CONVERT_COMPLETED,CONVERT_ERROR,LIVE_ARCHIVING,ARCHIVE_FAILED&public_setting_types=public,private,period&media_types=video,pdf&parent_content_id=4ba28124-c54f-83d8-9ffb-5324bddbafc9&thumbnail_url_expires_in_days=1000&sort_by=created_at&order=desc&page_size=200&page=1' -H 'Authorization: Bearer {access_token}' summary: コンテンツ一覧取得 description: 指定したユーザーの全てのコンテンツ情報を取得します。 /admin/contents/{user_id}/{content_id}: get: tags: - admin operationId: get-admin-contents-{user_id}-{content_id} parameters: - name: user_id in: query description: ユーザID required: true schema: type: string description: ユーザID deprecated: false - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。yyyy-mm-dd hh:mm:ss。
タイムゾーンはJSTです
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。yyyy-mm-dd hh:mm:ss。
タイムゾーンはJSTです
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: '2022-03-01 00:00:00' end: '2022-04-01 00:00:00' contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true contentType: application/json description: サムネイル情報 deprecated: false nullable: true pdf_info: type: object properties: pdf_file_path: type: string description: 変換前のファイルパス deprecated: false image_file_path: type: string description: 変換後のファイルパス deprecated: false nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true required: - pdf_file_path example: pdf_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.pdf image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json description: PDF情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true required: - user_id - content_id - title - status - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: '2022-03-01 00:00:00' end: '2022-04-01 00:00:00' media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true pdf_info: pdf_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.pdf image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 origin_file_dimension: width: 1920 height: 1080 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/admin/contents/{user_id}/{content_id}?user_id=userid' -H 'Authorization: Bearer {access_token}' summary: コンテンツ詳細情報取得 description: |- 指定したユーザーの指定したコンテンツのコンテンツ情報を取得します。 コンテンツが存在しない場合はステータスコード200で`null`を返します。 /admin/contents/uncompleted: get: tags: - admin operationId: get-admin-contents-uncompleted parameters: - name: elapsed_time_gte in: query description: 経過時間。未完了変換ジョブの内、変換登録からの経過時間を指定した分(minutes)以上であるかで指定 schema: type: integer description: 経過時間。未完了変換ジョブの内、変換登録からの経過時間を指定した分(minutes)以上であるかで指定 deprecated: false nullable: true - name: convert_priority_gte in: query description: 変換優先度。未完了変換ジョブの内、指定した優先度以上であるかで指定 schema: type: integer description: 変換優先度。未完了変換ジョブの内、指定した優先度以上であるかで指定 deprecated: false nullable: true responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: user_id: type: string description: ユーザーID deprecated: false content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- ** 変換ステータス **
- NOT_READY_TO_CONVERT
- コンテンツを変換するための情報が不足しています。
- WAIT_TO_CONVERT
- 変換待機中の状態です。
- CONVERTING
- 変換中です。
- CONVERT_COMPLETED
- 変換完了です。
- CONVERT_ERROR
- 変換中にエラーが起こりました。 deprecated: false convert_job_id: type: string description: 変換ジョブID deprecated: false conversion_registered_at: type: string description: 変換登録日時 deprecated: false elapsed_time: type: integer description: 変換登録日時からの経過時間。単位:秒 deprecated: false convert_priority: type: integer description: 当該コンテンツ変換ジョブの変換優先度 deprecated: false conversion_started_at: type: string description: 変換開始日時 deprecated: false nullable: true required: - user_id - content_id - title - status - convert_job_id - conversion_registered_at - elapsed_time - convert_priority example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED convert_job_id: 9875043385627-abcd123 conversion_registered_at: 2022-03-01 00:00:00.000000+0900 elapsed_time: 7200 convert_priority: 0 conversion_started_at: 2022-03-01 00:00:00.000000+0900 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED convert_job_id: 9875043385627-abcd123 conversion_registered_at: 2022-03-01 00:00:00.000000+0900 elapsed_time: 7200 convert_priority: 0 conversion_started_at: 2022-03-01 00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_UNC_0001 properties: errorCode: type: string enum: - MVOD_UNC_0001 description: エラーコード reason: type: string enum: - ジョブ一覧の取得に失敗しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/admin/contents/uncompleted?elapsed_time_gte=120&convert_priority_gte=-50' -H 'Authorization: Bearer {access_token}' summary: 未完了コンテンツ一覧取得 description: 変換ジョブが未完了のコンテンツ一覧を取得します。 /admin/users: get: tags: - admin operationId: get-admin-users parameters: - name: partial in: query description: 不完全なユーザーID。指定すると部分一致するユーザー情報を取得できます。 schema: type: string description: 不完全なユーザーID。指定すると部分一致するユーザー情報を取得できます。 deprecated: false nullable: true - name: includes_deleted_users in: query description: 削除されたユーザーを含めるか。trueで含める、false/未指定で含めない schema: type: boolean description: 削除されたユーザーを含めるか。trueで含める、false/未指定で含めない deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: user_id: type: string description: ユーザーID deprecated: false role: type: string enum: - administrator - general description: 役割 deprecated: false disabled: type: boolean description: 無効フラグ trueでアカウントが無効、falseでアカウントが有効になる deprecated: false default_convert_priority: type: integer description: 変換優先度 deprecated: false mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false deleted: type: boolean description: >- 削除フラグ。trueで削除済み、falseで未削除。includes_deleted_usersパラメーター指定の場合のみ返る。 deprecated: false nullable: true function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間(秒) deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定上限数 deprecated: false nullable: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。nullの場合はmillviのデフォルトの時間だけ待機します。 deprecated: false nullable: true required: - user_id - role - disabled - default_convert_priority - mediaconvert_hopping_enabled - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 role: general disabled: false default_convert_priority: -50 mediaconvert_hopping_enabled: true created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false deleted: false function_settings_quota: subtitle_transcription: 500 live: 1 mediaconvert_hopping_wait_minutes: 120 contentType: application/json description: ユーザー一覧リスト deprecated: false required: - total_count example: total_count: 0 items: - user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 role: general disabled: false default_convert_priority: -50 mediaconvert_hopping_enabled: true created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false deleted: false function_settings_quota: subtitle_transcription: 500 live: 1 mediaconvert_hopping_wait_minutes: 120 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/admin/users?partial=a4f648808d00ce&includes_deleted_users=True' -H 'Authorization: Bearer {access_token}' summary: ユーザー一覧取得 description: ユーザーの一覧を取得します。 post: tags: - admin operationId: post-admin-users parameters: [] requestBody: content: application/json: schema: type: object properties: user_id: type: string description: 対象のユーザーID deprecated: false password: type: string description: パスワード。英大文字・英小文字・数字・記号をそれぞれ1文字以上含む10文字以上100文字以内で指定してください。 deprecated: false role: type: string enum: - administrator - general description: 役割 deprecated: false default: general default_convert_priority: type: integer description: 変換優先度 deprecated: false maximum: 50 minimum: -50 default: 0 mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false default: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。未指定の場合はmillviのデフォルトの時間だけ待機します。 deprecated: false maximum: 4320 minimum: 1 nullable: true required: - user_id - password example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 password: Admin_123456 role: general default_convert_priority: -50 mediaconvert_hopping_enabled: true mediaconvert_hopping_wait_minutes: 120 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false role: type: string enum: - administrator - general description: 役割 deprecated: false disabled: type: boolean description: 無効フラグ trueでアカウントが無効、falseでアカウントが有効になる deprecated: false default_convert_priority: type: integer description: 変換優先度 deprecated: false mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false deleted: type: boolean description: >- 削除フラグ。trueで削除済み、falseで未削除。includes_deleted_usersパラメーター指定の場合のみ返る。 deprecated: false nullable: true function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間(秒) deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定上限数 deprecated: false nullable: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。nullの場合はmillviのデフォルトの時間だけ待機します。 deprecated: false nullable: true required: - user_id - role - disabled - default_convert_priority - mediaconvert_hopping_enabled - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 role: general disabled: false default_convert_priority: -50 mediaconvert_hopping_enabled: true created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false deleted: false function_settings_quota: subtitle_transcription: 500 live: 1 mediaconvert_hopping_wait_minutes: 120 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: oneOf: - type: object title: MVOD_CUA_0002 properties: errorCode: type: string enum: - MVOD_CUA_0002 description: エラーコード reason: type: string enum: - 登録できないユーザーIDです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CUA_0008 properties: errorCode: type: string enum: - MVOD_CUA_0008 description: エラーコード reason: type: string enum: - 登録できないレシピIDです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/admin/users' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "user_id": "a4f648808d00ce7fdc2ccc7477a66620be490c3", "password": "Admin_123456", "role": "general", "default_convert_priority": -50, "mediaconvert_hopping_enabled": true, "mediaconvert_hopping_wait_minutes": 120 }' summary: ユーザー作成 description: |- ユーザーを新規に作成します。 #### 役割(role)について * administrator * ユーザーを管理するための役割です * general * コンテンツを操作するための役割です /admin/users/{user_id}: delete: tags: - admin operationId: delete-admin-users-{user_id} parameters: - name: user_id in: path description: 対象のユーザーID required: true schema: type: string description: 対象のユーザーID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false required: - user_id example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CUA_0003 properties: errorCode: type: string enum: - MVOD_CUA_0003 description: エラーコード reason: type: string enum: - 自分自身は削除できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CUA_0005 properties: errorCode: type: string enum: - MVOD_CUA_0005 description: エラーコード reason: type: string enum: - 権限がありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CUA_0009 properties: errorCode: type: string enum: - MVOD_CUA_0009 description: エラーコード reason: type: string enum: - ライブ配信中はユーザーを削除できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CUA_0006 properties: errorCode: type: string enum: - MVOD_CUA_0006 description: エラーコード reason: type: string enum: - 存在しないユーザーです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/admin/users/{user_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "user_id": "a4f648808d00ce7fdc2ccc7477a66620be490c3" }' summary: ユーザー削除 description: 動画配信プラットフォーム操作用のユーザーを削除します。 get: tags: - admin operationId: get-admin-users-{user_id} parameters: - name: user_id in: query description: 対象のユーザーID required: true schema: type: string description: 対象のユーザーID deprecated: false - name: includes_deleted_users in: query description: 削除されたユーザーを含めるか。trueで含める、false/未指定で含めない schema: type: boolean description: 削除されたユーザーを含めるか。trueで含める、false/未指定で含めない deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false role: type: string enum: - administrator - general description: 役割 deprecated: false disabled: type: boolean description: 無効フラグ trueでアカウントが無効、falseでアカウントが有効になる deprecated: false default_convert_priority: type: integer description: 変換優先度 deprecated: false mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false deleted: type: boolean description: >- 削除フラグ。trueで削除済み、falseで未削除。includes_deleted_usersパラメーター指定の場合のみ返る。 deprecated: false nullable: true function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間(秒) deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定上限数 deprecated: false nullable: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。nullの場合はmillviのデフォルトの時間だけ待機します。 deprecated: false nullable: true required: - user_id - role - disabled - default_convert_priority - mediaconvert_hopping_enabled - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 role: general disabled: false default_convert_priority: -50 mediaconvert_hopping_enabled: true created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false deleted: false function_settings_quota: subtitle_transcription: 500 live: 1 mediaconvert_hopping_wait_minutes: 120 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/admin/users/{user_id}?user_id=a4f648808d00ce7fdc2ccc7477a66620be490c3&includes_deleted_users=True' -H 'Authorization: Bearer {access_token}' summary: ユーザー詳細情報取得 description: |- ユーザーの情報を取得します。 `user_id` を指定して、特定のユーザーの情報を取得できます。 ユーザーが存在しない場合はステータスコード200で`null`を返します。 patch: tags: - admin operationId: patch-admin-users-{user_id} parameters: - name: user_id in: path description: 対象のユーザーID required: true schema: type: string description: 対象のユーザーID deprecated: false requestBody: content: application/json: schema: type: object properties: password: type: string description: パスワード。英大文字・英小文字・数字・記号をそれぞれ1文字以上含む10文字以上100文字以内で指定してください。 deprecated: false nullable: true disabled: type: boolean description: 無効フラグ trueでアカウントが無効、falseでアカウントが有効になる deprecated: false nullable: true function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false nullable: true custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false nullable: true playback_rate: type: boolean description: 再生速度設定機能 deprecated: false nullable: true subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false nullable: true live: type: boolean description: ライブ機能 deprecated: false nullable: true dvr: type: boolean description: DVR機能 deprecated: false nullable: true accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false nullable: true player_engine: type: boolean description: プレイヤー種別 deprecated: false nullable: true example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false nullable: true function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間(秒) deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定上限数 deprecated: false nullable: true default_convert_priority: type: integer description: 変換優先度 deprecated: false maximum: 50 minimum: -50 nullable: true mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false nullable: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。未指定の場合はmillviのデフォルトの時間だけ待機します。 deprecated: false maximum: 4320 minimum: 1 nullable: true example: password: Admin_123456 disabled: false function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false function_settings_quota: subtitle_transcription: 500 live: 1 default_convert_priority: -50 mediaconvert_hopping_enabled: true mediaconvert_hopping_wait_minutes: 120 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false role: type: string enum: - administrator - general description: 役割 deprecated: false disabled: type: boolean description: 無効フラグ trueでアカウントが無効、falseでアカウントが有効になる deprecated: false default_convert_priority: type: integer description: 変換優先度 deprecated: false mediaconvert_hopping_enabled: type: boolean description: コンテンツ変換時にホッピングするかどうか deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false deleted: type: boolean description: >- 削除フラグ。trueで削除済み、falseで未削除。includes_deleted_usersパラメーター指定の場合のみ返る。 deprecated: false nullable: true function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間(秒) deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定上限数 deprecated: false nullable: true mediaconvert_hopping_wait_minutes: type: integer description: ホッピングする際の待機時間(分)。nullの場合はmillviのデフォルトの時間だけ待機します。 deprecated: false nullable: true required: - user_id - role - disabled - default_convert_priority - mediaconvert_hopping_enabled - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 role: general disabled: false default_convert_priority: -50 mediaconvert_hopping_enabled: true created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false deleted: false function_settings_quota: subtitle_transcription: 500 live: 1 mediaconvert_hopping_wait_minutes: 120 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CUA_0006 properties: errorCode: type: string enum: - MVOD_CUA_0006 description: エラーコード reason: type: string enum: - 存在しないユーザーです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/admin/users/{user_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "user_id": "a4f648808d00ce7fdc2ccc7477a66620be490c3", "password": "Admin_123456", "disabled": false, "function_settings": { "onetime": false, "custom_recipe": false, "playback_rate": false, "subtitle_transcription": false, "live": false, "dvr": false, "accelerated_video_encoding": false, "player_engine": false }, "function_settings_quota": { "subtitle_transcription": 500, "live": 1 }, "default_convert_priority": -50, "mediaconvert_hopping_enabled": true, "mediaconvert_hopping_wait_minutes": 120 }' summary: ユーザー更新 description: 配信者の情報を更新します。 /admin/usages/transfers: post: tags: - admin operationId: post-admin-usages-transfers parameters: [] requestBody: content: application/json: schema: type: object properties: from: type: string description: 対象年月日(開始) deprecated: false to: type: string description: 対象年月日(終了) deprecated: false kind: type: string enum: - day - month - year description: 集計単位 deprecated: false default: day user_id: type: array items: type: string description: ユーザID deprecated: false nullable: true total: type: boolean description: trueで指定したユーザーの利用量合計値を返します deprecated: false default: true required: - from example: from: '2021-08-18' to: '2021-08-20' kind: day user_id: - userid - userid2 total: true contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: aggregate_date: type: string description: >- 集計日
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: true aggregate_period: type: string description: >- 集計期間
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: false transfer_amount: type: integer description: 転送量(バイト) deprecated: false user_id: type: string description: ユーザーID deprecated: false nullable: true required: - aggregate_date - aggregate_period - transfer_amount example: aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' transfer_amount: 1073741824 user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' transfer_amount: 1073741824 user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0015 properties: errorCode: type: string enum: - MVOD_CMN_0015 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-ddの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0010 properties: errorCode: type: string enum: - MVOD_CMN_0010 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/admin/usages/transfers' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "from": "2021-08-18", "to": "2021-08-20", "kind": "day", "user_id": [ "userid", "userid2" ], "total": true }' summary: 転送量取得 description: |- ユーザーごと/日ごとの転送量の集計結果を取得することができます。 ユーザーIDを指定しない場合は、全ユーザーの情報を取得することができます。 /admin/usages/storages: post: tags: - admin operationId: post-admin-usages-storages parameters: [] requestBody: content: application/json: schema: type: object properties: from: type: string description: 対象年月日(開始) deprecated: false to: type: string description: 対象年月日(終了) deprecated: false kind: type: string enum: - day - month - year description: 集計単位 deprecated: false default: day user_id: type: array items: type: string description: ユーザID deprecated: false nullable: true total: type: boolean description: trueで指定したユーザーの利用量合計値を返します deprecated: false default: true required: - from example: from: '2021-08-18' to: '2021-08-20' kind: day user_id: - userid - userid2 total: true contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: aggregate_date: type: string description: >- 集計日
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: true aggregate_period: type: string description: >- 集計期間
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: false storage_amount: type: integer description: ストレージ(バイト) deprecated: false user_id: type: string description: ユーザーID
リクエストで`total`を指定した場合`null`になります。 deprecated: false nullable: true required: - aggregate_date - aggregate_period - storage_amount example: aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' storage_amount: 1073741824 user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' storage_amount: 1073741824 user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0015 properties: errorCode: type: string enum: - MVOD_CMN_0015 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-ddの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0010 properties: errorCode: type: string enum: - MVOD_CMN_0010 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/admin/usages/storages' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "from": "2021-08-18", "to": "2021-08-20", "kind": "day", "user_id": [ "userid", "userid2" ], "total": true }' summary: ストレージ利用量取得 description: |- ユーザーごとのストレージ利用量の集計結果を取得します。集計期間と累計値を算出するかどうかを指定できます。 ユーザーIDを指定しない場合は、全ユーザーの情報を取得することができます。 /admin/analytics/contents: post: tags: - admin operationId: post-admin-analytics-contents parameters: [] requestBody: content: application/json: schema: type: object properties: user_id: type: string description: ユーザID deprecated: false content_id: type: array items: type: string description: コンテンツID deprecated: false required: - user_id - content_id example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 content_id: - 4ba28124-c54g-83d8-9xxb-5324bddbafc9 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: 対象のレコード件数 deprecated: false limit: type: integer description: >- リクエスト時に指定したコンテンツIDの個数。
このAPIは指定した個数分の情報を返すAPIとなっており、自分でレスポンスの個数を指定できます。 deprecated: false page: type: integer description: ページネーション。1固定です。 deprecated: false items: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: コンテンツタイトル deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル contentType: application/json description: '' deprecated: false required: - total_count - limit - page - items example: total_count: 1 limit: 10 page: 1 items: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_ANA_0001 properties: errorCode: type: string enum: - MVOD_ANA_0001 description: エラーコード reason: type: string enum: - コンテンツIDに指定できる個数の上限は50です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - admin_token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/admin/analytics/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "user_id": "a4f648808d00ce7fdc2ccc7477a66620be490c3", "content_id": [ "4ba28124-c54g-83d8-9xxb-5324bddbafc9" ] }' summary: コンテンツタイトル情報取得 description: コンテンツIDに紐づくタイトル情報を返します。 /auth/token: post: tags: - user operationId: post-auth-token parameters: [] requestBody: content: application/json: schema: type: object properties: grant_type: type: string enum: - password - refresh_token description: 認証種別 deprecated: false refresh_token: type: string description: リフレッシュトークン deprecated: false nullable: true password: type: string description: パスワード deprecated: false nullable: true user_id: type: string description: ユーザーIDもしくはユーザーIDエイリアス deprecated: false nullable: true required: - grant_type example: grant_type: password refresh_token: xxxxxxxxxx password: password user_id: test_user contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID
エイリアスでログインした場合、元となるユーザーのユーザーIDになります。 deprecated: false access_token: type: string description: アクセストークン deprecated: false access_token_expires_at: type: string description: アクセストークンの有効期限 deprecated: false refresh_token: type: string description: リフレッシュトークン deprecated: false refresh_token_expires_at: type: string description: リフレッシュトークンの有効期限 deprecated: false nullable: true user_id_alias: type: string description: ユーザーエイリアスID
ユーザーIDエイリアスでログインした場合のみ返します。 deprecated: false nullable: true required: - user_id - access_token - access_token_expires_at - refresh_token example: user_id: test_user access_token: 2YotnFZFEjr1zCsicMWpAA access_token_expires_at: 2020-01-01T00:00:00.000000+0900 refresh_token: tGzv3JOkF0XG5Qx2TlKWIA refresh_token_expires_at: 2020-01-01T00:00:00.000000+0900 user_id_alias: test_userAlias contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[refresh_token] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/auth/token' -H 'Content-Type: application/json' -d '{ "grant_type": "password", "refresh_token": "xxxxxxxxxx", "password": "password", "user_id": "test_user" }' summary: トークン取得 description: |- アクセストークン、リフレッシュトークンを取得します。 各APIへのリクエスト時には、当該APIで取得したトークンをヘッダーに設定してください。 `grant_type`に応じて、リクエストするパラメーターが違います。 #### アクセストークンの場合 + grant_type: "password" 固定 + user_id/password:必須 #### リフレッシュトークンの場合 + grant_type: "refresh_token" 固定 + refresh_token:必須 /users: patch: tags: - user operationId: patch-users parameters: [] requestBody: content: application/json: schema: type: object properties: password: type: string description: パスワード。英大文字・英小文字・数字・記号をそれぞれ1文字以上含む10文字以上100文字以内で指定してください。 deprecated: false required: - password example: password: Password_1234 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間 deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定利用可能上限 deprecated: false nullable: true user_id_alias: type: string description: ユーザーエイリアスID
エイリアスでログインした場合に値が入ります。 deprecated: false nullable: true required: - user_id - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false function_settings_quota: subtitle_transcription: 500 live: 1 user_id_alias: a4f648808d00ce7fdc2ccc7477a66620be490c3alias contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/users' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "password": "Password_1234" }' summary: ユーザー更新 description: ユーザーの情報を更新することができます get: tags: - user operationId: get-users responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: user_id: type: string description: ユーザーID deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false function_settings: type: object properties: onetime: type: boolean description: ワンタイム機能 deprecated: false default: false custom_recipe: type: boolean description: カスタムレシピ機能 deprecated: false default: false playback_rate: type: boolean description: 再生速度設定機能 deprecated: false default: false subtitle_transcription: type: boolean description: 字幕自動生成 deprecated: false default: false live: type: boolean description: ライブ機能 deprecated: false default: false dvr: type: boolean description: DVR機能 deprecated: false default: false accelerated_video_encoding: type: boolean description: 高速変換機能 deprecated: false default: false player_engine: type: boolean description: プレイヤー種別 deprecated: false default: false example: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false contentType: application/json description: 機能設定 deprecated: false function_settings_quota: type: object properties: subtitle_transcription: type: integer description: 字幕自動生成利用可能時間 deprecated: false nullable: true live: type: integer description: 同時配信数 deprecated: false nullable: true example: subtitle_transcription: 500 live: 1 contentType: application/json description: 機能設定利用可能上限 deprecated: false nullable: true user_id_alias: type: string description: ユーザーエイリアスID
エイリアスでログインした場合に値が入ります。 deprecated: false nullable: true required: - user_id - created_at - updated_at example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 function_settings: onetime: false custom_recipe: false playback_rate: false subtitle_transcription: false live: false dvr: false accelerated_video_encoding: false player_engine: false function_settings_quota: subtitle_transcription: 500 live: 1 user_id_alias: a4f648808d00ce7fdc2ccc7477a66620be490c3alias contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/users' -H 'Authorization: Bearer {access_token}' summary: ユーザー取得 description: ユーザーの情報を取得します。 /usages/transfers: get: tags: - usage_service operationId: get-usages-transfers parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false - name: to in: query description: 対象年月日(終了) schema: type: string description: 対象年月日(終了) deprecated: false - name: kind in: query description: 集計単位(day,month,year) schema: type: string enum: - day - month - year description: 集計単位(day,month,year) deprecated: false default: day responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: user_id: type: string description: ユーザーID deprecated: false aggregate_date: type: string description: 集計日 deprecated: true aggregate_period: type: string description: 集計期間 deprecated: false transfer_amount: type: integer description: 転送量(バイト) deprecated: false required: - user_id - aggregate_date - aggregate_period - transfer_amount example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' transfer_amount: 1073741824 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' transfer_amount: 1073741824 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0015 properties: errorCode: type: string enum: - MVOD_CMN_0015 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-ddの形式で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/usages/transfers?from=2021-08-18&to=2021-08-20&kind=day' -H 'Authorization: Bearer {access_token}' summary: 転送量取得 description: 転送量を取得します。集計結果を取得することができます。 /usages/storages: get: tags: - usage_service operationId: get-usages-storages parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false - name: to in: query description: 対象年月日(終了) schema: type: string description: 対象年月日(終了) deprecated: false - name: kind in: query description: 集計単位 schema: type: string enum: - day - month - year description: 集計単位 deprecated: false default: day responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: user_id: type: string description: ユーザーID deprecated: false aggregate_date: type: string description: >- 集計日
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: true aggregate_period: type: string description: >- 集計期間
パラメーターの`kind`に応じて`YYYY-MM-DD` `YYYY-MM` `YYYY`のフォーマットになります。 deprecated: false storage_amount: type: integer description: ストレージ利用量(バイト) deprecated: false required: - user_id - aggregate_date - aggregate_period - storage_amount example: user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' storage_amount: 1073741824 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - user_id: a4f648808d00ce7fdc2ccc7477a66620be490c3 aggregate_date: '2022-03-01' aggregate_period: '2022-03-01' storage_amount: 1073741824 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0015 properties: errorCode: type: string enum: - MVOD_CMN_0015 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-ddの形式で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/usages/storages?from=2021-08-18&to=2021-08-20&kind=day' -H 'Authorization: Bearer {access_token}' summary: ストレージ利用量取得 description: ストレージ利用量を取得します。集計結果を取得することができます。 /security/key: get: tags: - secret_key_service operationId: get-security-key responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: key_name: type: string description: シークレットキー名 deprecated: false created_at: type: string description: 作成日時 deprecated: false required: - key_name - created_at example: key_name: key_name created_at: 2022-02-13T14:43:06.917874+0900 contentType: application/json description: シークレットキーリスト deprecated: false nullable: true required: - total_count example: total_count: 1 items: key_name: key_name created_at: 2022-02-13T14:43:06.917874+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEK_0001 properties: errorCode: type: string enum: - MVOD_SEK_0001 description: エラーコード reason: type: string enum: - ワンタイム機能が有効ではありません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/security/key' -H 'Authorization: Bearer {access_token}' summary: シークレットキー一覧取得 description: 登録されているシークレットキーの一覧取得 post: tags: - secret_key_service operationId: post-security-key parameters: [] requestBody: content: application/json: schema: type: object properties: key_name: type: string description: シークレットキー名 deprecated: false minLength: 1 required: - key_name example: key_name: key_name contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/x-pem-file: schema: type: string format: binary contentType: application/octet-stream '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEK_0001 properties: errorCode: type: string enum: - MVOD_SEK_0001 description: エラーコード reason: type: string enum: - ワンタイム機能が有効ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEK_0002 properties: errorCode: type: string enum: - MVOD_SEK_0002 description: エラーコード reason: type: string enum: - シークレットキーの登録は5個までです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEK_0005 properties: errorCode: type: string enum: - MVOD_SEK_0005 description: エラーコード reason: type: string enum: - キーの名前に使用できるのは半角英数のみです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_SEK_0003 properties: errorCode: type: string enum: - MVOD_SEK_0003 description: エラーコード reason: type: string enum: - 同じkey_nameは使用できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/security/key' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "key_name": "key_name" }' summary: シークレットキー発行 description: access_keyの署名で使用するシークレットキーの発行 /security/key/{key_name}: delete: tags: - secret_key_service operationId: delete-security-key-{key_name} parameters: - name: key_name in: path description: シークレットキー名 required: true schema: type: string description: シークレットキー名 deprecated: false minLength: 1 requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: key_name: type: string description: シークレットキー名 deprecated: false required: - key_name example: key_name: key_name contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEK_0001 properties: errorCode: type: string enum: - MVOD_SEK_0001 description: エラーコード reason: type: string enum: - ワンタイム機能が有効ではありません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SEK_0004 properties: errorCode: type: string enum: - MVOD_SEK_0004 description: エラーコード reason: type: string enum: - 指定されたシークレットキーが存在しません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/security/key/{key_name}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: シークレットキー削除 description: access_keyの署名で使用するシークレットキーの削除 /contents: get: tags: - contents operationId: get-contents parameters: - name: content_id in: query description: コンテンツのIDで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのIDで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: title in: query description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: コンテンツの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: tags in: query description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 schema: type: string description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 deprecated: false nullable: true - name: status in: query description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 schema: type: string description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_types in: query description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 schema: type: string description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 deprecated: false nullable: true - name: media_types in: query description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 schema: type: string description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 deprecated: false nullable: true - name: parent_content_id in: query description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 schema: type: string description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 deprecated: false minLength: 1 nullable: true - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 - name: sort_by in: query description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 schema: type: string enum: - duration - public_setting.start - updated_at - created_at - score - title - storage_amount description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: page_size in: query description: 1ページあたりのコンテンツ数 schema: type: integer description: 1ページあたりのコンテンツ数 deprecated: false maximum: 200 minimum: 1 default: 20 - name: page in: query description: ページ番号 schema: type: integer description: ページ番号 deprecated: false maximum: 100000000 minimum: 1 default: 1 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json description: PDF情報 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 統計 deprecated: false page: type: integer description: ページ番号 deprecated: false nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: false nullable: true required: - total_count - items example: total_count: 1 items: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg page: 1 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0022 properties: errorCode: type: string enum: - MVOD_CNT_0022 description: エラーコード reason: type: string enum: - parent_content_idにはフォルダコンテンツのIDもしくはrootを指定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents?content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&title=タイトル&description=説明文&tags=タグ１,タグ2&status=FAILED_TO_UPLOAD,NOT_READY_TO_CONVERT,READY_TO_CONVERT,WAIT_TO_CONVERT,CONVERTING,CONVERT_COMPLETED,CONVERT_ERROR,LIVE_ARCHIVING,ARCHIVE_FAILED&public_setting_types=public,private,period&media_types=video,pdf&parent_content_id=4ba28124-c54f-83d8-9ffb-5324bddbafc9&thumbnail_url_expires_in_days=1000&sort_by=created_at&order=desc&page_size=200&page=1' -H 'Authorization: Bearer {access_token}' summary: コンテンツ一覧取得 description: コンテンツ一覧を取得します。 post: tags: - contents operationId: post-contents parameters: [] requestBody: content: application/json: schema: type: object properties: title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 description: type: string description: 説明文 deprecated: false maxLength: 8192 default: '' tag: type: array items: type: string description: タグ。1文字以上256文字以内で設定してください。 deprecated: false nullable: true recipe_id: type: string description: レシピIDを指定してください。（指定されない場合はデフォルトのレシピが入ります） deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false default: public start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true example: type: period start: '2022-03-01 00:00:00+09:00' end: '2022-04-01 00:00:00+09:00' contentType: application/json description: 公開設定 deprecated: false is_password_required: type: boolean description: コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false` deprecated: false default: false password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true upload_info: type: object properties: file_name: type: string description: アップロードするファイル名 deprecated: false maxLength: 255 minLength: 1 key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 is_multipart: type: boolean description: マルチパートアップロードかどうか。未指定時はfalseとなります。 deprecated: false default: false upload_id: type: string description: マルチパートアップロード時のアップロードID。`is_multipart` が true の場合、必須です。 deprecated: false nullable: true parts: type: array items: type: object properties: part_number: type: integer description: パート番号 deprecated: false e_tag: type: string description: マルチパートアップロード実行時に返されるETag deprecated: false required: - part_number - e_tag example: part_number: 1 e_tag: 09b435e72bda3820 contentType: application/json description: マルチパートアップロード時のパート情報。`is_multipart` が true の場合、必須です。 deprecated: false nullable: true required: - file_name - key example: file_name: origin_file.mp4 key: tmp:xxxxxxxxx is_multipart: true upload_id: nl5vrMWgBDUFOa9P parts: - part_number: 1 e_tag: 09b435e72bda3820 contentType: application/json description: アップロード情報 deprecated: false nullable: true generates_thumbnails: type: boolean description: >- `true`の場合、`upload_info`にて指定した動画の0、20、40、60、80%の地点でサムネイルが生成されます。 deprecated: false nullable: true parent_content_id: type: string description: >- コンテンツを格納したい親フォルダのコンテンツIDを指定します。未指定もしくはnullを指定した場合は作成したコンテンツはルート直下に格納されます。 deprecated: false minLength: 1 nullable: true required: - title example: title: タイトル description: 説明 tag: - tag1 - tag2 recipe_id: '1' public_setting: type: period start: '2022-03-01 00:00:00+09:00' end: '2022-04-01 00:00:00+09:00' is_password_required: false password: password upload_info: file_name: origin_file.mp4 key: tmp:xxxxxxxxx is_multipart: true upload_id: nl5vrMWgBDUFOa9P parts: - part_number: 1 e_tag: 09b435e72bda3820 generates_thumbnails: true parent_content_id: null contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json description: PDF情報 deprecated: false nullable: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0005 properties: errorCode: type: string enum: - MVOD_CNT_0005 description: エラーコード reason: type: string enum: - 再変換に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0008 properties: errorCode: type: string enum: - MVOD_CNT_0008 description: エラーコード reason: type: string enum: - 対応していない拡張子です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0013 properties: errorCode: type: string enum: - MVOD_CNT_0013 description: エラーコード reason: type: string enum: - コンテンツに対して割り当てられないレシピが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0017 properties: errorCode: type: string enum: - MVOD_CNT_0017 description: エラーコード reason: type: string enum: - タグは1文字以上256文字以内で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0019 properties: errorCode: type: string enum: - MVOD_CNT_0019 description: エラーコード reason: type: string enum: - ファイル名に使用できない次の文字が含まれています "<>|:*?\/ description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0022 properties: errorCode: type: string enum: - MVOD_CNT_0022 description: エラーコード reason: type: string enum: - parent_content_idにはフォルダコンテンツのIDもしくはnullを指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0025 properties: errorCode: type: string enum: - MVOD_CNT_0025 description: エラーコード reason: type: string enum: - タグが重複しています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。[Transaction failed] description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "タイトル", "description": "説明", "tag": [ "tag1", "tag2" ], "recipe_id": "1", "public_setting": { "type": "period", "start": "2022-03-01 00:00:00+09:00", "end": "2022-04-01 00:00:00+09:00" }, "is_password_required": false, "password": "password", "upload_info": { "file_name": "origin_file.mp4", "key": "tmp:xxxxxxxxx", "is_multipart": true, "upload_id": "nl5vrMWgBDUFOa9P", "parts": [ { "part_number": 1, "e_tag": "09b435e72bda3820" } ] }, "generates_thumbnails": true, "parent_content_id": null }' summary: コンテンツメタ情報登録 description: コンテンツメタ情報を登録します。 /contents/csv: get: tags: - contents operationId: get-contents-csv parameters: - name: content_id in: query description: コンテンツのIDで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのIDで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: title in: query description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: コンテンツの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: tags in: query description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 schema: type: string description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 deprecated: false nullable: true - name: status in: query description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 schema: type: string description: >- コンテンツの変換ステータス(`FAILED_TO_UPLOAD`,`NOT_READY_TO_CONVERT`,`READY_TO_CONVERT`,`WAIT_TO_CONVERT`,`CONVERTING`,`CONVERT_COMPLETED`,`CONVERT_ERROR`,`LIVE_ARCHIVING`,`ARCHIVE_FAILED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないステータスを指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_types in: query description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 schema: type: string description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 deprecated: false nullable: true - name: media_types in: query description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 schema: type: string description: >- コンテンツのメディアタイプ(`video`, `audio`, `pdf`, `folder`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
`null`を指定することで、メディアタイプ未指定のコンテンツを絞り込めます。
上記に合致しないメディアタイプを指定した場合無視されます。 deprecated: false nullable: true - name: parent_content_id in: query description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 schema: type: string description: >- 親フォルダのコンテンツIDで取得対象を絞り込むときに指定します。
`root`を指定することで、フォルダに属さないコンテンツを取得できます。
指定しない場合は全てのコンテンツが取得されます。 deprecated: false minLength: 1 nullable: true - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 - name: sort_by in: query description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 schema: type: string enum: - duration - public_setting.start - updated_at - created_at - score - title - storage_amount description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false params: type: string description: CSV生成するAPIのパラメータをJSON形式に変換した文字列 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false created_at: type: string description: ジョブの作成日時 deprecated: false updated_at: type: string description: ジョブの更新日時 deprecated: false required: - job_id - api_path - params - status - created_at - updated_at example: job_id: 12ab34cd-56ef-78gh-90ij-12kl34mn56op api_path: /vod/contents/statistics params: '{"from": "2024-06-01", "to": "2024-06-30"}' status: generating created_at: '2024-06-01 00:00:00.000000+09:00' updated_at: '2024-06-01 00:00:00.000000+09:00' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0022 properties: errorCode: type: string enum: - MVOD_CNT_0022 description: エラーコード reason: type: string enum: - parent_content_idにはフォルダコンテンツのIDもしくはrootを指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0001 properties: errorCode: type: string enum: - MVOD_CSV_0001 description: エラーコード reason: type: string enum: - CSVファイルの生成に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0002 properties: errorCode: type: string enum: - MVOD_CSV_0002 description: エラーコード reason: type: string enum: - 現在進行中の変換処理が10個以上存在するためジョブを開始できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/csv?content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&title=タイトル&description=説明文&tags=タグ１,タグ2&status=FAILED_TO_UPLOAD,NOT_READY_TO_CONVERT,READY_TO_CONVERT,WAIT_TO_CONVERT,CONVERTING,CONVERT_COMPLETED,CONVERT_ERROR,LIVE_ARCHIVING,ARCHIVE_FAILED&public_setting_types=public,private,period&media_types=video,pdf&parent_content_id=4ba28124-c54f-83d8-9ffb-5324bddbafc9&thumbnail_url_expires_in_days=1000&sort_by=created_at&order=desc' -H 'Authorization: Bearer {access_token}' summary: コンテンツ一覧CSV生成 description: |- コンテンツ一覧CSVファイルの作成をリクエストします。
当APIはResponses記載のエラーの他、コンテンツ一覧取得APIのエラーを返します。 /contents/{content_id}: get: tags: - contents operationId: get-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true thumbnail_url: type: string description: pdfのイメージURL deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: PDF情報。PDFファイルのイメージURLを返します。 deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: false required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}?thumbnail_url_expires_in_days=1000' -H 'Authorization: Bearer {access_token}' summary: コンテンツ詳細情報取得 description: |- コンテンツ詳細情報を取得します。 コンテンツが存在しない場合はステータスコード200で`null`を返します。 patch: tags: - contents operationId: patch-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 nullable: true description: type: string description: 説明文 deprecated: false maxLength: 8192 nullable: true tag: type: array items: type: string description: タグ。1文字以上256文字以内で設定してください。 deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false default: public start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true example: type: period start: '2022-03-01 00:00:00+09:00' end: '2022-04-01 00:00:00+09:00' contentType: application/json description: 公開設定 deprecated: false nullable: true thumbnail_active_id: type: string description: 利用するサムネイルID deprecated: false nullable: true is_password_required: type: boolean description: コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false` deprecated: false nullable: true password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true upload_info: type: object properties: file_name: type: string description: アップロードするファイル名 deprecated: false maxLength: 255 minLength: 1 key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 is_multipart: type: boolean description: マルチパートアップロードかどうか。未指定時はfalseとなります。 deprecated: false default: false upload_id: type: string description: マルチパートアップロード時のアップロードID。`is_multipart` が true の場合、必須です。 deprecated: false nullable: true parts: type: array items: type: object properties: part_number: type: integer description: パート番号 deprecated: false e_tag: type: string description: マルチパートアップロード実行時に返されるETag deprecated: false required: - part_number - e_tag example: part_number: 1 e_tag: 09b435e72bda3820 contentType: application/json description: マルチパートアップロード時のパート情報。`is_multipart` が true の場合、必須です。 deprecated: false nullable: true required: - file_name - key example: file_name: origin_file.mp4 key: tmp:xxxxxxxxx is_multipart: true upload_id: nl5vrMWgBDUFOa9P parts: - part_number: 1 e_tag: 09b435e72bda3820 contentType: application/json description: アップロード情報 deprecated: false nullable: true generates_thumbnails: type: boolean description: >- `true`の場合、変換対象の動画の0、20、40、60、80%の地点でサムネイルが生成されます。
指定しない場合はサムネイルを生成します。
このパラメーターは動画変換が実行される場合(`upload_info`を指定した場合、もしくは既に動画がアップロードされた状態で`recipe_id`を指定した場合)にのみ有効です。 deprecated: false nullable: true parent_content_id: type: string description: >- コンテンツを格納したい親フォルダのコンテンツIDを指定します。`root`を指定した場合は作成したコンテンツはルート直下に格納されます。 deprecated: false minLength: 1 nullable: true example: title: タイトル description: 説明 tag: - tag1 - tag2 recipe_id: '1' public_setting: type: period start: '2022-03-01 00:00:00+09:00' end: '2022-04-01 00:00:00+09:00' thumbnail_active_id: '1' is_password_required: false password: password upload_info: file_name: origin_file.mp4 key: tmp:xxxxxxxxx is_multipart: true upload_id: nl5vrMWgBDUFOa9P parts: - part_number: 1 e_tag: 09b435e72bda3820 generates_thumbnails: true parent_content_id: null contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true thumbnail_url: type: string description: pdfのイメージURL deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: PDF情報。PDFファイルのイメージURLを返します。 deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: false required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0005 properties: errorCode: type: string enum: - MVOD_CNT_0005 description: エラーコード reason: type: string enum: - 再変換に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0008 properties: errorCode: type: string enum: - MVOD_CNT_0008 description: エラーコード reason: type: string enum: - 対応していない拡張子です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0009 properties: errorCode: type: string enum: - MVOD_CNT_0009 description: エラーコード reason: type: string enum: - 現在コンテンツ変換中のため変換処理を開始することができません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0013 properties: errorCode: type: string enum: - MVOD_CNT_0013 description: エラーコード reason: type: string enum: - コンテンツに対して割り当てられないレシピが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0014 properties: errorCode: type: string enum: - MVOD_CNT_0014 description: エラーコード reason: type: string enum: - コンテンツの種類とアップロードされたコンテンツの種類が一致しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0017 properties: errorCode: type: string enum: - MVOD_CNT_0017 description: エラーコード reason: type: string enum: - タグは1文字以上256文字以内で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0019 properties: errorCode: type: string enum: - MVOD_CNT_0019 description: エラーコード reason: type: string enum: - ファイル名に使用できない次の文字が含まれています "<>|:*?\/ description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0022 properties: errorCode: type: string enum: - MVOD_CNT_0022 description: エラーコード reason: type: string enum: - parent_content_idにはフォルダコンテンツのIDもしくはrootを指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0023 properties: errorCode: type: string enum: - MVOD_CNT_0023 description: エラーコード reason: type: string enum: - フォルダコンテンツは自身もしくは自身の子フォルダの下に移動できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0024 properties: errorCode: type: string enum: - MVOD_CNT_0024 description: エラーコード reason: type: string enum: - 10階層を超えてしまうためフォルダを移動できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0025 properties: errorCode: type: string enum: - MVOD_CNT_0025 description: エラーコード reason: type: string enum: - タグが重複しています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0026 properties: errorCode: type: string enum: - MVOD_CNT_0026 description: エラーコード reason: type: string enum: - サムネイルが選択されていません。[thumbnail_active_id] description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CMN_0003 properties: errorCode: type: string enum: - MVOD_CMN_0003 description: エラーコード reason: type: string enum: - コンテンツ取得に失敗しました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/contents/{content_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "タイトル", "description": "説明", "tag": [ "tag1", "tag2" ], "recipe_id": "1", "public_setting": { "type": "period", "start": "2022-03-01 00:00:00+09:00", "end": "2022-04-01 00:00:00+09:00" }, "thumbnail_active_id": "1", "is_password_required": false, "password": "password", "upload_info": { "file_name": "origin_file.mp4", "key": "tmp:xxxxxxxxx", "is_multipart": true, "upload_id": "nl5vrMWgBDUFOa9P", "parts": [ { "part_number": 1, "e_tag": "09b435e72bda3820" } ] }, "generates_thumbnails": true, "parent_content_id": null }' summary: コンテンツ情報更新 description: コンテンツ情報を更新します。 delete: tags: - contents operationId: delete-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0010 properties: errorCode: type: string enum: - MVOD_CNT_0010 description: エラーコード reason: type: string enum: - コンテンツ変換中または字幕作成中のため削除することができません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0020 properties: errorCode: type: string enum: - MVOD_CNT_0020 description: エラーコード reason: type: string enum: - 配下にコンテンツが存在するため削除できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CMN_0003 properties: errorCode: type: string enum: - MVOD_CMN_0003 description: エラーコード reason: type: string enum: - コンテンツ取得に失敗しました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/contents/{content_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: コンテンツ情報削除 description: コンテンツ情報を削除します。 /contents/{content_id}/thumbnails: post: tags: - contents operationId: post-contents-{content_id}-thumbnails parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: upload_info: type: object properties: file_name: type: string description: アップロードするファイル名
`key`を指定する場合は必須です。 deprecated: false maxLength: 255 minLength: 1 key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 required: - file_name - key example: file_name: origin_file.jpg key: tmp:xxxxxxxxx contentType: application/json description: アップロード情報 deprecated: false activates: type: boolean description: 登録したサムネイルをactiveにするかどうか指定します。 deprecated: false default: true required: - upload_info example: upload_info: file_name: origin_file.jpg key: tmp:xxxxxxxxx activates: true contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報 deprecated: false required: - content_id - thumbnail_info example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0026 properties: errorCode: type: string enum: - MVOD_CMN_0026 description: エラーコード reason: type: string enum: - リクエストキーが無効です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0003 properties: errorCode: type: string enum: - MVOD_RCT_0003 description: エラーコード reason: type: string enum: - 最低1つのサムネイルを有効にする必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0004 properties: errorCode: type: string enum: - MVOD_RCT_0004 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツにサムネイルを追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0005 properties: errorCode: type: string enum: - MVOD_RCT_0005 description: エラーコード reason: type: string enum: - アップロードされた画像に拡張子がありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0006 properties: errorCode: type: string enum: - MVOD_RCT_0006 description: エラーコード reason: type: string enum: - アップロードされたファイルの拡張子が画像ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0007 properties: errorCode: type: string enum: - MVOD_RCT_0007 description: エラーコード reason: type: string enum: - アップロードされたファイルのメディアタイプが画像ではありません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CMN_0003 properties: errorCode: type: string enum: - MVOD_CMN_0003 description: エラーコード reason: type: string enum: - コンテンツ取得に失敗しました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0014 properties: errorCode: type: string enum: - MVOD_CMN_0014 description: エラーコード reason: type: string enum: - データの登録に失敗しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/contents/{content_id}/thumbnails' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "upload_info": { "file_name": "origin_file.jpg", "key": "tmp:xxxxxxxxx" }, "activates": true }' summary: サムネイル画像登録 description: サムネイル画像を新規登録する。登録したサムネイルはidが最大のものである。 delete: tags: - contents operationId: delete-contents-{content_id}-thumbnails parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: thumbnail_ids: type: array items: type: string description: 削除対象サムネイルID deprecated: false required: - thumbnail_ids example: thumbnail_ids: - '1' - '2' - '3' contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false thumbnail_ids: type: array items: type: string description: 削除されたサムネイルID一覧 deprecated: false required: - content_id - thumbnail_ids example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 thumbnail_ids: - '1' - '2' - '3' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0006 properties: errorCode: type: string enum: - MVOD_CNT_0006 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0011 properties: errorCode: type: string enum: - MVOD_CNT_0011 description: エラーコード reason: type: string enum: - アクティブなサムネイルを削除できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CNT_0016 properties: errorCode: type: string enum: - MVOD_CNT_0016 description: エラーコード reason: type: string enum: - 存在しないサムネイルIDです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0011 properties: errorCode: type: string enum: - MVOD_CMN_0011 description: エラーコード reason: type: string enum: - データの削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X DELETE 'https://${end_point}/contents/{content_id}/thumbnails' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "thumbnail_ids": [ "1", "2", "3" ] }' summary: サムネイル画像削除 description: サムネイル画像を削除する。(複数指定可能)
ただし、使用しているサムネイルは削除できません。 /contents/{content_id}/thumbnail_attime: post: tags: - contents operationId: post-contents-{content_id}-thumbnail_attime parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: offset_seconds: type: number description: >- サムネイル生成時間（秒）。動画の再生時間（duration）を超える値を指定した場合は、最終フレームのサムネイルが生成されます。 deprecated: false minimum: 0 required: - offset_seconds example: offset_seconds: 30.5 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報 deprecated: false offset_seconds: type: number description: >- サムネイル生成時間（秒）。リクエストの`offset_seconds`が動画の再生時間（duration）を超えていた場合は、`duration`の値が返却されます。 deprecated: false required: - content_id - thumbnail_info - offset_seconds example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg offset_seconds: 123 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0028 properties: errorCode: type: string enum: - MVOD_CNT_0028 description: エラーコード reason: type: string enum: - 動画コンテンツではないためサムネイルを生成できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_COU_0003 properties: errorCode: type: string enum: - MVOD_COU_0003 description: エラーコード reason: type: string enum: - 存在しないユーザーです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CNT_0006 properties: errorCode: type: string enum: - MVOD_CNT_0006 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0027 properties: errorCode: type: string enum: - MVOD_CNT_0027 description: エラーコード reason: type: string enum: - サムネイル生成に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0030 properties: errorCode: type: string enum: - MVOD_CNT_0030 description: エラーコード reason: type: string enum: - 動画コンテンツの情報の取得に失敗しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/contents/{content_id}/thumbnail_attime' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "offset_seconds": 30.5 }' summary: 指定時間のサムネイル生成 description: |- 指定時間のサムネイルを生成します。 指定時間が動画の再生時間（duration）を超えている場合は、最終フレームのサムネイルが生成されます。 /contents/{content_id}/download_url: get: tags: - contents operationId: get-contents-{content_id}-download_url parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false expires_at: type: string description: 有効期限。形式は以下の通りです。
yyyy-mm-ddThh:mm:ss.ffffff+09:00 deprecated: false download_url: type: string description: 期限付きのダウンロードURL deprecated: true url: type: string description: 期限付きのダウンロードURL deprecated: false required: - content_id - expires_at - download_url - url example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 expires_at: 2022-04-01T00:00:00.000000+0900 download_url: >- https://example.com/example/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.mp4 url: >- https://example.com/example/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.mp4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0007 properties: errorCode: type: string enum: - MVOD_CNT_0007 description: エラーコード reason: type: string enum: - コンテンツがアップロードされていません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0021 properties: errorCode: type: string enum: - MVOD_CNT_0021 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツのダウンロードURLを発行できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CNT_0006 properties: errorCode: type: string enum: - MVOD_CNT_0006 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}/download_url' -H 'Authorization: Bearer {access_token}' summary: ダウンロードURL取得 description: >- コンテンツをダウンロードするためのURLを取得します。

指定したコンテンツのstatusが次の状態でない場合のみダウンロード可能です。
  • FAILED_TO_UPLOAD
  • NOT_READY_TO_CONVERT
  • LIVE_ARCHIVING
  • ARCHIVE_FAILED
また、ダウンロードURLには期限があるため、期限が切れた場合は再取得してください。 /contents/folder: post: tags: - folder_service operationId: post-contents-folder parameters: [] requestBody: content: application/json: schema: type: object properties: title: type: string description: フォルダ名 deprecated: false maxLength: 1024 minLength: 1 parent_content_id: type: string description: 親フォルダID
指定しない場合はルートに作られます deprecated: false minLength: 1 nullable: true required: - title example: title: フォルダその1 parent_content_id: 5adf1443-5205-4ee8-bea7-5c34630583de contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: >- 変換ステータス
ステータス状態
FAILED_TO_UPLOADアップロードに失敗しています。
NOT_READY_TO_CONVERTコンテンツを変換するための情報が不足しています。
WAIT_TO_CONVERT変換待機中の状態です。
CONVERTING変換中です。
CONVERT_COMPLETED変換完了です。
CONVERT_ERROR変換中にエラーが起こりました。
deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: false nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: false nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true duration: type: number description: 動画の長さ(秒) deprecated: false nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: false nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: false nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json description: PDF情報 deprecated: false nullable: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 origin_file_name: origin_file.mp4 origin_file_size: 1024 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 media_type: video tag: - tag1 - tag2 is_password_required: false conversion_rate: 100 parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' duration: 10 subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_FLD_0001 properties: errorCode: type: string enum: - MVOD_FLD_0001 description: エラーコード reason: type: string enum: - 指定したコンテンツはフォルダではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_FLD_0002 properties: errorCode: type: string enum: - MVOD_FLD_0002 description: エラーコード reason: type: string enum: - 指定したフォルダが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_FLD_0003 properties: errorCode: type: string enum: - MVOD_FLD_0003 description: エラーコード reason: type: string enum: - フォルダは10階層を超えて作成できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/contents/folder' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "フォルダその1", "parent_content_id": "5adf1443-5205-4ee8-bea7-5c34630583de" }' summary: フォルダ作成 description: フォルダを作成します。 get: tags: - folder_service operationId: get-contents-folder responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false created_at: type: string description: フォルダ作成日時 deprecated: false updated_at: type: string description: フォルダ更新日時 deprecated: false folders: type: array items: type: same_as_parent description: 子フォルダの一覧 deprecated: false required: - content_id - title - created_at - updated_at example: content_id: 5adf1443-5205-4ee8-bea7-5c34630583de title: フォルダその1 created_at: '2024-06-01 00:00:00.000000+09:00' updated_at: '2024-06-02 00:00:00.000000+09:00' folders: [] contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/contents/folder' -H 'Authorization: Bearer {access_token}' summary: フォルダ階層取得 description: フォルダ階層情報を取得します。 /recipes: get: tags: - recipes operationId: get-recipes responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: recipe_id: type: string description: レシピID deprecated: false name: type: string description: レシピ名 deprecated: false editable: type: boolean description: 変更可能フラグ deprecated: false category: type: string enum: - video - audio description: レシピ種別 deprecated: false output_setting: type: array items: type: object properties: audio_bit_rate: type: integer description: 音声ビットレート(bps) deprecated: false frame_rate: type: number description: フレームレート(fps) deprecated: false nullable: true width: type: integer description: 解像度(横)(px) deprecated: false nullable: true height: type: integer description: 解像度(縦)(px) deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps) deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false is_millvi_managed: type: boolean description: millvi管理レシピフラグ deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - recipe_id - name - editable - category - output_setting - is_millvi_managed - created_at - updated_at example: recipe_id: '1' name: 標準 editable: false category: video output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 is_millvi_managed: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - recipe_id: '1' name: 標準 editable: false category: video output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 is_millvi_managed: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/recipes' -H 'Authorization: Bearer {access_token}' summary: レシピ一覧取得 description: レシピ一覧を取得します。 post: tags: - recipes operationId: post-recipes parameters: [] requestBody: content: application/json: schema: type: object properties: name: type: string description: レシピ名 deprecated: false maxLength: 1024 minLength: 1 output_setting: type: array items: type: object properties: audio_bit_rate: type: string enum: - '64000' - '80000' - '96000' - '112000' - '128000' - '160000' - '192000' - '224000' - '256000' - '288000' - '320000' - '384000' - '448000' - '512000' - '576000' description: 音声ビットレート(bps)。記載されている値のみを登録できます。 deprecated: false frame_rate: type: number description: フレームレート(fps)
videoレシピの場合は必須になります。 deprecated: false nullable: true width: type: integer description: 解像度(横)(px)
videoレシピの場合は必須になります。 deprecated: false nullable: true height: type: integer description: 解像度(縦)(px)
videoレシピの場合は必須になります。 deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps)
videoレシピの場合は必須になります。 deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false maxItems: 10 minItems: 1 category: type: string enum: - video - audio description: レシピ種別 deprecated: false default: video required: - name - output_setting example: name: 標準 output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 category: video contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: recipe_id: type: string description: レシピID deprecated: false name: type: string description: レシピ名 deprecated: false editable: type: boolean description: 変更可能フラグ deprecated: false category: type: string enum: - video - audio description: レシピ種別 deprecated: false output_setting: type: array items: type: object properties: audio_bit_rate: type: integer description: 音声ビットレート(bps) deprecated: false frame_rate: type: number description: フレームレート(fps) deprecated: false nullable: true width: type: integer description: 解像度(横)(px) deprecated: false nullable: true height: type: integer description: 解像度(縦)(px) deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps) deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false is_millvi_managed: type: boolean description: millvi管理レシピフラグ deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - recipe_id - name - editable - category - output_setting - is_millvi_managed - created_at - updated_at example: recipe_id: '1' name: 標準 editable: false category: video output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 is_millvi_managed: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_COU_0003 properties: errorCode: type: string enum: - MVOD_COU_0003 description: エラーコード reason: type: string enum: - 存在しないユーザーです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0004 properties: errorCode: type: string enum: - MVOD_RCP_0004 description: エラーコード reason: type: string enum: - カスタムレシピ機能が有効ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0007 properties: errorCode: type: string enum: - MVOD_RCP_0007 description: エラーコード reason: type: string enum: - レシピが重複しています。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/recipes' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "name": "標準", "output_setting": [ { "audio_bit_rate": 128000, "frame_rate": 30.0, "width": 1920, "height": 1080, "video_bit_rate": 4500000 } ], "category": "video" }' summary: レシピ情報登録 description: レシピ情報を登録します。 /recipes/{recipe_id}: get: tags: - recipes operationId: get-recipes-{recipe_id} parameters: - name: recipe_id in: path description: レシピID required: true schema: type: string description: レシピID deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: recipe_id: type: string description: レシピID deprecated: false name: type: string description: レシピ名 deprecated: false editable: type: boolean description: 変更可能フラグ deprecated: false category: type: string enum: - video - audio description: レシピ種別 deprecated: false output_setting: type: array items: type: object properties: audio_bit_rate: type: integer description: 音声ビットレート(bps) deprecated: false frame_rate: type: number description: フレームレート(fps) deprecated: false nullable: true width: type: integer description: 解像度(横)(px) deprecated: false nullable: true height: type: integer description: 解像度(縦)(px) deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps) deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false is_millvi_managed: type: boolean description: millvi管理レシピフラグ deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - recipe_id - name - editable - category - output_setting - is_millvi_managed - created_at - updated_at example: recipe_id: '1' name: 標準 editable: false category: video output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 is_millvi_managed: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/recipes/{recipe_id}' -H 'Authorization: Bearer {access_token}' summary: レシピ詳細情報取得 description: |- レシピ詳細情報を取得します。 レシピが存在しない場合はステータスコード200で`null`を返します。 patch: tags: - recipes operationId: patch-recipes-{recipe_id} parameters: - name: recipe_id in: path description: レシピID required: true schema: type: string description: レシピID deprecated: false requestBody: content: application/json: schema: type: object properties: name: type: string description: レシピ名 deprecated: false maxLength: 1024 minLength: 1 nullable: true output_setting: type: array items: type: object properties: audio_bit_rate: type: string enum: - '64000' - '80000' - '96000' - '112000' - '128000' - '160000' - '192000' - '224000' - '256000' - '288000' - '320000' - '384000' - '448000' - '512000' - '576000' description: 音声ビットレート(bps)。記載されている値のみを登録できます。 deprecated: false frame_rate: type: number description: フレームレート(fps)
videoレシピの場合は必須になります。 deprecated: false nullable: true width: type: integer description: 解像度(横)(px)
videoレシピの場合は必須になります。 deprecated: false nullable: true height: type: integer description: 解像度(縦)(px)
videoレシピの場合は必須になります。 deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps)
videoレシピの場合は必須になります。 deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false maxItems: 10 minItems: 1 nullable: true example: name: 標準 output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: recipe_id: type: string description: レシピID deprecated: false name: type: string description: レシピ名 deprecated: false editable: type: boolean description: 変更可能フラグ deprecated: false category: type: string enum: - video - audio description: レシピ種別 deprecated: false output_setting: type: array items: type: object properties: audio_bit_rate: type: integer description: 音声ビットレート(bps) deprecated: false frame_rate: type: number description: フレームレート(fps) deprecated: false nullable: true width: type: integer description: 解像度(横)(px) deprecated: false nullable: true height: type: integer description: 解像度(縦)(px) deprecated: false nullable: true video_bit_rate: type: integer description: 映像ビットレート(bps) deprecated: false nullable: true required: - audio_bit_rate example: audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 contentType: application/json description: 出力設定 deprecated: false is_millvi_managed: type: boolean description: millvi管理レシピフラグ deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - recipe_id - name - editable - category - output_setting - is_millvi_managed - created_at - updated_at example: recipe_id: '1' name: 標準 editable: false category: video output_setting: - audio_bit_rate: 128000 frame_rate: 30 width: 1920 height: 1080 video_bit_rate: 4500000 is_millvi_managed: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0003 properties: errorCode: type: string enum: - MVOD_RCP_0003 description: エラーコード reason: type: string enum: - 対象のレシピを使用しているコンテンツが存在します。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0004 properties: errorCode: type: string enum: - MVOD_RCP_0004 description: エラーコード reason: type: string enum: - カスタムレシピ機能が有効ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0006 properties: errorCode: type: string enum: - MVOD_RCP_0006 description: エラーコード reason: type: string enum: - このレシピは編集不可設定がされています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0007 properties: errorCode: type: string enum: - MVOD_RCP_0007 description: エラーコード reason: type: string enum: - レシピが重複しています。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/recipes/{recipe_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "name": "標準", "output_setting": [ { "audio_bit_rate": 128000, "frame_rate": 30.0, "width": 1920, "height": 1080, "video_bit_rate": 4500000 } ] }' summary: レシピ情報更新 description: レシピ情報を更新します。 delete: tags: - recipes operationId: delete-recipes-{recipe_id} parameters: - name: recipe_id in: path description: レシピID required: true schema: type: string description: レシピID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: recipe_id: type: string description: レシピID deprecated: false required: - recipe_id example: recipe_id: '1' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_COU_0003 properties: errorCode: type: string enum: - MVOD_COU_0003 description: エラーコード reason: type: string enum: - 存在しないユーザーです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0002 properties: errorCode: type: string enum: - MVOD_RCP_0002 description: エラーコード reason: type: string enum: - 対象のレシピは削除できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0003 properties: errorCode: type: string enum: - MVOD_RCP_0003 description: エラーコード reason: type: string enum: - 対象のレシピを使用しているコンテンツが存在します。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/recipes/{recipe_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: レシピ削除 description: レシピを削除します。 /embedkey: post: tags: - embedkey operationId: post-embedkey parameters: [] requestBody: content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID
content_idとplaylist_idのいずれかは必須です。 deprecated: false minLength: 1 nullable: true playlist_id: type: string description: プレイリストID
content_idとplaylist_idのいずれかは必須です。 deprecated: false minLength: 1 nullable: true player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true is_live: type: boolean description: ライブコンテンツフラグ
ライブコンテンツの埋め込みコードを生成するときtrue deprecated: false default: false preview_token_option: type: object properties: restrict_content_id: type: boolean description: >- `true`のときプレビュー可能なコンテンツ、プレイリストを指定したcontent_idもしくはplaylist_idに限定します。 `false`のとき所有する全てのコンテンツ、プレイリストのプレビューに利用できます。 deprecated: false live_status_override: type: boolean description: '`true`のとき、ライブコンテンツの`live_status`を無視して視聴できるようになります。' deprecated: false default: false required: - restrict_content_id example: restrict_content_id: true live_status_override: false contentType: application/json description: | プレビュートークンの生成オプション 未指定の場合はプレビュートークンは生成されません deprecated: false nullable: true example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 playlist_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 player_id: 3 security_config_id: 4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c is_live: false preview_token_option: restrict_content_id: true live_status_override: false contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: embed_key: type: string description: Embedキー deprecated: false preview_token_info: type: object properties: token: type: string description: >- プレビュートークン `millvi-v3-preview-token={preview_token_value}`としてプレイヤーページのcookieに登録することで公開制限の影響を受けずにコンテンツの視聴が可能になります deprecated: false expire_at: type: string description: |- プレビュートークンの有効期限 有効期限はトークンの生成から24時間です システム内部のキャッシュ処理により有効期限切れから10分程度は見かけ上有効と判定されることがあります deprecated: false required: - token - expire_at example: token: AQICAHgkhLWM49 expire_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: プレビュートークン情報 deprecated: false nullable: true required: - embed_key example: embed_key: AQICAHgkhJIMl9 preview_token_info: token: AQICAHgkhLWM49 expire_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_EBK_0002 properties: errorCode: type: string enum: - MVOD_EBK_0002 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_EBK_0003 properties: errorCode: type: string enum: - MVOD_EBK_0003 description: エラーコード reason: type: string enum: - フォルダコンテンツの埋め込みコードは生成できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_EBK_0004 properties: errorCode: type: string enum: - MVOD_EBK_0004 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_EBK_0005 properties: errorCode: type: string enum: - MVOD_EBK_0005 description: エラーコード reason: type: string enum: - コンテンツIDとプレイリストIDのうち片方を指定する必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/embedkey' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "content_id": "4ba28124-c54g-83d8-9xxb-5324bddbafc9", "playlist_id": "4ba28124-c54g-83d8-9xxb-5324bddbafc9", "player_id": 3, "security_config_id": "4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c", "is_live": false, "preview_token_option": { "restrict_content_id": true, "live_status_override": false } }' summary: 動画再生用のEmbedキーを発行 description: プレイヤーの埋め込みコードに必要なembedkeyを発行します。 /convert/complete: post: responses: null summary: 動画変換完了時の処理を実行 operationId: post-convert-complete description: |- * MediaConvertのジョブの完了時の処理を実行します。 * EventBridgeにてMediaConvertの完了(COMPLETE)をトリガーにlambdaが実行されます。 * 以下の処理を行います。 * ステータスの更新（変換完了) * マニフェストファイルパスの設定 * サムネイルパスの設定 * トリガーによりlambdaが実行されるため、このAPI仕様書に記載のAPIのエンドポイントはダミー tags: - batch /convert/status_changed: post: responses: null summary: 動画変換ステータス変更時の処理を実行 operationId: post-convert-status-changed description: |- * MediaConvertのジョブのステータス変更時の処理を実行します。 * EventBridgeにてMediaConvertの以下のステータスをトリガーにlambdaが実行されます。 * 開始(PROGRESSING) * エラー(ERROR) * 以下の処理を行います。 * ステータスの更新 * エラーコードの設定 (エラー時のみ) * エラーメッセージの設定 (エラー時のみ) * トリガーによりlambdaが実行されるため、このAPI仕様書に記載のAPIのエンドポイントはダミー tags: - batch /content: servers: - url: https://client.millvi.com post: tags: - player operationId: post-content parameters: [] requestBody: content: application/json: schema: type: object properties: embed_key: type: string description: Embedキー deprecated: false access_key: type: string description: >- 公開期限情報を含む、アクセスキーを渡すことができます。 `注意` : 機能設定のワンタイムオプションが有効化されている必要があります。 #### フォーマット `expire` は有効期限のUNIXタイムスタンプ形式の値です。 ```php - 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。
`player_engine`が`browser_native`のときは音声プレイヤーで無効になります。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: >- クロムレス
Videoプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true autoplay: type: boolean description: >- 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。この設定が有効の場合は`muted`はtrueに設定されます。 deprecated: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 nullable: true fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーで有効になります。 deprecated: false nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playback_rates: type: array items: type: number description: >- 速度設定
VideoとAudioプレイヤーで有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true is_default: type: boolean description: デフォルトプレイヤーフラグ deprecated: false nullable: true style: type: string enum: - bar - circle description: >- プレイヤースタイル
Audioプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true continuous: type: boolean description: >- 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false nullable: true required: - player_id - player_name - player_type - aspect_ratio - created_at - updated_at example: player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json description: プレイヤー情報 deprecated: false status: type: object properties: domain: type: boolean description: ドメイン制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true ip: type: boolean description: IPアドレス制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true onetime: type: boolean description: onetime制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true public: type: boolean description: 公開制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true password: type: boolean description: パスワード制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true ready: type: boolean description: コンテンツ作成が未完了の場合はfalse、コンテンツの作成が完了している場合はtrue deprecated: false default: true iframe: type: boolean description: iframe専用ページを直接開いた場合はfalse deprecated: false default: true example: domain: true ip: true onetime: true public: true password: true ready: true iframe: true contentType: application/json description: コンテンツステータス deprecated: false title: type: string description: コンテンツのタイトル deprecated: false nullable: true content_metadata: type: object properties: channel: type: string description: チャンネル deprecated: false content_id: type: string description: コンテンツID deprecated: false required: - channel - content_id example: channel: >- c503c24cb9a2951a37ae88a6233e9eca20d302900c93fcadb459130692ce37b2 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 contentType: application/json description: コンテンツメタデータ deprecated: false nullable: true manifest_urls: type: array items: type: string description: ビデオソースURLリスト deprecated: false nullable: true duration: type: number description: コンテンツの再生時間 (秒) deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true image_file_urls: type: array items: type: string description: PDF変換後イメージファイルのURLリスト deprecated: false nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true tracks: type: array items: type: object properties: default: type: boolean description: デフォルトのトラックかどうか deprecated: false kind: type: string enum: - subtitles - captions - descriptions - chapters - metadata description: トラックの種類 deprecated: false label: type: string description: ラベル deprecated: false src: type: string description: トラックURL deprecated: false srclang: type: string description: トラックの言語 deprecated: false nullable: true required: - default - kind - label - src example: default: true kind: subtitles label: 日本語 src: https://example.com srclang: ja contentType: application/json description: トラック情報 deprecated: false nullable: true live_status: type: object properties: status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: ライブ公開状態 deprecated: false messages: type: object properties: undecided: type: string description: 公開未定時のメッセージ deprecated: false default: 公開未定 before: type: string description: 公開前のメッセージ deprecated: false default: 公開前 streaming: type: string description: 公開中のメッセージ deprecated: false default: 公開中 suspended: type: string description: 公開中断時のメッセージ deprecated: false default: 公開中断 finished: type: string description: 公開終了時のメッセージ deprecated: false default: 公開終了 example: undecided: 公開未定 before: 公開前 streaming: 公開中 suspended: 公開中断 finished: 公開終了 contentType: application/json description: ライブ状態メッセージ deprecated: false images: type: object properties: undecided: type: string description: 配信未定 deprecated: false nullable: true before: type: string description: 配信前 deprecated: false nullable: true streaming: type: string description: 配信中 deprecated: false nullable: true suspended: type: string description: 配信中断 deprecated: false nullable: true finished: type: string description: 配信終了 deprecated: false nullable: true example: undecided: https://example.com/thumbnail.jpg before: https://example.com/thumbnail.jpg streaming: https://example.com/thumbnail.jpg suspended: https://example.com/thumbnail.jpg finished: https://example.com/thumbnail.jpg contentType: application/json description: ライブ状態の画像 deprecated: false dvr: type: boolean description: DVR情報 deprecated: false default: false required: - status - messages - images example: status: UNDECIDED messages: undecided: 公開未定 before: 公開前 streaming: 公開中 suspended: 公開中断 finished: 公開終了 images: undecided: https://example.com/thumbnail.jpg before: https://example.com/thumbnail.jpg streaming: https://example.com/thumbnail.jpg suspended: https://example.com/thumbnail.jpg finished: https://example.com/thumbnail.jpg dvr: false contentType: application/json description: ライブステータス deprecated: false nullable: true playlist_contents: type: array items: type: same_as_parent description: プレイリストに紐づくコンテンツ情報 deprecated: false nullable: true playlists: type: array items: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false status: type: object properties: domain: type: boolean description: ドメイン制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true ip: type: boolean description: IPアドレス制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true onetime: type: boolean description: onetime制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true public: type: boolean description: 公開制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true password: type: boolean description: パスワード制限にかかる場合はfalse、制限にかからない場合はtrue deprecated: false default: true ready: type: boolean description: コンテンツ作成が未完了の場合はfalse、コンテンツの作成が完了している場合はtrue deprecated: false default: true iframe: type: boolean description: iframe専用ページを直接開いた場合はfalse deprecated: false default: true example: domain: true ip: true onetime: true public: true password: true ready: true iframe: true contentType: application/json description: プレイリストステータス deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true title: type: string description: プレイリストタイトル deprecated: false nullable: true required: - playlist_id - media_type - status example: playlist_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 media_type: video status: domain: true ip: true onetime: true public: true password: true ready: true iframe: true thumbnail_url: https://example.com/thumbnail.jpg title: title001 contentType: application/json description: プレイリストに紐づくプレイリスト情報 deprecated: false nullable: true required: - player_config - status example: player_config: player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi status: domain: true ip: true onetime: true public: true password: true ready: true iframe: true title: title001 content_metadata: channel: >- c503c24cb9a2951a37ae88a6233e9eca20d302900c93fcadb459130692ce37b2 content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 manifest_urls: - https://example.com/video.m3u8 - https://example.com/video.mpd duration: 1.2 thumbnail_url: https://example.com/thumbnail.jpg media_type: video image_file_urls: - https://example.com/img_1.jpg - https://example.com/img_2.jpg total_page_count: 0 tracks: - default: true kind: subtitles label: 日本語 src: https://example.com srclang: ja live_status: status: UNDECIDED messages: undecided: 公開未定 before: 公開前 streaming: 公開中 suspended: 公開中断 finished: 公開終了 images: undecided: https://example.com/thumbnail.jpg before: https://example.com/thumbnail.jpg streaming: https://example.com/thumbnail.jpg suspended: https://example.com/thumbnail.jpg finished: https://example.com/thumbnail.jpg dvr: false playlist_contents: [] playlists: [] contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0001 properties: errorCode: type: string enum: - MVOD_CNT_0001 description: エラーコード reason: type: string enum: - 無効なユーザーIDです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0002 properties: errorCode: type: string enum: - MVOD_CNT_0002 description: エラーコード reason: type: string enum: - 無効なコンテンツIDです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0005 properties: errorCode: type: string enum: - MVOD_PLL_0005 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/content' -H 'Content-Type: application/json' -d '{ "embed_key": "AQICAHgkhJIMl9", "access_key": "v3&${expire}&${key_name}&${sign}", "password": "12345678", "playlist_id": "4ba28124-c54g-83d8-9xxb-5324bddbafc9", "is_in_iframe": false, "iframe_referrer_url": "https://example.com/", "iframe_referrer_url_hash": "5b822f74a52f312b0b34224c9666ac3cf2ceb", "location_url": "https://example.com/somepage.html" }' summary: コンテンツ閲覧情報を取得 description: 視聴コンテンツを返します /content/status: servers: - url: https://client.millvi.com get: tags: - player operationId: get-content-status parameters: - name: embed_key in: query description: Embedキー required: true schema: type: string description: Embedキー deprecated: false - name: access_key in: query description: >- 公開期限情報を含む、アクセスキーを渡すことができます。 `注意` : 機能設定のワンタイムオプションが有効化されている必要があります。 #### フォーマット `expire` は有効期限のUNIXタイムスタンプ形式の値です。 ```php - 公開期限情報を含む、アクセスキーを渡すことができます。 `注意` : 機能設定のワンタイムオプションが有効化されている必要があります。 #### フォーマット `expire` は有効期限のUNIXタイムスタンプ形式の値です。 ```php - curl -v -X GET 'https://${end_point}/content/status?embed_key=AQICAHgkhJIMl9&access_key=v3&${expire}&${key_name}&${sign}&playlist_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9' summary: プレイヤー用コンテンツ状態を取得 description: >- コンテンツが視聴可能かどうかのstatusを返します。
現在サポートとしている状態はstatus.onetime、status.public、status.ready及びlive_statusになります。 その他の状態はtrueで返ります。 /content/clear_content: post: responses: null summary: コンテンツ物理削除処理を実行 operationId: post-clear-content description: |- * コンテンツの物理削除処理を実行します。 * 以下の処理を行います。 * 対象S3バケットのコンテンツの削除 * dynamoDBより対象のコンテンツ情報に物理削除日時を追加・更新する * 夜間バッチで日次実行します。 tags: - batch /content/delete_contents_of_delete_users: post: responses: null summary: 削除ユーザーのコンテンツ論理削除処理を実行 operationId: post-delete-contents-of-deleted-users description: |- * 削除ユーザーのコンテンツ論理削除処理を実行します。 * 以下の処理を行います。 * コンテンツテーブルから対象ユーザーのコンテンツ情報を削除する * コンテンツ削除テーブルに対象ユーザーのコンテンツ情報に加え、論理削除実行ユーザー、論理削除日時の情報を追加する * 簡易視聴ページ用埋め込みコード情報テーブルから対象ユーザーのコード情報を削除する * バッチは1時間に一度実行します。 tags: - batch /contents/{content_id}/subtitle: post: tags: - subtitle_service operationId: post-contents-{content_id}-subtitle parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false minLength: 1 requestBody: content: application/json: schema: type: object properties: label: type: string description: 字幕ラベル deprecated: false maxLength: 64 srclang: type: string description: 言語コード deprecated: false maxLength: 128 minLength: 1 is_default: type: boolean description: デフォルト字幕設定 trueのときデフォルトの字幕となります deprecated: false default: false is_enabled: type: boolean description: 字幕公開設定 trueのとき視聴者へ公開されます deprecated: false default: false items: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false end: type: string description: 終了時刻 deprecated: false text: type: string description: 字幕テキスト deprecated: false maxLength: 1024 minLength: 1 order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 required: - begin - end - text example: begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 contentType: application/json description: 字幕データリスト deprecated: false order: type: integer description: 字幕一覧での表示順 deprecated: false nullable: true required: - label - srclang example: label: 日本語 srclang: ja is_default: false is_enabled: false items: - begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 order: 0 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0001 properties: errorCode: type: string enum: - MVOD_SBS_0001 description: エラーコード reason: type: string enum: - 登録できる字幕データは15件までです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0002 properties: errorCode: type: string enum: - MVOD_SBS_0002 description: エラーコード reason: type: string enum: - 字幕データのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0010 properties: errorCode: type: string enum: - MVOD_SBS_0010 description: エラーコード reason: type: string enum: - 字幕データリストに重複したデータが存在するため追加/編集できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0011 properties: errorCode: type: string enum: - MVOD_SBS_0011 description: エラーコード reason: type: string enum: - 字幕データが空の状態で公開できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0014 properties: errorCode: type: string enum: - MVOD_SBS_0014 description: エラーコード reason: type: string enum: - 字幕データの追加・更新または削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0015 properties: errorCode: type: string enum: - MVOD_SBS_0015 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツに字幕を追加できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/contents/{content_id}/subtitle' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "label": "日本語", "srclang": "ja", "is_default": false, "is_enabled": false, "items": [ { "begin": "00:00:00.000", "end": "99:59:59.999", "text": "字幕テキスト", "order": 0 } ], "order": 0 }' summary: 字幕登録 description: 字幕を新規作成します。 put: tags: - subtitle_service operationId: put-contents-{content_id}-subtitle parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 label: type: string description: 字幕ラベル deprecated: false maxLength: 64 minLength: 1 srclang: type: string description: 言語コード deprecated: false maxLength: 128 minLength: 1 is_default: type: boolean description: デフォルト字幕設定 deprecated: false nullable: true required: - key - label - srclang example: key: tmp:xxxxxxxxx label: 日本語 srclang: ja is_default: false contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - text([value])は 1 <= text <= 1024 の長さである必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0001 properties: errorCode: type: string enum: - MVOD_SBS_0001 description: エラーコード reason: type: string enum: - 登録できる字幕データは15件までです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0002 properties: errorCode: type: string enum: - MVOD_SBS_0002 description: エラーコード reason: type: string enum: - 字幕データのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0003 properties: errorCode: type: string enum: - MVOD_SBS_0003 description: エラーコード reason: type: string enum: - アップロード先にファイルが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0007 properties: errorCode: type: string enum: - MVOD_SBS_0007 description: エラーコード reason: type: string enum: - 字幕ファイルのファイルサイズが制限(50 MB)を超えています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0014 properties: errorCode: type: string enum: - MVOD_SBS_0014 description: エラーコード reason: type: string enum: - 字幕データの追加・更新または削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0015 properties: errorCode: type: string enum: - MVOD_SBS_0015 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツに字幕を追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0023 properties: errorCode: type: string enum: - MVOD_SBS_0023 description: エラーコード reason: type: string enum: - 新規追加する字幕データのテキストは必須です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PUT 'https://${end_point}/contents/{content_id}/subtitle' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "key": "tmp:xxxxxxxxx", "label": "日本語", "srclang": "ja", "is_default": false }' summary: 字幕ファイル登録 description: 字幕ファイルを登録します。 /contents/{content_id}/subtitle/{subtitle_id}: get: tags: - subtitle_service operationId: get-contents-{content_id}-subtitle-{subtitle_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: subtitle_id in: path description: 字幕ID required: true schema: type: string description: 字幕ID deprecated: false - name: start in: query description: 開始秒数 required: true schema: type: number description: 開始秒数 deprecated: false maximum: 359999.999 minimum: 0 - name: end in: query description: 終了秒数 required: true schema: type: number description: 終了秒数 deprecated: false maximum: 359999.999 minimum: 0 - name: export_draft in: query description: trueのとき下書きを含んで出力します schema: type: boolean description: trueのとき下書きを含んで出力します deprecated: false default: false - name: as_text in: query description: trueのときテキスト(vtt_text)を返します schema: type: boolean description: trueのときテキスト(vtt_text)を返します deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false subtitle_id: type: string description: 字幕ID 無指定のとき新規作成 deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false cues: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false end: type: string description: 終了時刻 deprecated: false is_draft: type: boolean description: trueのとき下書きで未公開状態 deprecated: false text: type: string description: 字幕テキスト deprecated: false default: '' nullable: true order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 nullable: true required: - begin - end - is_draft example: begin: '00:00:00.000' end: '99:99:99.999' is_draft: true text: 字幕テキスト order: 0 contentType: application/json description: 字幕データ deprecated: false nullable: true vtt_text: type: string description: VTTテキストデータ deprecated: false nullable: true required: - content_id - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 cues: begin: '00:00:00.000' end: '99:99:99.999' is_draft: true text: 字幕テキスト order: 0 vtt_text: |- VTT 00:00:00.000 --> 23:59:59.999 字幕テキスト contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0013 properties: errorCode: type: string enum: - MVOD_SBS_0013 description: エラーコード reason: type: string enum: - 終了時間は開始時間より小さく設定できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}/subtitle/{subtitle_id}?start=0.0&end=7200.0&export_draft=False&as_text=False' -H 'Authorization: Bearer {access_token}' summary: 字幕取得 description: |- 指定した秒数の範囲の字幕を取得します。 指定した字幕が存在しない場合はステータスコード200で`null`を返します。 patch: tags: - subtitle_service operationId: patch-contents-{content_id}-subtitle-{subtitle_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false minLength: 1 - name: subtitle_id in: path description: 字幕ID required: true schema: type: string description: 字幕ID deprecated: false minLength: 1 requestBody: content: application/json: schema: type: object properties: label: type: string description: 字幕ラベル deprecated: false maxLength: 64 nullable: true srclang: type: string description: 言語コード deprecated: false maxLength: 128 minLength: 1 nullable: true is_default: type: boolean description: デフォルト字幕設定 trueのときデフォルトの字幕となります deprecated: false nullable: true is_enabled: type: boolean description: 字幕公開設定 trueのとき視聴者へ公開されます deprecated: false nullable: true items: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false end: type: string description: 終了時刻 deprecated: false nullable: true text: type: string description: 字幕テキスト deprecated: false nullable: true order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 delete: type: boolean description: 削除フラグ trueのとき対応するレコードを削除します deprecated: false nullable: true required: - begin example: begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 delete: false contentType: application/json description: 字幕データリスト deprecated: false apply: type: boolean description: >- 字幕公開設定
`true`のとき下書き状態の字幕データの下書きを解除して編集後の内容を視聴者に公開します。
`is_enable`が`false`の場合は編集後の内容は公開できる状態ですが、`is_enable`が`true`に更新されるまで視聴者への公開が停止されている状態となります。 deprecated: false nullable: true order: type: integer description: 字幕一覧での表示順 deprecated: false nullable: true example: label: 日本語 srclang: ja is_default: false is_enabled: false items: - begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 delete: false apply: false order: 0 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - text([value])は 1 <= text <= 1024 の長さである必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0002 properties: errorCode: type: string enum: - MVOD_SBS_0002 description: エラーコード reason: type: string enum: - 字幕データのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0009 properties: errorCode: type: string enum: - MVOD_SBS_0009 description: エラーコード reason: type: string enum: - 新規追加する字幕データの終了時刻は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0010 properties: errorCode: type: string enum: - MVOD_SBS_0010 description: エラーコード reason: type: string enum: - 字幕データリストに重複したデータが存在するため追加/編集できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0011 properties: errorCode: type: string enum: - MVOD_SBS_0011 description: エラーコード reason: type: string enum: - 字幕データが空の状態で公開できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0014 properties: errorCode: type: string enum: - MVOD_SBS_0014 description: エラーコード reason: type: string enum: - 字幕データの追加・更新または削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0015 properties: errorCode: type: string enum: - MVOD_SBS_0015 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツに字幕を追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0022 properties: errorCode: type: string enum: - MVOD_SBS_0022 description: エラーコード reason: type: string enum: - 字幕の作成中は当該機能は利用できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0023 properties: errorCode: type: string enum: - MVOD_SBS_0023 description: エラーコード reason: type: string enum: - 新規追加する字幕データのテキストは必須です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0006 properties: errorCode: type: string enum: - MVOD_SBS_0006 description: エラーコード reason: type: string enum: - 存在しない字幕データが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X PATCH 'https://${end_point}/contents/{content_id}/subtitle/{subtitle_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "label": "日本語", "srclang": "ja", "is_default": false, "is_enabled": false, "items": [ { "begin": "00:00:00.000", "end": "99:59:59.999", "text": "字幕テキスト", "order": 0, "delete": false } ], "apply": false, "order": 0 }' summary: 字幕編集 description: 字幕を編集します。 delete: tags: - subtitle_service operationId: delete-contents-{content_id}-subtitle-{subtitle_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: subtitle_id in: path description: 字幕ID required: true schema: type: string description: 字幕ID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false subtitle_id: type: string description: 字幕ID deprecated: false required: - content_id - subtitle_id example: content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0014 properties: errorCode: type: string enum: - MVOD_SBS_0014 description: エラーコード reason: type: string enum: - 字幕データの追加・更新または削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0022 properties: errorCode: type: string enum: - MVOD_SBS_0022 description: エラーコード reason: type: string enum: - 字幕の作成中は当該機能は利用できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0006 properties: errorCode: type: string enum: - MVOD_SBS_0006 description: エラーコード reason: type: string enum: - 存在しない字幕データが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X DELETE 'https://${end_point}/contents/{content_id}/subtitle/{subtitle_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: 字幕削除 description: 字幕を削除します。 /contents/subtitles: post: tags: - subtitle_service operationId: post-contents-subtitles parameters: [] requestBody: content: application/json: schema: type: object properties: items: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false minLength: 1 subtitle_id: type: string description: 字幕ID deprecated: false minLength: 1 label: type: string description: 字幕ラベル deprecated: false maxLength: 64 nullable: true srclang: type: string description: 言語コード deprecated: false maxLength: 128 minLength: 1 nullable: true is_default: type: boolean description: デフォルト字幕設定 trueのときデフォルトの字幕となります deprecated: false nullable: true is_enabled: type: boolean description: 字幕公開設定 trueのとき視聴者へ公開されます deprecated: false nullable: true items: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false end: type: string description: 終了時刻 deprecated: false nullable: true text: type: string description: 字幕テキスト deprecated: false nullable: true order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 delete: type: boolean description: 削除フラグ trueのとき対応するレコードを削除します deprecated: false nullable: true required: - begin example: begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 delete: false contentType: application/json description: 字幕データリスト deprecated: false apply: type: boolean description: >- 字幕公開設定
`true`のとき下書き状態の字幕データの下書きを解除して編集後の内容を視聴者に公開します。
`is_enable`が`false`の場合は編集後の内容は公開できる状態ですが、`is_enable`が`true`に更新されるまで視聴者への公開が停止されている状態となります。 deprecated: false nullable: true order: type: integer description: 字幕一覧での表示順 deprecated: false nullable: true required: - content_id - subtitle_id example: content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false items: - begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 delete: false apply: false order: 0 contentType: application/json description: 字幕データリスト deprecated: false example: items: - content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false items: - begin: '00:00:00.000' end: '99:59:59.999' text: 字幕テキスト order: 0 delete: false apply: false order: 0 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: 字幕データ数 deprecated: false items: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false content_id: type: string description: コンテンツID deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at - content_id example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 contentType: application/json description: 字幕データ deprecated: false required: - total_count - items example: total_count: 1 items: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - text([value])は 1 <= text <= 1024 の長さである必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0002 properties: errorCode: type: string enum: - MVOD_SBS_0002 description: エラーコード reason: type: string enum: - 字幕データのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0009 properties: errorCode: type: string enum: - MVOD_SBS_0009 description: エラーコード reason: type: string enum: - 新規追加する字幕データの終了時刻は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0010 properties: errorCode: type: string enum: - MVOD_SBS_0010 description: エラーコード reason: type: string enum: - 字幕データリストに重複したデータが存在するため追加/編集できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0011 properties: errorCode: type: string enum: - MVOD_SBS_0011 description: エラーコード reason: type: string enum: - 字幕データが空の状態で公開できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0014 properties: errorCode: type: string enum: - MVOD_SBS_0014 description: エラーコード reason: type: string enum: - 字幕データの追加・更新または削除に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0015 properties: errorCode: type: string enum: - MVOD_SBS_0015 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツに字幕を追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0022 properties: errorCode: type: string enum: - MVOD_SBS_0022 description: エラーコード reason: type: string enum: - 字幕の作成中は当該機能は利用できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0023 properties: errorCode: type: string enum: - MVOD_SBS_0023 description: エラーコード reason: type: string enum: - 新規追加する字幕データのテキストは必須です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0006 properties: errorCode: type: string enum: - MVOD_SBS_0006 description: エラーコード reason: type: string enum: - 存在しない字幕データが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/contents/subtitles' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "items": [ { "content_id": "f5c14cc9-4808-4c86-b2fd-de63ae72a6a0", "subtitle_id": "1fb76906-9f13-49fe-a13f-46714d81c250", "label": "日本語", "srclang": "ja", "is_default": false, "is_enabled": false, "items": [ { "begin": "00:00:00.000", "end": "99:59:59.999", "text": "字幕テキスト", "order": 0, "delete": false } ], "apply": false, "order": 0 } ] }' summary: 字幕一括編集 description: 字幕を一括編集します。 /contents/{content_id}/subtitle/{subtitle_id}/download: get: tags: - subtitle_service operationId: get-contents-{content_id}-subtitle-{subtitle_id}-download parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: subtitle_id in: path description: 字幕ID required: true schema: type: string description: 字幕ID deprecated: false - name: export_draft in: query description: trueのとき下書きを含んで出力します schema: type: boolean description: trueのとき下書きを含んで出力します deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: ダウンロードURL deprecated: false expires_at: type: string description: ダウンロードURLの有効期限 deprecated: false required: - url - expires_at example: url: https://example.com expires_at: 2020-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0008 properties: errorCode: type: string enum: - MVOD_SBS_0008 description: エラーコード reason: type: string enum: - 未公開の字幕が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0022 properties: errorCode: type: string enum: - MVOD_SBS_0022 description: エラーコード reason: type: string enum: - 字幕の作成中は当該機能は利用できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0006 properties: errorCode: type: string enum: - MVOD_SBS_0006 description: エラーコード reason: type: string enum: - 存在しない字幕データが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}/subtitle/{subtitle_id}/download?export_draft=False' -H 'Authorization: Bearer {access_token}' summary: 字幕ダウンロードURLを取得 description: 字幕をダウンロードURLを取得する /contents/{content_id}/subtitle/transcription: post: tags: - subtitle_service operationId: post-contents-{content_id}-subtitle-transcription parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: label: type: string description: 字幕ラベル deprecated: false maxLength: 64 minLength: 1 srclang: type: string enum: - af - ar-AE - ar-SA - da - de-DE - de-CH - en-AU - en-GB - en-IN - en-IE - en-NZ - en-AB - en-ZA - en-US - en-WL - es-ES - es-US - fa - fr-FR - fr-CA - he - hi - id - it - ja - ko - ms - nl - pt-PT - pt-BR - ru - sv - ta - te - th - tr - vi - zh-CN - zh-TW description: 言語コード deprecated: false speakers_count: type: integer description: 話している人数 deprecated: false maximum: 10 minimum: 1 nullable: true required: - label - srclang example: label: 日本語 srclang: ja speakers_count: 1 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0001 properties: errorCode: type: string enum: - MVOD_SBS_0001 description: エラーコード reason: type: string enum: - 登録できる字幕データは15件までです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0015 properties: errorCode: type: string enum: - MVOD_SBS_0015 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツに字幕を追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0016 properties: errorCode: type: string enum: - MVOD_SBS_0016 description: エラーコード reason: type: string enum: - 自動字幕生成はコンテンツ変換が完了してから利用できます。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0017 properties: errorCode: type: string enum: - MVOD_SBS_0017 description: エラーコード reason: type: string enum: - 自動字幕生成は再生時間が4時間以下の動画のみ利用できます。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0020 properties: errorCode: type: string enum: - MVOD_SBS_0020 description: エラーコード reason: type: string enum: - 自動字幕生成機能が有効ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SBS_0021 properties: errorCode: type: string enum: - MVOD_SBS_0021 description: エラーコード reason: type: string enum: - 自動字幕生成機能の当月の利用可能時間を超えているため利用できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SBS_0005 properties: errorCode: type: string enum: - MVOD_SBS_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/contents/{content_id}/subtitle/transcription' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "label": "日本語", "srclang": "ja", "speakers_count": 1 }' summary: 自動字幕生成開始 description: 自動字幕生成を開始します。 /usages/subtitle/transcription: get: tags: - subtitle_service operationId: get-usages-subtitle-transcription parameters: - name: year in: query description: 対象年 schema: type: integer description: 対象年 deprecated: false maximum: 9999 minimum: 1000 nullable: true - name: month in: query description: 対象月 schema: type: integer description: 対象月 deprecated: false maximum: 12 minimum: 1 nullable: true responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_usage_second: type: number description: 対象年月の実際の利用時間(秒) deprecated: false quota_second: type: integer description: 対象年月の利用可能時間(秒) deprecated: false required: - total_usage_second - quota_second example: total_usage_second: 500.1 quota_second: 500 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/usages/subtitle/transcription?year=2022&month=5' -H 'Authorization: Bearer {access_token}' summary: 自動字幕生成利用時間取得 description: |- 自動字幕生成の利用可能時間と実際の利用時間を取得します。

パラメーターの`year`と`month`を指定した場合は、その年月の情報を、
指定しない場合は当月の情報をそれぞれ取得できます。 /contents/{content_id}/chapter: get: tags: - chapter_service operationId: get-contents-{content_id}-chapter parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: export_draft in: query description: trueのとき下書きを含んで出力します schema: type: boolean description: trueのとき下書きを含んで出力します deprecated: false default: false - name: as_text in: query description: trueのときテキスト(vtt_text)を返します schema: type: boolean description: trueのときテキスト(vtt_text)を返します deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false cues: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false end: type: string description: 終了時刻 deprecated: false is_draft: type: boolean description: trueのとき下書きで未公開状態 deprecated: false text: type: string description: チャプターテキスト deprecated: false default: '' nullable: true order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 nullable: true required: - begin - end - is_draft example: begin: '00:00:00.000' end: '99:99:99.999' is_draft: true text: 第1章 order: 0 contentType: application/json description: チャプターデータ deprecated: false nullable: true vtt_text: type: string description: VTTテキストデータ deprecated: false nullable: true required: - content_id - label - is_enabled - created_at - updated_at example: content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 cues: begin: '00:00:00.000' end: '99:99:99.999' is_draft: true text: 第1章 order: 0 vtt_text: |- VTT 00:00:00.000 --> 00:00:10.000 第1章 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}/chapter?export_draft=False&as_text=False' -H 'Authorization: Bearer {access_token}' summary: チャプター取得 description: |- チャプターを取得します。 指定したコンテンツにチャプターが存在しない場合はステータスコード200で`null`を返します。 put: tags: - chapter_service operationId: put-contents-{content_id}-chapter parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 label: type: string description: チャプターラベル deprecated: false maxLength: 1024 minLength: 1 required: - key - label example: key: tmp:xxxxxxxxx label: 日本語 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0001 properties: errorCode: type: string enum: - MVOD_CHA_0001 description: エラーコード reason: type: string enum: - チャプターデータのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0002 properties: errorCode: type: string enum: - MVOD_CHA_0002 description: エラーコード reason: type: string enum: - 指定されたデータが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0003 properties: errorCode: type: string enum: - MVOD_CHA_0003 description: エラーコード reason: type: string enum: - チャプターファイルのファイルサイズが制限(50 MB)を超えています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0012 properties: errorCode: type: string enum: - MVOD_CHA_0012 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツにチャプターを追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0013 properties: errorCode: type: string enum: - MVOD_CHA_0013 description: エラーコード reason: type: string enum: - 新規作成の場合は、チャプターテキスト(text)は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - text([value])は 1 <= text <= 1024 の長さである必要があります。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PUT 'https://${end_point}/contents/{content_id}/chapter' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "key": "tmp:xxxxxxxxx", "label": "日本語" }' summary: チャプターファイル登録 description: チャプターファイルを登録します。 post: tags: - chapter_service operationId: post-contents-{content_id}-chapter parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: label: type: string description: チャプターラベル deprecated: false maxLength: 1024 minLength: 1 is_enabled: type: boolean description: チャプター表示設定 trueのとき公開されます deprecated: false items: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false text: type: string description: チャプターテキスト deprecated: false maxLength: 1024 minLength: 1 order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 required: - begin - text example: begin: '00:00:00.000' text: '- Where are we now?' order: 0 contentType: application/json description: チャプターデータリスト deprecated: false apply: type: boolean description: 公開設定 trueのとき編集後の内容を一般に公開します deprecated: false nullable: true required: - label - is_enabled example: label: 第1章 is_enabled: false items: - begin: '00:00:00.000' text: '- Where are we now?' order: 0 apply: false contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0001 properties: errorCode: type: string enum: - MVOD_CHA_0001 description: エラーコード reason: type: string enum: - チャプターデータのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0008 properties: errorCode: type: string enum: - MVOD_CHA_0008 description: エラーコード reason: type: string enum: - チャプターデータが空の状態で公開できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0009 properties: errorCode: type: string enum: - MVOD_CHA_0009 description: エラーコード reason: type: string enum: - チャプターデータリストに重複したデータが存在するため追加/編集できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0012 properties: errorCode: type: string enum: - MVOD_CHA_0012 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツにチャプターを追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/contents/{content_id}/chapter' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "label": "第1章", "is_enabled": false, "items": [ { "begin": "00:00:00.000", "text": "- Where are we now?", "order": 0 } ], "apply": false }' summary: チャプター登録 description: チャプターを新規作成します。チャプターが既に存在する場合は上書きされます。 delete: tags: - chapter_service operationId: delete-contents-{content_id}-chapter parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: f5c14cc9-4808-4c86-b2fd-de63ae72a6a0 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0005 properties: errorCode: type: string enum: - MVOD_CHA_0005 description: エラーコード reason: type: string enum: - 存在しないチャプターが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X DELETE 'https://${end_point}/contents/{content_id}/chapter' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: チャプター削除 description: チャプターを削除します。 patch: tags: - chapter_service operationId: patch-contents-{content_id}-chapter parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: label: type: string description: チャプターラベル deprecated: false maxLength: 1024 minLength: 1 nullable: true is_enabled: type: boolean description: チャプター表示設定 trueのとき公開されます deprecated: false nullable: true items: type: array items: type: object properties: begin: type: string description: 開始時刻 deprecated: false text: type: string description: チャプターテキスト deprecated: false nullable: true order: type: integer description: 同開始時刻内の順序 deprecated: false default: 0 delete: type: boolean description: 削除フラグ trueのとき対応するレコードを削除します deprecated: false nullable: true required: - begin example: begin: '00:00:00.000' text: '- Where are we now?' order: 0 delete: false contentType: application/json description: チャプターデータリスト deprecated: false apply: type: boolean description: 公開設定 trueのとき編集後の内容を一般に公開します deprecated: false nullable: true example: label: 第1章 is_enabled: false items: - begin: '00:00:00.000' text: '- Where are we now?' order: 0 delete: false apply: false contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0001 properties: errorCode: type: string enum: - MVOD_CHA_0001 description: エラーコード reason: type: string enum: - チャプターデータのフォーマットが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0009 properties: errorCode: type: string enum: - MVOD_CHA_0009 description: エラーコード reason: type: string enum: - チャプターデータリストに重複したデータが存在するため追加/編集できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0010 properties: errorCode: type: string enum: - MVOD_CHA_0010 description: エラーコード reason: type: string enum: - 新規追加するチャプターデータの終了時刻はnullにできません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0012 properties: errorCode: type: string enum: - MVOD_CHA_0012 description: エラーコード reason: type: string enum: - 指定したメディアタイプのコンテンツにチャプターを追加できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0013 properties: errorCode: type: string enum: - MVOD_CHA_0013 description: エラーコード reason: type: string enum: - 新規作成の場合は、チャプターテキスト(text)は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - text([value])は 1 <= text <= 1024 の長さである必要があります。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0005 properties: errorCode: type: string enum: - MVOD_CHA_0005 description: エラーコード reason: type: string enum: - 存在しないチャプターが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X PATCH 'https://${end_point}/contents/{content_id}/chapter' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "label": "第1章", "is_enabled": false, "items": [ { "begin": "00:00:00.000", "text": "- Where are we now?", "order": 0, "delete": false } ], "apply": false }' summary: チャプター編集 description: チャプターを編集します。 /contents/{content_id}/chapter/download: get: tags: - chapter_service operationId: get-contents-{content_id}-chapter-download parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: export_draft in: query description: trueのとき下書きを含んで出力します schema: type: boolean description: trueのとき下書きを含んで出力します deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: ダウンロードURL deprecated: false expires_at: type: string description: ダウンロードURLの有効期限 deprecated: false required: - url - expires_at example: url: https://example.com expires_at: 2020-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0006 properties: errorCode: type: string enum: - MVOD_CHA_0006 description: エラーコード reason: type: string enum: - 未公開のチャプターが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MVOD_CHA_0004 properties: errorCode: type: string enum: - MVOD_CHA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CHA_0005 properties: errorCode: type: string enum: - MVOD_CHA_0005 description: エラーコード reason: type: string enum: - 存在しないチャプターが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/contents/{content_id}/chapter/download?export_draft=False' -H 'Authorization: Bearer {access_token}' summary: チャプターダウンロードURLを取得 description: チャプターをダウンロードURLを取得する /contents/{content_id}/preview/html: post: tags: - preview operationId: post-contents-{content_id}-preview-html parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: 簡易視聴URL deprecated: false required: - url example: url: >- https://preview.millvi.com/7ZaOhA0Q0tMTqHC8ExpOLDEdetCb3zKzQYFHIh9RpuI= contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PPH_0002 properties: errorCode: type: string enum: - MVOD_PPH_0002 description: エラーコード reason: type: string enum: - フォルダコンテンツの簡易視聴ページは生成できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CNT_0006 properties: errorCode: type: string enum: - MVOD_CNT_0006 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_PPH_0001 properties: errorCode: type: string enum: - MVOD_PPH_0001 description: エラーコード reason: type: string enum: - この条件で簡易視聴ページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/contents/{content_id}/preview/html' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c" }' summary: VOD簡易視聴ページURL発行 description: VODコンテンツ簡易視聴ページのURLを返します。 /contents/{content_id}/iframe: post: tags: - iframe operationId: post-contents-{content_id}-iframe parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: iframe_tag: type: string description: iframeタグ deprecated: false required: - iframe_tag example: iframe_tag: >- contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_IPH_0002 properties: errorCode: type: string enum: - MVOD_IPH_0002 description: エラーコード reason: type: string enum: - フォルダコンテンツのiframeページは生成できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_CNT_0006 properties: errorCode: type: string enum: - MVOD_CNT_0006 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_IPH_0001 properties: errorCode: type: string enum: - MVOD_IPH_0001 description: エラーコード reason: type: string enum: - この条件でiframeページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/contents/{content_id}/iframe' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c" }' summary: VOD視聴用iframe発行 description: VODコンテンツ視聴用のiframeを発行します。 /file/upload/tmp: get: tags: - file_upload_service operationId: get-file-upload-tmp parameters: - name: url_expires_in_seconds in: query description: URLの有効期限を秒単位で指定します。 schema: type: integer description: URLの有効期限を秒単位で指定します。 deprecated: false maximum: 10800 minimum: 1 default: 300 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: アップロードURL deprecated: false key: type: string description: アップロードデータの保存先情報 deprecated: false expires_at: type: string description: 有効期限 deprecated: false required: - url - key - expires_at example: url: https://example.millvi.com key: tmp:xxxxxxxxx expires_at: 2020-01-01T00:00:00.000000+0900 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/file/upload/tmp?url_expires_in_seconds=300' -H 'Authorization: Bearer {access_token}' summary: 一時アップロードURL取得 description: 一時アップロードURLを取得する /file/upload/tmp/multipart: get: tags: - file_upload_service operationId: get-file-upload-tmp-multipart parameters: - name: chunk_file_count in: query description: チャンク数。何個に分割してアップロードするかを指定します。上限は`500`です。 required: true schema: type: integer description: チャンク数。何個に分割してアップロードするかを指定します。上限は`500`です。 deprecated: false maximum: 500 minimum: 1 - name: url_expires_in_seconds in: query description: URLの有効期限を秒単位で指定します。 schema: type: integer description: URLの有効期限を秒単位で指定します。 deprecated: false maximum: 10800 minimum: 1 default: 3600 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: urls: type: array items: type: string description: アップロードURL deprecated: false key: type: string description: アップロードデータの保存先情報 deprecated: false expires_at: type: string description: 有効期限 deprecated: false upload_id: type: string description: アップロードID deprecated: false required: - urls - key - expires_at - upload_id example: urls: - https://example.com key: tmp:xxxxxxxxx expires_at: 2020-01-01T00:00:00.000000+0900 upload_id: nl5vrMWgBDUFOa9P contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/file/upload/tmp/multipart?chunk_file_count=10&url_expires_in_seconds=3600' -H 'Authorization: Bearer {access_token}' summary: 一時マルチパートアップロードURL取得 description: 一時マルチパートアップロードURLを取得する /player: get: tags: - player_customization_service operationId: get-player responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: プレイヤー設定の数 deprecated: false items: type: array items: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false player_name: type: string description: プレイヤー名 deprecated: false player_type: type: string enum: - video - pdf - audio description: プレイヤータイプ deprecated: false aspect_ratio: type: string enum: - '16:9' - '4:3' - '9:16' - '3:4' - FIXED_SIZE - RESPONSIVE description: アスペクト比 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false height: type: integer description: >- 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。
`player_engine`が`browser_native`のときは音声プレイヤーで無効になります。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: >- クロムレス
Videoプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true autoplay: type: boolean description: >- 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。この設定が有効の場合は`muted`はtrueに設定されます。 deprecated: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 nullable: true fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーで有効になります。 deprecated: false nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playback_rates: type: array items: type: number description: >- 速度設定
VideoとAudioプレイヤーで有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true is_default: type: boolean description: デフォルトプレイヤーフラグ deprecated: false nullable: true style: type: string enum: - bar - circle description: >- プレイヤースタイル
Audioプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true continuous: type: boolean description: >- 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false nullable: true required: - player_id - player_name - player_type - aspect_ratio - created_at - updated_at example: player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json description: プレイヤー設定一覧 deprecated: false required: - total_count - items example: total_count: 1 items: - player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/player' -H 'Authorization: Bearer {access_token}' summary: プレイヤーリスト取得 description: プレイヤーリストを取得します delete: tags: - player_customization_service operationId: delete-player parameters: [] requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false required: - player_id example: player_id: 4 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false required: - player_id example: player_id: 4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0006 properties: errorCode: type: string enum: - MVOD_PLY_0006 description: エラーコード reason: type: string enum: - システムデフォルトのプレイヤーが指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/player' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 4 }' summary: プレイヤー削除 description: 指定されたIDのプレイヤーを削除します post: tags: - player_customization_service operationId: post-player parameters: [] requestBody: content: application/json: schema: type: object properties: player_name: type: string description: プレイヤー名 deprecated: false maxLength: 1024 minLength: 1 player_type: type: string enum: - video - pdf - audio description: プレイヤータイプ deprecated: false fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーで有効になります。 deprecated: false default: true nullable: true aspect_ratio: type: string enum: - '16:9' - '4:3' - '9:16' - '3:4' - FIXED_SIZE - RESPONSIVE description: >- アスペクト比
`RESPONSIVE`はAudioプレイヤーのみ有効です。
Audioプレイヤーには`RESPONSIVE`と`FIXED_SIZE`のみ設定できます。 deprecated: false default: '16:9' nullable: true height: type: integer description: >- 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: クロムレス
Videoプレイヤーのみ有効になります。 deprecated: false default: true nullable: true autoplay: type: boolean description: 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。 deprecated: false default: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false default: true nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false default: true nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false default: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 default: 0.7 nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playback_rates: type: array items: type: number description: 速度設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false default: auto nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false default: true nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false default: true nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。 deprecated: false default: false nullable: true style: type: string enum: - bar - circle description: プレイヤースタイル
Audioプレイヤーのみ有効になります。 deprecated: false nullable: true continuous: type: boolean description: 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false default: disabled nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false default: millvi nullable: true required: - player_name - player_type example: player_name: my_player_01 player_type: video fullscreen: true aspect_ratio: '16:9' height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 loop: false muted: false playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false player_name: type: string description: プレイヤー名 deprecated: false player_type: type: string enum: - video - pdf - audio description: プレイヤータイプ deprecated: false aspect_ratio: type: string enum: - '16:9' - '4:3' - '9:16' - '3:4' - FIXED_SIZE - RESPONSIVE description: アスペクト比 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false height: type: integer description: >- 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。
`player_engine`が`browser_native`のときは音声プレイヤーで無効になります。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: >- クロムレス
Videoプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true autoplay: type: boolean description: >- 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。この設定が有効の場合は`muted`はtrueに設定されます。 deprecated: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 nullable: true fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーで有効になります。 deprecated: false nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playback_rates: type: array items: type: number description: >- 速度設定
VideoとAudioプレイヤーで有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true is_default: type: boolean description: デフォルトプレイヤーフラグ deprecated: false nullable: true style: type: string enum: - bar - circle description: >- プレイヤースタイル
Audioプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true continuous: type: boolean description: >- 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false nullable: true required: - player_id - player_name - player_type - aspect_ratio - created_at - updated_at example: player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0001 properties: errorCode: type: string enum: - MVOD_PLY_0001 description: エラーコード reason: type: string enum: - プレイヤーは1000個を超えて作成できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0003 properties: errorCode: type: string enum: - MVOD_PLY_0003 description: エラーコード reason: type: string enum: - 固定サイズではwidth/heightの指定は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0004 properties: errorCode: type: string enum: - MVOD_PLY_0004 description: エラーコード reason: type: string enum: - 速度設定を利用できない契約です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0006 properties: errorCode: type: string enum: - MVOD_PLY_0006 description: エラーコード reason: type: string enum: - システムデフォルトのプレイヤーが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0007 properties: errorCode: type: string enum: - MVOD_PLY_0007 description: エラーコード reason: type: string enum: - プレイヤータイプとアスペクト比の組み合わせが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0008 properties: errorCode: type: string enum: - MVOD_PLY_0008 description: エラーコード reason: type: string enum: - 音声プレイヤーで固定サイズのとき、widthの指定は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0009 properties: errorCode: type: string enum: - MVOD_PLY_0009 description: エラーコード reason: type: string enum: - レジュームが有効の場合は、プリロードも有効(auto)に指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0010 properties: errorCode: type: string enum: - MVOD_PLY_0010 description: エラーコード reason: type: string enum: - 速度設定は0以上2倍以下で指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0011 properties: errorCode: type: string enum: - MVOD_PLY_0011 description: エラーコード reason: type: string enum: - millviプレイヤー以外を利用できない契約です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_PLY_0002 properties: errorCode: type: string enum: - MVOD_PLY_0002 description: エラーコード reason: type: string enum: - 同時に複数のプレイヤーは作成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/player' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_name": "my_player_01", "player_type": "video", "fullscreen": true, "aspect_ratio": "16:9", "height": 720, "width": 1240, "chromeless": true, "autoplay": true, "big_play_button": true, "controls": true, "show_title": false, "default_volume": 0.7, "loop": false, "muted": false, "playback_rates": [ 0.8, 1.0, 1.2 ], "preload": "auto", "seekable": true, "skip_enabled": true, "resume": false, "style": "bar", "continuous": false, "playlist_navigation": "disabled", "player_engine": "millvi" }' summary: プレイヤー新規作成 description: 指定された名前およびタイプのプレイヤーを追加します patch: tags: - player_customization_service operationId: patch-player parameters: [] requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false player_name: type: string description: プレイヤー名 deprecated: false maxLength: 1024 minLength: 1 nullable: true fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーでのみ有効になります。 deprecated: false nullable: true aspect_ratio: type: string enum: - '16:9' - '4:3' - '9:16' - '3:4' - FIXED_SIZE - RESPONSIVE description: >- アスペクト比
`RESPONSIVE`はAudioプレイヤーのみ有効です。
Audioプレイヤーには`RESPONSIVE`と`FIXED_SIZE`のみ設定できます。 deprecated: false nullable: true height: type: integer description: >- 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: クロムレス
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true autoplay: type: boolean description: 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。 deprecated: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playback_rates: type: array items: type: number description: 速度設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。 deprecated: false nullable: true style: type: string enum: - bar - circle description: プレイヤースタイル
Audioプレイヤーのみ有効になります。 deprecated: false nullable: true continuous: type: boolean description: 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false nullable: true required: - player_id example: player_id: 4 player_name: my_player_01 fullscreen: true aspect_ratio: '16:9' height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false player_name: type: string description: プレイヤー名 deprecated: false player_type: type: string enum: - video - pdf - audio description: プレイヤータイプ deprecated: false aspect_ratio: type: string enum: - '16:9' - '4:3' - '9:16' - '3:4' - FIXED_SIZE - RESPONSIVE description: アスペクト比 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false height: type: integer description: >- 高さ
バータイプの音声プレイヤーは48px固定となります。
サークルタイプの音声プレイヤーはwidthと同じ値に設定されます。
`player_engine`が`browser_native`のときは音声プレイヤーで無効になります。 deprecated: false nullable: true width: type: integer description: 幅 deprecated: false nullable: true chromeless: type: boolean description: >- クロムレス
Videoプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true autoplay: type: boolean description: >- 自動再生
Videoプレイヤーのみ有効になります。
Audioプレイヤーでは常に無効になります。この設定が有効の場合は`muted`はtrueに設定されます。 deprecated: false nullable: true big_play_button: type: boolean description: 再生アイコン
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true controls: type: boolean description: コントロールパネル
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true show_title: type: boolean description: タイトル表示
Videoプレイヤーのみ有効になります。 deprecated: false nullable: true default_volume: type: number description: ボリューム
VideoとAudioプレイヤーで有効になります。 deprecated: false maximum: 1 minimum: 0 nullable: true fullscreen: type: boolean description: 全画面表示
VideoとPDFプレイヤーで有効になります。 deprecated: false nullable: true loop: type: boolean description: リピート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true muted: type: boolean description: ミュート
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true playback_rates: type: array items: type: number description: >- 速度設定
VideoとAudioプレイヤーで有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true preload: type: string enum: - auto - metadata - none description: プリロード
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true seekable: type: boolean description: シーク可能設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true skip_enabled: type: boolean description: スキップボタン表示設定
VideoとAudioプレイヤーで有効になります。 deprecated: false nullable: true resume: type: boolean description: >- レジューム再生機能
VideoとAudioプレイヤーで有効になります。
レジュームがONの場合、プリロードをOFFに設定してもプリロードが実行されます。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true is_default: type: boolean description: デフォルトプレイヤーフラグ deprecated: false nullable: true style: type: string enum: - bar - circle description: >- プレイヤースタイル
Audioプレイヤーのみ有効になります。
`player_engine`が`browser_native`のときは無効になります。 deprecated: false nullable: true continuous: type: boolean description: >- 連続再生
プレイリストを再生するときに有効になります。
VideoとAudioプレイヤーで有効になります。 deprecated: false default: false nullable: true playlist_navigation: type: string enum: - disabled - always - before_end description: >- 前後のコンテンツへの導線表示設定
プレイリストを再生するときに有効になります。
Videoプレイヤーのみ有効になります。
`disabled`: 表示しない(デフォルト) / `always`: 常に表示 / `before_end`: 再生完了30秒前から表示 deprecated: false nullable: true player_engine: type: string enum: - millvi - browser_native description: >- プレイヤー種別
VideoプレイヤーとAudioプレイヤーで有効になります。PDFプレイヤーでは`millvi`に固定になります。 deprecated: false nullable: true required: - player_id - player_name - player_type - aspect_ratio - created_at - updated_at example: player_id: 3 player_name: my_player_01 player_type: video aspect_ratio: '16:9' created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 height: 720 width: 1240 chromeless: true autoplay: true big_play_button: true controls: true show_title: false default_volume: 0.7 fullscreen: true loop: false muted: true playback_rates: - 0.8 - 1 - 1.2 preload: auto seekable: true skip_enabled: true resume: false is_default: false style: bar continuous: false playlist_navigation: disabled player_engine: millvi contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0003 properties: errorCode: type: string enum: - MVOD_PLY_0003 description: エラーコード reason: type: string enum: - 固定サイズではwidth/heightの指定は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0004 properties: errorCode: type: string enum: - MVOD_PLY_0004 description: エラーコード reason: type: string enum: - 速度設定を利用できない契約です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0006 properties: errorCode: type: string enum: - MVOD_PLY_0006 description: エラーコード reason: type: string enum: - システムデフォルトのプレイヤーが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0007 properties: errorCode: type: string enum: - MVOD_PLY_0007 description: エラーコード reason: type: string enum: - プレイヤータイプとアスペクト比の組み合わせが不正です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0008 properties: errorCode: type: string enum: - MVOD_PLY_0008 description: エラーコード reason: type: string enum: - 音声プレイヤーで固定サイズのとき、widthの指定は必須です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0009 properties: errorCode: type: string enum: - MVOD_PLY_0009 description: エラーコード reason: type: string enum: - レジュームが有効の場合は、プリロードも有効(auto)に指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0010 properties: errorCode: type: string enum: - MVOD_PLY_0010 description: エラーコード reason: type: string enum: - 速度設定は0以上2倍以下で指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0011 properties: errorCode: type: string enum: - MVOD_PLY_0011 description: エラーコード reason: type: string enum: - millviプレイヤー以外を利用できない契約です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/player' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 4, "player_name": "my_player_01", "fullscreen": true, "aspect_ratio": "16:9", "height": 720, "width": 1240, "chromeless": true, "autoplay": true, "big_play_button": true, "controls": true, "show_title": false, "default_volume": 0.7, "loop": false, "muted": true, "playback_rates": [ 0.8, 1.0, 1.2 ], "preload": "auto", "seekable": true, "skip_enabled": true, "resume": false, "style": "bar", "continuous": false, "playlist_navigation": "disabled", "player_engine": "millvi" }' summary: プレイヤー更新 description: 指定したプレイヤーIDの設定を更新します /security/contents: get: tags: - contents_security_service operationId: get-security-contents responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: コンテンツセキュリティ設定の数 deprecated: false items: type: array items: type: object properties: security_config_name: type: string description: セキュリティ設定名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false allowed_ip_address: type: array items: type: string description: IPホワイトリスト deprecated: false allowed_domain: type: array items: type: string description: ドメインホワイトリスト deprecated: false security_config_id: type: string description: セキュリティ設定ID デフォルトセキュリティ設定の場合にnullになります deprecated: false nullable: true required: - security_config_name - created_at - updated_at example: security_config_name: セキュリティ設定_1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' allowed_ip_address: - 10.0.0.2 - 192.168.0.1/24 allowed_domain: - millvi.com security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json description: コンテンツセキュリティ設定一覧 deprecated: false required: - total_count - items example: total_count: 1 items: - security_config_name: セキュリティ設定_1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' allowed_ip_address: - 10.0.0.2 - 192.168.0.1/24 allowed_domain: - millvi.com security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/security/contents' -H 'Authorization: Bearer {access_token}' summary: コンテンツセキュリティ設定一覧を取得 description: コンテンツセキュリティ設定一覧を取得します post: tags: - contents_security_service operationId: post-security-contents parameters: [] requestBody: content: application/json: schema: type: object properties: security_config_name: type: string description: セキュリティ設定名 deprecated: false maxLength: 1024 minLength: 1 allowed_ip_address: type: array items: type: string description: IPホワイトリスト deprecated: false nullable: true allowed_domain: type: array items: type: string description: ドメインホワイトリスト。
ドメインの先頭にワイルドカード(`*`)を指定可能で、IPアドレスでの指定も可能です。 deprecated: false nullable: true required: - security_config_name example: security_config_name: セキュリティ設定_1 allowed_ip_address: - 10.0.0.2 - 192.168.0.0/24 allowed_domain: - millvi.com contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: security_config_name: type: string description: セキュリティ設定名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false allowed_ip_address: type: array items: type: string description: IPホワイトリスト deprecated: false allowed_domain: type: array items: type: string description: ドメインホワイトリスト deprecated: false security_config_id: type: string description: セキュリティ設定ID デフォルトセキュリティ設定の場合にnullになります deprecated: false nullable: true required: - security_config_name - created_at - updated_at example: security_config_name: セキュリティ設定_1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' allowed_ip_address: - 10.0.0.2 - 192.168.0.1/24 allowed_domain: - millvi.com security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0001 properties: errorCode: type: string enum: - MVOD_SEC_0001 description: エラーコード reason: type: string enum: - 不正なIPアドレスの書式です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0002 properties: errorCode: type: string enum: - MVOD_SEC_0002 description: エラーコード reason: type: string enum: - 不正なドメインの書式です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/security/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "security_config_name": "セキュリティ設定_1", "allowed_ip_address": [ "10.0.0.2", "192.168.0.0/24" ], "allowed_domain": [ "millvi.com" ] }' summary: コンテンツセキュリティ設定を作成 description: コンテンツセキュリティ設定を作成します patch: tags: - contents_security_service operationId: patch-security-contents parameters: [] requestBody: content: application/json: schema: type: object properties: security_config_name: type: string description: セキュリティ設定名 deprecated: false maxLength: 1024 minLength: 1 nullable: true allowed_ip_address: type: array items: type: string description: IPホワイトリスト deprecated: false nullable: true allowed_domain: type: array items: type: string description: ドメインホワイトリスト。
ドメインの先頭にワイルドカード(`*`)を指定可能で、IPアドレスでの指定も可能です。 deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID 無指定の場合、デフォルト設定を更新します deprecated: false nullable: true example: security_config_name: セキュリティ設定_1 allowed_ip_address: - 10.0.0.2 - 192.168.0.0/24 allowed_domain: - millvi.com security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: security_config_name: type: string description: セキュリティ設定名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false allowed_ip_address: type: array items: type: string description: IPホワイトリスト deprecated: false allowed_domain: type: array items: type: string description: ドメインホワイトリスト deprecated: false security_config_id: type: string description: セキュリティ設定ID デフォルトセキュリティ設定の場合にnullになります deprecated: false nullable: true required: - security_config_name - created_at - updated_at example: security_config_name: セキュリティ設定_1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' allowed_ip_address: - 10.0.0.2 - 192.168.0.1/24 allowed_domain: - millvi.com security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[security_config_id] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0001 properties: errorCode: type: string enum: - MVOD_SEC_0001 description: エラーコード reason: type: string enum: - 不正なIPアドレスの書式です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0002 properties: errorCode: type: string enum: - MVOD_SEC_0002 description: エラーコード reason: type: string enum: - 不正なドメインの書式です。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/security/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "security_config_name": "セキュリティ設定_1", "allowed_ip_address": [ "10.0.0.2", "192.168.0.0/24" ], "allowed_domain": [ "millvi.com" ], "security_config_id": "b2a87e37-1ec5-431f-9d59-2717f7363ee4" }' summary: コンテンツセキュリティ設定を更新 description: コンテンツセキュリティ設定を更新します delete: tags: - contents_security_service operationId: delete-security-contents parameters: [] requestBody: content: application/json: schema: type: object properties: security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 required: - security_config_id example: security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: security_config_id: type: string description: セキュリティ設定ID deprecated: false required: - security_config_id example: security_config_id: b2a87e37-1ec5-431f-9d59-2717f7363ee4 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/security/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "security_config_id": "b2a87e37-1ec5-431f-9d59-2717f7363ee4" }' summary: コンテンツセキュリティ設定を削除 description: コンテンツセキュリティ設定を削除します /live/contents: get: tags: - live_content_service operationId: get-live-contents parameters: - name: content_id in: query description: コンテンツのIDで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのIDで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: title in: query description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: コンテンツの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: tags in: query description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 schema: type: string description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 deprecated: false nullable: true - name: live_status in: query description: >- ライブメッセージステータス(`UNDECIDED`,`BEFORE`,`STREAMING`,`SUSPENDED`,`FINISHED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメッセージステータスを指定した場合無視されます。 schema: type: string description: >- ライブメッセージステータス(`UNDECIDED`,`BEFORE`,`STREAMING`,`SUSPENDED`,`FINISHED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメッセージステータスを指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_types in: query description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 schema: type: string description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 deprecated: false nullable: true - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 - name: sort_by in: query description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 schema: type: string enum: - public_setting.start - updated_at - created_at - score - title description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: page_size in: query description: 1ページあたりのコンテンツ数 schema: type: integer description: 1ページあたりのコンテンツ数 deprecated: false maximum: 200 minimum: 1 default: 20 - name: page in: query description: ページ番号 schema: type: integer description: ページ番号 deprecated: false maximum: 100000000 minimum: 1 default: 1 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false live_status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: >- ライブメッセージステータス
ステータス状態
UNDECIDED配信未定
BEFORE配信前
STREAMING配信中
SUSPENDED配信中断
FINISHED配信終了
deprecated: false rtmp_urls: type: array items: type: string description: RTMPサーバーのエンドポイント deprecated: false nullable: true stream_key: type: string description: ストリームキー deprecated: false nullable: true created_at: type: string description: 登録日 deprecated: false nullable: true updated_at: type: string description: 更新日 deprecated: false nullable: true description: type: string description: 説明文 deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false default: false nullable: true dvr: type: boolean description: DVR deprecated: false default: false nullable: true events: type: array items: type: object properties: event_id: type: string description: イベントID deprecated: false started_at: type: string description: 開始日時 deprecated: false nullable: true ended_at: type: string description: 終了日時 deprecated: false nullable: true status: type: string enum: - NOT_CREATED - JOB_QUEUED - ARCHIVING - ARCHIVED - ERROR_OCCURED description: アーカイブステータス deprecated: false default: NOT_CREATED nullable: true error_message: type: string description: エラーメッセージ deprecated: false nullable: true vod_content_id: type: string description: アーカイブコンテンツのコンテンツID deprecated: false nullable: true vod_content_exists: type: boolean description: アーカイブコンテンツが削除されず現存しているか deprecated: false nullable: true required: - event_id example: event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true contentType: application/json description: ライブイベント履歴 deprecated: false nullable: true live_channel_status: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: ライブチャンネルステータス deprecated: false nullable: true live_message: type: object properties: undecided: type: string description: 配信未定 deprecated: false default: '' before: type: string description: 配信前 deprecated: false default: '' streaming: type: string description: 配信中 deprecated: false default: '' suspended: type: string description: 配信中断 deprecated: false default: '' finished: type: string description: 配信終了 deprecated: false default: '' example: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 contentType: application/json description: ライブ配信時に表示するメッセージ deprecated: false nullable: true live_message_type: type: object properties: undecided: type: string enum: - MESSAGE - IMAGE description: 配信未定 deprecated: false default: MESSAGE before: type: string enum: - MESSAGE - IMAGE description: 配信前 deprecated: false default: MESSAGE streaming: type: string enum: - MESSAGE - IMAGE description: 配信中 deprecated: false default: MESSAGE suspended: type: string enum: - MESSAGE - IMAGE description: 配信中断 deprecated: false default: MESSAGE finished: type: string enum: - MESSAGE - IMAGE description: 配信終了 deprecated: false default: MESSAGE example: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE contentType: application/json description: >- ライブ配信時に表示するメッセージの種別。
`MESSAGE`の時は`live_message`のメッセージを表示します。
`IMAGE`の時は`live_message_image`の画像を表示します。
deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - content_id - title - live_status example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル live_status: BEFORE rtmp_urls: - rtmp://example.rtmp1.millvi.com/xxxx/xxxx - rtmp://example.rtmp2.millvi.com/xxxx/xxxx stream_key: xxxx created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 description: 説明 public_setting: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 tag: - tag1 - tag2 is_password_required: false archive: true dvr: true events: - event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true live_channel_status: RUNNING live_message: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE recipe_id: '1' thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: '' deprecated: false page: type: integer description: ページ番号 deprecated: false required: - total_count - items - page example: total_count: 1 items: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル live_status: BEFORE rtmp_urls: - rtmp://example.rtmp1.millvi.com/xxxx/xxxx - rtmp://example.rtmp2.millvi.com/xxxx/xxxx stream_key: xxxx created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 description: 説明 public_setting: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 tag: - tag1 - tag2 is_password_required: false archive: true dvr: true events: - event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true live_channel_status: RUNNING live_message: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE recipe_id: '1' thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg page: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/live/contents?content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&title=タイトル&description=説明文&tags=タグ１,タグ2&live_status=UNDECIDED,BEFORE,STREAMING,SUSPENDED,FINISHED&public_setting_types=public,private,period&thumbnail_url_expires_in_days=1000&sort_by=created_at&order=desc&page_size=200&page=1' -H 'Authorization: Bearer {access_token}' summary: ライブコンテンツ一覧取得 description: ライブコンテンツ一覧を取得します。 post: tags: - live_content_service operationId: post-live-contents parameters: [] requestBody: content: application/json: schema: type: object properties: title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 description: type: string description: 説明文 deprecated: false maxLength: 8192 default: '' tag: type: array items: type: string description: タグ。1文字以上256文字以内で設定してください。 deprecated: false nullable: true recipe_id: type: string description: レシピIDを指定してください。（指定されない場合はデフォルトのレシピが入ります） deprecated: false default: '2' public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ. deprecated: false start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: '2018-01-02T10:00:00+09:00' end: '2018-01-02T12:00:00+09:00' contentType: application/json description: 公開設定（ライブコンテンツ作成時に公開設定を指定しない場合は「公開タイプ：公開」となります。） deprecated: false nullable: true is_password_required: type: boolean description: コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false` deprecated: false default: false password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false default: false dvr: type: boolean description: DVR deprecated: false default: false live_message: type: object properties: undecided: type: string description: 配信未定用メッセージ deprecated: false maxLength: 4096 nullable: true before: type: string description: 配信前用メッセージ deprecated: false maxLength: 4096 nullable: true streaming: type: string description: 配信中用メッセージ deprecated: false maxLength: 4096 nullable: true suspended: type: string description: 配信中断用メッセージ deprecated: false maxLength: 4096 nullable: true finished: type: string description: 配信終了用メッセージ deprecated: false maxLength: 4096 nullable: true example: undecided: 次回の配信は未定です。 before: 10:00から配信されます。 streaming: 配信中です。 suspended: 13:00から再開します。 finished: 配信が終了しました。ありがとうございました。 contentType: application/json description: ライブ配信メッセージ deprecated: false nullable: true required: - title example: title: タイトル description: 説明 tag: - tag1 - tag2 recipe_id: '1' public_setting: type: period start: '2018-01-02T10:00:00+09:00' end: '2018-01-02T12:00:00+09:00' is_password_required: false password: password archive: true dvr: true live_message: undecided: 次回の配信は未定です。 before: 10:00から配信されます。 streaming: 配信中です。 suspended: 13:00から再開します。 finished: 配信が終了しました。ありがとうございました。 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false live_status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: >- ライブメッセージステータス
ステータス状態
UNDECIDED配信未定
BEFORE配信前
STREAMING配信中
SUSPENDED配信中断
FINISHED配信終了
deprecated: false rtmp_urls: type: array items: type: string description: RTMPサーバーのエンドポイント deprecated: false nullable: true stream_key: type: string description: ストリームキー deprecated: false nullable: true created_at: type: string description: 登録日 deprecated: false nullable: true updated_at: type: string description: 更新日 deprecated: false nullable: true description: type: string description: 説明文 deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false default: false nullable: true dvr: type: boolean description: DVR deprecated: false default: false nullable: true events: type: array items: type: object properties: event_id: type: string description: イベントID deprecated: false started_at: type: string description: 開始日時 deprecated: false nullable: true ended_at: type: string description: 終了日時 deprecated: false nullable: true status: type: string enum: - NOT_CREATED - JOB_QUEUED - ARCHIVING - ARCHIVED - ERROR_OCCURED description: アーカイブステータス deprecated: false default: NOT_CREATED nullable: true error_message: type: string description: エラーメッセージ deprecated: false nullable: true vod_content_id: type: string description: アーカイブコンテンツのコンテンツID deprecated: false nullable: true vod_content_exists: type: boolean description: アーカイブコンテンツが削除されず現存しているか deprecated: false nullable: true required: - event_id example: event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true contentType: application/json description: ライブイベント履歴 deprecated: false nullable: true live_channel_status: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: ライブチャンネルステータス deprecated: false nullable: true live_message: type: object properties: undecided: type: string description: 配信未定 deprecated: false default: '' before: type: string description: 配信前 deprecated: false default: '' streaming: type: string description: 配信中 deprecated: false default: '' suspended: type: string description: 配信中断 deprecated: false default: '' finished: type: string description: 配信終了 deprecated: false default: '' example: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 contentType: application/json description: ライブ配信時に表示するメッセージ deprecated: false nullable: true live_message_type: type: object properties: undecided: type: string enum: - MESSAGE - IMAGE description: 配信未定 deprecated: false default: MESSAGE before: type: string enum: - MESSAGE - IMAGE description: 配信前 deprecated: false default: MESSAGE streaming: type: string enum: - MESSAGE - IMAGE description: 配信中 deprecated: false default: MESSAGE suspended: type: string enum: - MESSAGE - IMAGE description: 配信中断 deprecated: false default: MESSAGE finished: type: string enum: - MESSAGE - IMAGE description: 配信終了 deprecated: false default: MESSAGE example: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE contentType: application/json description: >- ライブ配信時に表示するメッセージの種別。
`MESSAGE`の時は`live_message`のメッセージを表示します。
`IMAGE`の時は`live_message_image`の画像を表示します。
deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true live_message_image: type: object properties: undecided: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信未定の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true before: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信前の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true streaming: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true suspended: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中断の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true finished: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信終了の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true example: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: ライブ配信時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true required: - content_id - title - live_status example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル live_status: BEFORE rtmp_urls: - rtmp://example.rtmp1.millvi.com/xxxx/xxxx - rtmp://example.rtmp2.millvi.com/xxxx/xxxx stream_key: xxxx created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 description: 説明 public_setting: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 tag: - tag1 - tag2 is_password_required: false archive: true dvr: true events: - event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true live_channel_status: RUNNING live_message: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE recipe_id: '1' thumbnail_info: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg live_message_image: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0009 properties: errorCode: type: string enum: - MLIVE_CNT_0009 description: エラーコード reason: type: string enum: - ライブ契約が存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0016 properties: errorCode: type: string enum: - MLIVE_CNT_0016 description: エラーコード reason: type: string enum: - タグは1文字以上256文字以内で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0017 properties: errorCode: type: string enum: - MLIVE_CNT_0017 description: エラーコード reason: type: string enum: - ライブコンテンツには音声レシピを指定できません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0019 properties: errorCode: type: string enum: - MLIVE_CNT_0019 description: エラーコード reason: type: string enum: - タグが重複しています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。[Transaction failed] description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/live/contents' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "タイトル", "description": "説明", "tag": [ "tag1", "tag2" ], "recipe_id": "1", "public_setting": { "type": "period", "start": "2018-01-02T10:00:00+09:00", "end": "2018-01-02T12:00:00+09:00" }, "is_password_required": false, "password": "password", "archive": true, "dvr": true, "live_message": { "undecided": "次回の配信は未定です。", "before": "10:00から配信されます。", "streaming": "配信中です。", "suspended": "13:00から再開します。", "finished": "配信が終了しました。ありがとうございました。" } }' summary: ライブコンテンツ作成 description: ライブコンテンツを作成します。 /live/contents/csv: get: tags: - live_content_service operationId: get-live-contents-csv parameters: - name: content_id in: query description: コンテンツのIDで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのIDで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: title in: query description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: コンテンツの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: コンテンツの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: tags in: query description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 schema: type: string description: コンテンツのタグで取得対象を絞り込むときに指定します。タグはカンマ区切りで複数指定できます。 deprecated: false nullable: true - name: live_status in: query description: >- ライブメッセージステータス(`UNDECIDED`,`BEFORE`,`STREAMING`,`SUSPENDED`,`FINISHED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメッセージステータスを指定した場合無視されます。 schema: type: string description: >- ライブメッセージステータス(`UNDECIDED`,`BEFORE`,`STREAMING`,`SUSPENDED`,`FINISHED`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメッセージステータスを指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_types in: query description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 schema: type: string description: >- コンテンツが含む公開タイプ(`public`, `private`, `period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開タイプを指定した場合無視されます。 deprecated: false nullable: true - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 - name: sort_by in: query description: 並び替えに使用するフィールド schema: type: string enum: - public_setting.start - updated_at - created_at - score - title description: 並び替えに使用するフィールド deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false params: type: string description: CSV生成するAPIのパラメータをJSON形式に変換した文字列 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false created_at: type: string description: ジョブの作成日時 deprecated: false updated_at: type: string description: ジョブの更新日時 deprecated: false required: - job_id - api_path - params - status - created_at - updated_at example: job_id: 12ab34cd-56ef-78gh-90ij-12kl34mn56op api_path: /vod/contents/statistics params: '{"from": "2024-06-01", "to": "2024-06-30"}' status: generating created_at: '2024-06-01 00:00:00.000000+09:00' updated_at: '2024-06-01 00:00:00.000000+09:00' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0001 properties: errorCode: type: string enum: - MVOD_CSV_0001 description: エラーコード reason: type: string enum: - CSVファイルの生成に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0002 properties: errorCode: type: string enum: - MVOD_CSV_0002 description: エラーコード reason: type: string enum: - 現在進行中の変換処理が10個以上存在するためジョブを開始できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/live/contents/csv?content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&title=タイトル&description=説明文&tags=タグ１,タグ2&live_status=UNDECIDED,BEFORE,STREAMING,SUSPENDED,FINISHED&public_setting_types=public,private,period&thumbnail_url_expires_in_days=1000&sort_by=created_at&order=desc' -H 'Authorization: Bearer {access_token}' summary: ライブコンテンツ一覧CSV生成 description: |- ライブコンテンツ一覧CSVファイルの作成をリクエストします。
当APIはResponses記載のエラーの他、ライブコンテンツ一覧取得APIのエラーを返します。 /live/contents/{content_id}: patch: tags: - live_content_service operationId: patch-live-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 nullable: true description: type: string description: 説明文 deprecated: false maxLength: 8192 nullable: true tag: type: array items: type: string description: タグ。1文字以上256文字以内で設定してください。 deprecated: false nullable: true recipe_id: type: string description: レシピIDを指定してください。 deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ. deprecated: false start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: '2018-01-02T10:00:00+09:00' end: '2018-01-02T12:00:00+09:00' contentType: application/json description: 公開設定 deprecated: false nullable: true thumbnail_active_id: type: string description: 利用するサムネイルID deprecated: false nullable: true is_password_required: type: boolean description: コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false` deprecated: false nullable: true password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true live_status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: ライブステータス deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false nullable: true dvr: type: boolean description: DVR deprecated: false nullable: true live_message: type: object properties: undecided: type: string description: 配信未定用メッセージ deprecated: false maxLength: 4096 nullable: true before: type: string description: 配信前用メッセージ deprecated: false maxLength: 4096 nullable: true streaming: type: string description: 配信中用メッセージ deprecated: false maxLength: 4096 nullable: true suspended: type: string description: 配信中断用メッセージ deprecated: false maxLength: 4096 nullable: true finished: type: string description: 配信終了用メッセージ deprecated: false maxLength: 4096 nullable: true example: undecided: 次回の配信は未定です。 before: 10:00から配信されます。 streaming: 配信中です。 suspended: 13:00から再開します。 finished: 配信が終了しました。ありがとうございました。 contentType: application/json description: ライブ配信メッセージ deprecated: false nullable: true live_message_type: type: object properties: undecided: type: string enum: - MESSAGE - IMAGE description: 配信未定 deprecated: false nullable: true before: type: string enum: - MESSAGE - IMAGE description: 配信前 deprecated: false nullable: true streaming: type: string enum: - MESSAGE - IMAGE description: 配信中 deprecated: false nullable: true suspended: type: string enum: - MESSAGE - IMAGE description: 配信中断 deprecated: false nullable: true finished: type: string enum: - MESSAGE - IMAGE description: 配信終了 deprecated: false nullable: true example: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE contentType: application/json description: ステータスごとのメッセージタイプ deprecated: false nullable: true live_message_image_active_id: type: object properties: undecided: type: string description: 配信未定 deprecated: false nullable: true before: type: string description: 配信前 deprecated: false nullable: true streaming: type: string description: 配信中 deprecated: false nullable: true suspended: type: string description: 配信中断 deprecated: false nullable: true finished: type: string description: 配信終了 deprecated: false nullable: true example: undecided: '1' before: '1' streaming: '1' suspended: '1' finished: '1' contentType: application/json description: ステータスごとのアクティブな画像ID deprecated: false nullable: true example: title: タイトル description: 説明 tag: - tag1 - tag2 recipe_id: '1' public_setting: type: period start: '2018-01-02T10:00:00+09:00' end: '2018-01-02T12:00:00+09:00' thumbnail_active_id: '1' is_password_required: false password: password live_status: BEFORE archive: true dvr: true live_message: undecided: 次回の配信は未定です。 before: 10:00から配信されます。 streaming: 配信中です。 suspended: 13:00から再開します。 finished: 配信が終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE live_message_image_active_id: undecided: '1' before: '1' streaming: '1' suspended: '1' finished: '1' contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false live_status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: >- ライブメッセージステータス
ステータス状態
UNDECIDED配信未定
BEFORE配信前
STREAMING配信中
SUSPENDED配信中断
FINISHED配信終了
deprecated: false rtmp_urls: type: array items: type: string description: RTMPサーバーのエンドポイント deprecated: false nullable: true stream_key: type: string description: ストリームキー deprecated: false nullable: true created_at: type: string description: 登録日 deprecated: false nullable: true updated_at: type: string description: 更新日 deprecated: false nullable: true description: type: string description: 説明文 deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false default: false nullable: true dvr: type: boolean description: DVR deprecated: false default: false nullable: true events: type: array items: type: object properties: event_id: type: string description: イベントID deprecated: false started_at: type: string description: 開始日時 deprecated: false nullable: true ended_at: type: string description: 終了日時 deprecated: false nullable: true status: type: string enum: - NOT_CREATED - JOB_QUEUED - ARCHIVING - ARCHIVED - ERROR_OCCURED description: アーカイブステータス deprecated: false default: NOT_CREATED nullable: true error_message: type: string description: エラーメッセージ deprecated: false nullable: true vod_content_id: type: string description: アーカイブコンテンツのコンテンツID deprecated: false nullable: true vod_content_exists: type: boolean description: アーカイブコンテンツが削除されず現存しているか deprecated: false nullable: true required: - event_id example: event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true contentType: application/json description: ライブイベント履歴 deprecated: false nullable: true live_channel_status: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: ライブチャンネルステータス deprecated: false nullable: true live_message: type: object properties: undecided: type: string description: 配信未定 deprecated: false default: '' before: type: string description: 配信前 deprecated: false default: '' streaming: type: string description: 配信中 deprecated: false default: '' suspended: type: string description: 配信中断 deprecated: false default: '' finished: type: string description: 配信終了 deprecated: false default: '' example: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 contentType: application/json description: ライブ配信時に表示するメッセージ deprecated: false nullable: true live_message_type: type: object properties: undecided: type: string enum: - MESSAGE - IMAGE description: 配信未定 deprecated: false default: MESSAGE before: type: string enum: - MESSAGE - IMAGE description: 配信前 deprecated: false default: MESSAGE streaming: type: string enum: - MESSAGE - IMAGE description: 配信中 deprecated: false default: MESSAGE suspended: type: string enum: - MESSAGE - IMAGE description: 配信中断 deprecated: false default: MESSAGE finished: type: string enum: - MESSAGE - IMAGE description: 配信終了 deprecated: false default: MESSAGE example: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE contentType: application/json description: >- ライブ配信時に表示するメッセージの種別。
`MESSAGE`の時は`live_message`のメッセージを表示します。
`IMAGE`の時は`live_message_image`の画像を表示します。
deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true live_message_image: type: object properties: undecided: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信未定の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true before: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信前の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true streaming: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true suspended: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中断の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true finished: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信終了の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true example: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: ライブ配信時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true required: - content_id - title - live_status example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル live_status: BEFORE rtmp_urls: - rtmp://example.rtmp1.millvi.com/xxxx/xxxx - rtmp://example.rtmp2.millvi.com/xxxx/xxxx stream_key: xxxx created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 description: 説明 public_setting: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 tag: - tag1 - tag2 is_password_required: false archive: true dvr: true events: - event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true live_channel_status: RUNNING live_message: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE recipe_id: '1' thumbnail_info: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg live_message_image: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0009 properties: errorCode: type: string enum: - MLIVE_CNT_0009 description: エラーコード reason: type: string enum: - ライブ契約が存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0016 properties: errorCode: type: string enum: - MLIVE_CNT_0016 description: エラーコード reason: type: string enum: - タグは1文字以上256文字以内で設定してください。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0017 properties: errorCode: type: string enum: - MLIVE_CNT_0017 description: エラーコード reason: type: string enum: - ライブコンテンツには音声レシピを指定できません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0019 properties: errorCode: type: string enum: - MLIVE_CNT_0019 description: エラーコード reason: type: string enum: - タグが重複しています。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0020 properties: errorCode: type: string enum: - MLIVE_CNT_0020 description: エラーコード reason: type: string enum: - 指定されたステータスに該当する画像は存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0021 properties: errorCode: type: string enum: - MLIVE_CNT_0021 description: エラーコード reason: type: string enum: - 指定されたアクティブな画像は存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[thumbnail_active_id] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCP_0001 properties: errorCode: type: string enum: - MVOD_RCP_0001 description: エラーコード reason: type: string enum: - 存在しないレシピです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/live/contents/{content_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "タイトル", "description": "説明", "tag": [ "tag1", "tag2" ], "recipe_id": "1", "public_setting": { "type": "period", "start": "2018-01-02T10:00:00+09:00", "end": "2018-01-02T12:00:00+09:00" }, "thumbnail_active_id": "1", "is_password_required": false, "password": "password", "live_status": "BEFORE", "archive": true, "dvr": true, "live_message": { "undecided": "次回の配信は未定です。", "before": "10:00から配信されます。", "streaming": "配信中です。", "suspended": "13:00から再開します。", "finished": "配信が終了しました。ありがとうございました。" }, "live_message_type": { "undecided": "MESSAGE", "before": "MESSAGE", "streaming": "MESSAGE", "suspended": "MESSAGE", "finished": "MESSAGE" }, "live_message_image_active_id": { "undecided": "1", "before": "1", "streaming": "1", "suspended": "1", "finished": "1" } }' summary: ライブコンテンツ情報更新 description: ライブコンテンツ情報を更新します。 delete: tags: - live_content_service operationId: delete-live-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0010 properties: errorCode: type: string enum: - MLIVE_CNT_0010 description: エラーコード reason: type: string enum: - 削除できません。ライブのチャンネル状態を確認してください。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0018 properties: errorCode: type: string enum: - MLIVE_CNT_0018 description: エラーコード reason: type: string enum: - アーカイブ生成ジョブが進行中です。削除できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/live/contents/{content_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: ライブコンテンツ情報削除 description: ライブコンテンツ情報を削除します。 get: tags: - live_content_service operationId: get-live-contents-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: thumbnail_url_expires_in_days in: query description: サムネイルの期限付きURLの失効までの日数 schema: type: integer description: サムネイルの期限付きURLの失効までの日数 deprecated: false maximum: 36500 default: 7 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false live_status: type: string enum: - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: >- ライブメッセージステータス
ステータス状態
UNDECIDED配信未定
BEFORE配信前
STREAMING配信中
SUSPENDED配信中断
FINISHED配信終了
deprecated: false rtmp_urls: type: array items: type: string description: RTMPサーバーのエンドポイント deprecated: false nullable: true stream_key: type: string description: ストリームキー deprecated: false nullable: true created_at: type: string description: 登録日 deprecated: false nullable: true updated_at: type: string description: 更新日 deprecated: false nullable: true description: type: string description: 説明文 deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true tag: type: array items: type: string description: タグ deprecated: false nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: false nullable: true archive: type: boolean description: アーカイブ deprecated: false default: false nullable: true dvr: type: boolean description: DVR deprecated: false default: false nullable: true events: type: array items: type: object properties: event_id: type: string description: イベントID deprecated: false started_at: type: string description: 開始日時 deprecated: false nullable: true ended_at: type: string description: 終了日時 deprecated: false nullable: true status: type: string enum: - NOT_CREATED - JOB_QUEUED - ARCHIVING - ARCHIVED - ERROR_OCCURED description: アーカイブステータス deprecated: false default: NOT_CREATED nullable: true error_message: type: string description: エラーメッセージ deprecated: false nullable: true vod_content_id: type: string description: アーカイブコンテンツのコンテンツID deprecated: false nullable: true vod_content_exists: type: boolean description: アーカイブコンテンツが削除されず現存しているか deprecated: false nullable: true required: - event_id example: event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true contentType: application/json description: ライブイベント履歴 deprecated: false nullable: true live_channel_status: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: ライブチャンネルステータス deprecated: false nullable: true live_message: type: object properties: undecided: type: string description: 配信未定 deprecated: false default: '' before: type: string description: 配信前 deprecated: false default: '' streaming: type: string description: 配信中 deprecated: false default: '' suspended: type: string description: 配信中断 deprecated: false default: '' finished: type: string description: 配信終了 deprecated: false default: '' example: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 contentType: application/json description: ライブ配信時に表示するメッセージ deprecated: false nullable: true live_message_type: type: object properties: undecided: type: string enum: - MESSAGE - IMAGE description: 配信未定 deprecated: false default: MESSAGE before: type: string enum: - MESSAGE - IMAGE description: 配信前 deprecated: false default: MESSAGE streaming: type: string enum: - MESSAGE - IMAGE description: 配信中 deprecated: false default: MESSAGE suspended: type: string enum: - MESSAGE - IMAGE description: 配信中断 deprecated: false default: MESSAGE finished: type: string enum: - MESSAGE - IMAGE description: 配信終了 deprecated: false default: MESSAGE example: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE contentType: application/json description: >- ライブ配信時に表示するメッセージの種別。
`MESSAGE`の時は`live_message`のメッセージを表示します。
`IMAGE`の時は`live_message_image`の画像を表示します。
deprecated: false nullable: true recipe_id: type: string description: レシピID deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true live_message_image: type: object properties: undecided: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信未定の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true before: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信前の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true streaming: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true suspended: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信中断の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true finished: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: 配信終了の時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true example: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: ライブ配信時に表示するサムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true required: - content_id - title - live_status example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: タイトル live_status: BEFORE rtmp_urls: - rtmp://example.rtmp1.millvi.com/xxxx/xxxx - rtmp://example.rtmp2.millvi.com/xxxx/xxxx stream_key: xxxx created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 description: 説明 public_setting: type: period start: 2018-01-02T10:00:00.000000+0900 end: 2018-01-02T12:00:00.000000+0900 tag: - tag1 - tag2 is_password_required: false archive: true dvr: true events: - event_id: '12345' started_at: '2018-01-02T09:00:00+09:00' ended_at: '2018-01-02T12:00:00+09:00' status: NOT_CREATED error_message: エラーが発生しました vod_content_id: vod_content_id vod_content_exists: true live_channel_status: RUNNING live_message: undecided: 次回の配信は未定です。 before: 10時から配信します。 streaming: 配信中です suspended: 昼休憩です。13時から再開します。 finished: 配信は終了しました。ありがとうございました。 live_message_type: undecided: MESSAGE before: MESSAGE streaming: MESSAGE suspended: MESSAGE finished: MESSAGE recipe_id: '1' thumbnail_info: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg live_message_image: undecided: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg before: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg streaming: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg suspended: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg finished: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/live/contents/{content_id}?thumbnail_url_expires_in_days=1000' -H 'Authorization: Bearer {access_token}' summary: ライブコンテンツ詳細情報取得 description: |- ライブコンテンツ詳細情報を取得します。 コンテンツが存在しない場合はステータスコード200で`null`を返します。 /live/contents/{content_id}/thumbnails: post: tags: - live_content_service operationId: post-live-contents-{content_id}-thumbnails parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: upload_info: type: object properties: file_name: type: string description: アップロードするファイル名
`key`を指定する場合は必須です。 deprecated: false maxLength: 255 minLength: 1 key: type: string description: アップロードデータの保存先情報 deprecated: false minLength: 1 required: - file_name - key example: file_name: origin_file.jpg key: tmp:xxxxxxxxx contentType: application/json description: アップロード情報 deprecated: false activates: type: boolean description: 登録したサムネイルをactiveにするかどうか指定します。 deprecated: false default: true thumbnail_type: type: string enum: - LIVE_CONTENT - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: サムネイルのタイプ deprecated: false default: LIVE_CONTENT required: - upload_info example: upload_info: file_name: origin_file.jpg key: tmp:xxxxxxxxx activates: true thumbnail_type: LIVE_CONTENT contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: false id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報 deprecated: false required: - content_id - thumbnail_info example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 thumbnail_info: - path: >- /a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0026 properties: errorCode: type: string enum: - MVOD_CMN_0026 description: エラーコード reason: type: string enum: - リクエストキーが無効です。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0003 properties: errorCode: type: string enum: - MVOD_RCT_0003 description: エラーコード reason: type: string enum: - 最低1つのサムネイルを有効にする必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0005 properties: errorCode: type: string enum: - MVOD_RCT_0005 description: エラーコード reason: type: string enum: - アップロードされた画像に拡張子がありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0006 properties: errorCode: type: string enum: - MVOD_RCT_0006 description: エラーコード reason: type: string enum: - アップロードされたファイルの拡張子が画像ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_RCT_0007 properties: errorCode: type: string enum: - MVOD_RCT_0007 description: エラーコード reason: type: string enum: - アップロードされたファイルのメディアタイプが画像ではありません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0014 properties: errorCode: type: string enum: - MVOD_CMN_0014 description: エラーコード reason: type: string enum: - データの登録に失敗しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/live/contents/{content_id}/thumbnails' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "upload_info": { "file_name": "origin_file.jpg", "key": "tmp:xxxxxxxxx" }, "activates": true, "thumbnail_type": "LIVE_CONTENT" }' summary: ライブコンテンツサムネイル登録 description: ライブコンテンツサムネイルを登録します。登録したサムネイルはidが最大のものです。 delete: tags: - live_content_service operationId: delete-live-contents-{content_id}-thumbnails parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: thumbnail_ids: type: array items: type: string description: 削除対象サムネイルID deprecated: false thumbnail_type: type: string enum: - LIVE_CONTENT - UNDECIDED - BEFORE - STREAMING - SUSPENDED - FINISHED description: サムネイルのタイプ deprecated: false default: LIVE_CONTENT required: - thumbnail_ids example: thumbnail_ids: - '1' - '2' - '3' thumbnail_type: LIVE_CONTENT contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false thumbnail_ids: type: array items: type: string description: 削除されたサムネイルID一覧 deprecated: false required: - content_id - thumbnail_ids example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 thumbnail_ids: - '1' - '2' - '3' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CNT_0011 properties: errorCode: type: string enum: - MVOD_CNT_0011 description: エラーコード reason: type: string enum: - アクティブなサムネイルを削除できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0015 properties: errorCode: type: string enum: - MLIVE_CNT_0015 description: エラーコード reason: type: string enum: - 存在しないサムネイルIDです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X DELETE 'https://${end_point}/live/contents/{content_id}/thumbnails' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "thumbnail_ids": [ "1", "2", "3" ], "thumbnail_type": "LIVE_CONTENT" }' summary: ライブ用サムネイル画像削除 description: ライブ用サムネイル画像を削除する。(複数指定可能)
ただし、使用しているサムネイルは削除できません。 /live/contents/{content_id}/preview/html: post: tags: - preview operationId: post-live-contents-{content_id}-preview-html parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: 簡易視聴URL deprecated: false required: - url example: url: >- https://preview.millvi.com/7ZaOhA0Q0tMTqHC8ExpOLDEdetCb3zKzQYFHIh9RpuI= contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_PPH_0001 properties: errorCode: type: string enum: - MVOD_PPH_0001 description: エラーコード reason: type: string enum: - この条件で簡易視聴ページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/live/contents/{content_id}/preview/html' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c" }' summary: ライブ簡易視聴ページURL発行 description: ライブコンテンツ簡易視聴ページのURLを返します。 /live/contents/{content_id}/iframe: post: tags: - iframe operationId: post-live-contents-{content_id}-iframe parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: iframe_tag: type: string description: iframeタグ deprecated: false required: - iframe_tag example: iframe_tag: >- contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_IPH_0001 properties: errorCode: type: string enum: - MVOD_IPH_0001 description: エラーコード reason: type: string enum: - この条件でiframeページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/live/contents/{content_id}/iframe' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "4a5801b1-f76e-44a5-8f1a-2d50f6a47c4c" }' summary: LIVE視聴用iframe発行 description: LIVEコンテンツ視聴用のiframeを発行します。 /live/contents/{content_id}/{event_id}/archive: post: tags: - live_content_service operationId: post-live-contents-{content_id}-{event_id}-archive parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false - name: event_id in: path description: イベントID required: true schema: type: string description: イベントID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false channel_state: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: チャンネルステータス deprecated: false nullable: true required: - content_id example: content_id: contentid channel_state: IDLE contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0012 properties: errorCode: type: string enum: - MLIVE_CNT_0012 description: エラーコード reason: type: string enum: - アーカイブ処理ができないイベントステータスです。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0005 properties: errorCode: type: string enum: - MLIVE_CNT_0005 description: エラーコード reason: type: string enum: - 存在しないコンテンツです。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CNT_0011 properties: errorCode: type: string enum: - MLIVE_CNT_0011 description: エラーコード reason: type: string enum: - 存在しないライブイベントです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MLIVE_CNT_0013 properties: errorCode: type: string enum: - MLIVE_CNT_0013 description: エラーコード reason: type: string enum: - アーカイブ処理に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/live/contents/{content_id}/{event_id}/archive' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: ライブアーカイブ処理 description: 指定したイベントIDのアーカイブ処理を行います。 /live/channels: get: tags: - live_channel_service operationId: get-live-channels parameters: - name: content_id in: query description: コンテンツID schema: type: string description: コンテンツID deprecated: false nullable: true responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false channel_state: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: チャンネルステータス deprecated: false nullable: true required: - content_id example: content_id: contentid channel_state: IDLE contentType: application/json description: ライブチャンネル情報リスト deprecated: false required: - total_count - items example: total_count: 1 items: - content_id: contentid channel_state: IDLE contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/live/channels?content_id=contentid' -H 'Authorization: Bearer {access_token}' summary: ライブチャンネル詳細リスト取得 description: ライブチャンネル詳細リスト取得を取得します。 post: tags: - live_channel_service operationId: post-live-channels parameters: [] requestBody: content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false minLength: 1 required: - content_id example: content_id: contentid contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false channel_state: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: チャンネルステータス deprecated: false nullable: true required: - content_id example: content_id: contentid channel_state: IDLE contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CHN_0002 properties: errorCode: type: string enum: - MLIVE_CHN_0002 description: エラーコード reason: type: string enum: - すでにチャンネルが存在します。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CHN_0003 properties: errorCode: type: string enum: - MLIVE_CHN_0003 description: エラーコード reason: type: string enum: - チャンネル数の上限を超えています。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CHN_0008 properties: errorCode: type: string enum: - MLIVE_CHN_0008 description: エラーコード reason: type: string enum: - ライブ契約が存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CHN_0004 properties: errorCode: type: string enum: - MLIVE_CHN_0004 description: エラーコード reason: type: string enum: - ライブコンテンツが存在しません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MLIVE_CHN_0006 properties: errorCode: type: string enum: - MLIVE_CHN_0006 description: エラーコード reason: type: string enum: - チャンネル開始処理の受付に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/live/channels' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "content_id": "contentid" }' summary: ライブチャンネル開始受付 description: ライブチャンネルの開始処理を受付けます。 delete: tags: - live_channel_service operationId: delete-live-channels parameters: [] requestBody: content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false minLength: 1 required: - content_id example: content_id: contentid contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false channel_state: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: チャンネルステータス deprecated: false nullable: true required: - content_id example: content_id: contentid channel_state: IDLE contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MLIVE_CHN_0005 properties: errorCode: type: string enum: - MLIVE_CHN_0005 description: エラーコード reason: type: string enum: - 停止できる状態ではありません。 description: エラーメッセージ contentType: application/json - type: object title: MLIVE_CHN_0008 properties: errorCode: type: string enum: - MLIVE_CHN_0008 description: エラーコード reason: type: string enum: - ライブ契約が存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MLIVE_CHN_0004 properties: errorCode: type: string enum: - MLIVE_CHN_0004 description: エラーコード reason: type: string enum: - ライブコンテンツが存在しません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MLIVE_CHN_0007 properties: errorCode: type: string enum: - MLIVE_CHN_0007 description: エラーコード reason: type: string enum: - チャンネル停止処理の受付に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/live/channels' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "content_id": "contentid" }' summary: ライブチャンネル停止受付 description: ライブチャンネルの停止処理を受け付けます。 /live/channels/{content_id}: get: tags: - live_channel_service operationId: get-live-channels-{content_id} parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: content_id: type: string description: コンテンツID deprecated: false channel_state: type: string enum: - CREATING - CREATE_FAILED - IDLE - STARTING - RUNNING - RECOVERING - STOPPING - DELETING - DELETED - UPDATING - UPDATE_FAILED - DETACHED - ATTACHED description: チャンネルステータス deprecated: false nullable: true required: - content_id example: content_id: contentid channel_state: IDLE contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/live/channels/{content_id}' -H 'Authorization: Bearer {access_token}' summary: ライブチャンネル詳細取得 description: |- ライブチャンネル詳細取得を取得します。 コンテンツが存在しない場合、もしくはチャンネルが未開始の場合はステータスコード200で`null`を返します。 /analytics/visits: get: tags: - analytics_service operationId: get-analytics-visits parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false - name: timeframe in: query description: 集計期間 schema: type: string enum: - day - month - year description: 集計期間 deprecated: false default: day responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total: type: object properties: new_visit_plays: type: integer description: 新規ユーザ再生回数 deprecated: false new_visit_average_play_duration_seconds: type: number description: 新規ユーザ平均再生時間（秒） deprecated: false returning_visit_plays: type: integer description: リピートユーザ再生回数 deprecated: false returning_visit_average_play_duration_seconds: type: number description: リピートユーザ平均再生時間（秒） deprecated: false required: - new_visit_plays - new_visit_average_play_duration_seconds - returning_visit_plays - returning_visit_average_play_duration_seconds example: new_visit_plays: '1' new_visit_average_play_duration_seconds: '1' returning_visit_plays: '1' returning_visit_average_play_duration_seconds: '1' contentType: application/json description: 期間内全体統計 deprecated: false items: type: array items: type: object properties: date: type: string description: 年月日 deprecated: false new_visit_plays: type: integer description: 新規ユーザ再生回数 deprecated: false new_visit_average_play_duration_seconds: type: number description: 新規ユーザ平均再生時間（秒） deprecated: false returning_visit_plays: type: integer description: リピートユーザ再生回数 deprecated: false returning_visit_average_play_duration_seconds: type: number description: リピートユーザ平均再生時間（秒） deprecated: false required: - date - new_visit_plays - new_visit_average_play_duration_seconds - returning_visit_plays - returning_visit_average_play_duration_seconds example: date: '2023-01-01' new_visit_plays: '1' new_visit_average_play_duration_seconds: '1' returning_visit_plays: '1' returning_visit_average_play_duration_seconds: '1' contentType: application/json description: 時系列統計 deprecated: false total_count: type: integer description: 時系列統計データレコード件数 deprecated: false required: - total - items - total_count example: total: date: '2023-01-01' new_visit_plays: 1 new_visit_average_play_duration_seconds: 1 returning_visit_plays: 1 returning_visit_average_play_duration_seconds: 1 items: - date: '2023-01-01' new_visit_plays: 1 new_visit_average_play_duration_seconds: 1 returning_visit_plays: 1 returning_visit_average_play_duration_seconds: 1 total_count: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0024 properties: errorCode: type: string enum: - MVOD_CMN_0024 description: エラーコード reason: type: string enum: - 検索開始日fromには本日以前の日付を設定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/visits?from=2023-01-01&to=2023-01-02&timeframe=day' -H 'Authorization: Bearer {access_token}' summary: 新規/リピート統計 description: 新規/リピート統計を返します。 /analytics/contents/summary: get: tags: - analytics_service operationId: get-analytics-contents-summary parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false - name: group_by in: query description: >- 統計値を集約するディメンション`filter_by`に`content_id`以外のディメンションを指定する場合、group_byには`content_id`以外を指定できません。 schema: type: string enum: - content_id - parent_content_id - country - region - referrer - device - os - os_version - browser - browser_version description: >- 統計値を集約するディメンション`filter_by`に`content_id`以外のディメンションを指定する場合、group_byには`content_id`以外を指定できません。 deprecated: false default: content_id - name: content_id in: query description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、空の結果となります。 schema: type: string description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、空の結果となります。 deprecated: false minLength: 1 nullable: true - name: group_name in: query description: >- ディメンションの集約グループ名
`content_id`で集約してコンテンツIDをグループ名に指定すると、1つのコンテンツだけで集計されます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`region`で集約して国名をグループ名に指定すると、その国内での地域で集計されます。
`referrer`で集約して参照元ドメインをグループ名に指定すると、その参照元ドメインのコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`os_version`で集約してOSをグループ名に指定すると、そのOSのメジャーバージョンで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
`browser_version`で集約してブラウザ名をグループ名に指定すると、そのブラウザのメジャーバージョンで集計されます。
schema: type: string description: >- ディメンションの集約グループ名
`content_id`で集約してコンテンツIDをグループ名に指定すると、1つのコンテンツだけで集計されます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`region`で集約して国名をグループ名に指定すると、その国内での地域で集計されます。
`referrer`で集約して参照元ドメインをグループ名に指定すると、その参照元ドメインのコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`os_version`で集約してOSをグループ名に指定すると、そのOSのメジャーバージョンで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
`browser_version`で集約してブラウザ名をグループ名に指定すると、そのブラウザのメジャーバージョンで集計されます。
deprecated: false minLength: 1 nullable: true - name: filter_by in: query description: ディメンションを絞るグループ名 schema: type: string enum: - content_id - parent_content_id - country - referrer - device - os - browser description: ディメンションを絞るグループ名 deprecated: false minLength: 1 nullable: true - name: filter_value in: query description: '`filter_by`で指定したディメンションを絞り込む値' schema: type: string description: '`filter_by`で指定したディメンションを絞り込む値' deprecated: false minLength: 1 nullable: true - name: sort_by in: query description: 並び替えに使用するフィールド schema: type: string enum: - plays - impressions - plays_from_impressions - average_play_duration_seconds - transfer description: 並び替えに使用するフィールド deprecated: false default: plays - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: media_type in: query description: コンテンツ種別 schema: type: string enum: - pdf - video - live - audio description: コンテンツ種別 deprecated: false default: video - name: page_size in: query description: 1ページあたりのコンテンツ数 schema: type: integer description: 1ページあたりのコンテンツ数 deprecated: false maximum: 200 minimum: 1 default: 20 - name: page in: query description: ページ番号 schema: type: integer description: ページ番号 deprecated: false maximum: 100000000 minimum: 1 default: 1 responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: 対象のレコード件数 deprecated: false items: type: array items: type: object properties: group_name: type: string description: ディメンションの集約グループ名 deprecated: false alternative_group_name: type: string description: >- ディメンションの集約グループ別名
content_idで集約したときコンテンツのタイトルが設定されます。
regionで集約したときは地域名が設定されます。
os_versionで集約したときはOSのメジャーバージョンが設定されます。なお、macOS 11以降のMacOSはMacOS 10として集計されます。
browser_versionで集約したときはブラウザのメジャーバージョンが設定されます。 deprecated: false plays: type: integer description: 再生回数 deprecated: false media_type: type: string enum: - pdf - video - live - audio - folder description: コンテンツ種別 deprecated: false average_play_duration_seconds: type: number description: 平均再生時間（秒） deprecated: false nullable: true transfer: type: integer description: 転送量(バイト)
コンテンツIDグループで集約したときのみ取得できます。 deprecated: false nullable: true impressions: type: integer description: >- 表示回数
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true plays_from_impressions: type: number description: >- 視聴割合。再生回数 / 表示回数。
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true view_completions_25_percent: type: number description: |- 25%再生達成率。
25%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`content_id`または`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_50_percent: type: number description: |- 50%再生達成率。
50%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`content_id`または`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_75_percent: type: number description: |- 75%再生達成率。
75%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`content_id`または`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_100_percent: type: number description: |- 100%再生達成率。
100%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`content_id`または`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true required: - group_name - alternative_group_name - plays - media_type - average_play_duration_seconds example: group_name: グループ名 alternative_group_name: タイトル plays: 10 media_type: video average_play_duration_seconds: 10 transfer: 1073741824 impressions: 10 plays_from_impressions: 1 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 contentType: application/json description: 統計 deprecated: false page: type: integer description: ページ番号 deprecated: false minimum: 1 default: 1 required: - total_count - items example: total_count: 1 items: - group_name: グループ名 alternative_group_name: タイトル plays: 10 media_type: video average_play_duration_seconds: 10 transfer: 1073741824 impressions: 10 plays_from_impressions: 1 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 page: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_ANA_0002 properties: errorCode: type: string enum: - MVOD_ANA_0002 description: エラーコード reason: type: string enum: - ライブコンテンツの統計では表示回数/視聴割合での並び替えはサポートされていません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0003 properties: errorCode: type: string enum: - MVOD_ANA_0003 description: エラーコード reason: type: string enum: - コンテンツID集約以外では再生回数/平均再生時間以外での並び替えはサポートされていません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0005 properties: errorCode: type: string enum: - MVOD_ANA_0005 description: エラーコード reason: type: string enum: - group_byとfilter_byの内、片方はcontent_idである必要があります。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0006 properties: errorCode: type: string enum: - MVOD_ANA_0006 description: エラーコード reason: type: string enum: - filter_byを指定した場合はfilter_valueも指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0008 properties: errorCode: type: string enum: - MVOD_ANA_0008 description: エラーコード reason: type: string enum: - >- media_type=audio を指定した場合、group_by および filter_by に content_id または parent_content_id を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0010 properties: errorCode: type: string enum: - MVOD_ANA_0010 description: エラーコード reason: type: string enum: - >- media_type=live を指定した場合、group_by に parent_content_id を指定することはできません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0024 properties: errorCode: type: string enum: - MVOD_CMN_0024 description: エラーコード reason: type: string enum: - 検索開始日fromには本日以前の日付を設定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/summary?from=2023-01-01&to=2023-01-02&group_by=content_id&content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&group_name=グループ名&filter_by=content_id&filter_value=content_id&sort_by=plays&order=desc&media_type=video&page_size=20&page=1' -H 'Authorization: Bearer {access_token}' summary: コンテンツ統計情報取得 description: コンテンツ統計情報を返します。
削除済みコンテンツ、再生実績の無いコンテンツの結果も取得します。 /analytics/contents/summary/csv: get: tags: - analytics_service operationId: get-analytics-contents-summary-csv parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false - name: group_by in: query description: >- 統計値を集約するディメンション`filter_by`に`content_id`以外のディメンションを指定する場合、group_byには`content_id`以外を指定できません。 schema: type: string enum: - content_id - parent_content_id - country - region - referrer - device - os - os_version - browser - browser_version description: >- 統計値を集約するディメンション`filter_by`に`content_id`以外のディメンションを指定する場合、group_byには`content_id`以外を指定できません。 deprecated: false default: content_id - name: content_id in: query description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、空の結果となります。 schema: type: string description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、空の結果となります。 deprecated: false minLength: 1 nullable: true - name: group_name in: query description: >- ディメンションの集約グループ名
`content_id`で集約してコンテンツIDをグループ名に指定すると、1つのコンテンツだけで集計されます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`region`で集約して国名をグループ名に指定すると、その国内での地域で集計されます。
`referrer`で集約して参照元ドメインをグループ名に指定すると、その参照元ドメインのコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`os_version`で集約してOSをグループ名に指定すると、そのOSのメジャーバージョンで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
`browser_version`で集約してブラウザ名をグループ名に指定すると、そのブラウザのメジャーバージョンで集計されます。
schema: type: string description: >- ディメンションの集約グループ名
`content_id`で集約してコンテンツIDをグループ名に指定すると、1つのコンテンツだけで集計されます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`region`で集約して国名をグループ名に指定すると、その国内での地域で集計されます。
`referrer`で集約して参照元ドメインをグループ名に指定すると、その参照元ドメインのコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`os_version`で集約してOSをグループ名に指定すると、そのOSのメジャーバージョンで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
`browser_version`で集約してブラウザ名をグループ名に指定すると、そのブラウザのメジャーバージョンで集計されます。
deprecated: false minLength: 1 nullable: true - name: filter_by in: query description: ディメンションを絞るグループ名 schema: type: string enum: - content_id - parent_content_id - country - referrer - device - os - browser description: ディメンションを絞るグループ名 deprecated: false minLength: 1 nullable: true - name: filter_value in: query description: '`filter_by`で指定したディメンションを絞り込む値' schema: type: string description: '`filter_by`で指定したディメンションを絞り込む値' deprecated: false minLength: 1 nullable: true - name: sort_by in: query description: 並び替えに使用するフィールド schema: type: string enum: - plays - impressions - plays_from_impressions - average_play_duration_seconds - transfer - storage description: 並び替えに使用するフィールド deprecated: false default: plays - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: media_type in: query description: コンテンツ種別 schema: type: string enum: - pdf - video - live - audio description: コンテンツ種別 deprecated: false default: video responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false params: type: string description: CSV生成するAPIのパラメータをJSON形式に変換した文字列 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false created_at: type: string description: ジョブの作成日時 deprecated: false updated_at: type: string description: ジョブの更新日時 deprecated: false required: - job_id - api_path - params - status - created_at - updated_at example: job_id: 12ab34cd-56ef-78gh-90ij-12kl34mn56op api_path: /vod/contents/statistics params: '{"from": "2024-06-01", "to": "2024-06-30"}' status: generating created_at: '2024-06-01 00:00:00.000000+09:00' updated_at: '2024-06-01 00:00:00.000000+09:00' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0001 properties: errorCode: type: string enum: - MVOD_CSV_0001 description: エラーコード reason: type: string enum: - CSVファイルの生成に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0002 properties: errorCode: type: string enum: - MVOD_CSV_0002 description: エラーコード reason: type: string enum: - 現在進行中の変換処理が10個以上存在するためジョブを開始できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/summary/csv?from=2023-01-01&to=2023-01-02&group_by=content_id&content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&group_name=グループ名&filter_by=content_id&filter_value=content_id&sort_by=plays&order=desc&media_type=video' -H 'Authorization: Bearer {access_token}' summary: コンテンツ統計情報CSV生成 description: |- コンテンツ統計情報CSVファイルの作成をリクエストします。 当APIはResponses記載のエラーの他、コンテンツ統計情報取得APIのエラーを返します。 /analytics/contents/timeseries: get: tags: - analytics_service operationId: get-analytics-contents-timeseries parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false - name: timeframe in: query description: 集計期間 schema: type: string enum: - day - month - year description: 集計期間 deprecated: false default: day - name: group_by in: query description: 統計値を集約するディメンション schema: type: string enum: - content_id - parent_content_id - country - referrer - device - os - browser description: 統計値を集約するディメンション deprecated: false default: content_id - name: group_name in: query description: >- ディメンションの集約グループ名
特定のグループ名で集約するときに指定します。
`content_id`で集約するときはコンテンツIDが指定できます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`referrer`で集約して参照元をグループ名に指定すると、その参照元のコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
schema: type: string description: >- ディメンションの集約グループ名
特定のグループ名で集約するときに指定します。
`content_id`で集約するときはコンテンツIDが指定できます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`referrer`で集約して参照元をグループ名に指定すると、その参照元のコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
deprecated: false minLength: 1 nullable: true - name: content_id in: query description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、0で埋められた結果が返ります。 schema: type: string description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、0で埋められた結果が返ります。 deprecated: false minLength: 1 nullable: true - name: media_type in: query description: コンテンツ種別 schema: type: string enum: - pdf - video - live - audio description: コンテンツ種別 deprecated: false default: video responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total: type: object properties: plays: type: integer description: 合計再生回数 deprecated: false average_play_duration_seconds: type: number description: 平均再生時間（秒） deprecated: false nullable: true transfer: type: integer description: 合計転送量最(バイト)
コンテンツIDグループで集約したときのみ取得できます。 deprecated: false nullable: true impressions: type: integer description: >- 合計表示回数
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true plays_from_impressions: type: number description: >- 視聴割合。合計再生回数 / 合計表示回数。
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true view_completions_25_percent: type: number description: >- 25%再生達成率。
25%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_50_percent: type: number description: >- 50%再生達成率。
50%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_75_percent: type: number description: >- 75%再生達成率。
75%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_100_percent: type: number description: >- 100%再生達成率。
100%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true required: - plays - average_play_duration_seconds example: plays: 10 average_play_duration_seconds: 10 transfer: 1073741824 impressions: 10 plays_from_impressions: 1 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 contentType: application/json description: 期間内全体統計 deprecated: false items: type: array items: type: object properties: date: type: string description: 年月日 deprecated: false plays: type: integer description: 再生回数 deprecated: false average_play_duration_seconds: type: number description: 平均再生時間（秒） deprecated: false nullable: true transfer: type: integer description: 転送量(バイト)
コンテンツIDグループで集約したときのみ取得できます。 deprecated: false nullable: true plays_from_impressions: type: number description: >- 視聴割合。再生回数 / 表示回数。
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true impressions: type: integer description: >- 表示回数
コンテンツIDグループで集約したときのみ取得できます。ただしライブコンテンツでは取得できません。 deprecated: false nullable: true view_completions_25_percent: type: number description: >- 25%再生達成率。
25%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_50_percent: type: number description: >- 50%再生達成率。
50%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_75_percent: type: number description: >- 75%再生達成率。
75%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true view_completions_100_percent: type: number description: >- 100%再生達成率。
100%再生時間までのシークなし視聴回数 / 総視聴回数
`group_by`に`referrer`を指定した場合のみ使用できます。 deprecated: false nullable: true required: - date - plays - average_play_duration_seconds example: date: '2022-01-01' plays: 10 average_play_duration_seconds: 10 transfer: 1073741824 plays_from_impressions: 1 impressions: 10 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 contentType: application/json description: 時系列統計 deprecated: false total_count: type: integer description: 時系列データレコード件数 deprecated: false group_name: type: string description: ディメンションの集約グループ名 deprecated: false nullable: true alternative_group_name: type: string description: ディメンションの集約グループ別名
content_idで集約したときコンテンツのタイトルが設定されます。 deprecated: false nullable: true required: - total - items - total_count example: total: date: '2022-01-01' plays: 10 average_play_duration_seconds: 10 transfer: 1073741824 plays_from_impressions: 1 impressions: 10 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 items: - date: '2022-01-01' plays: 10 average_play_duration_seconds: 10 transfer: 1073741824 plays_from_impressions: 1 impressions: 10 view_completions_25_percent: 0.5 view_completions_50_percent: 0.5 view_completions_75_percent: 0.5 view_completions_100_percent: 0.5 total_count: 1 group_name: グループ名 alternative_group_name: タイトル contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_ANA_0009 properties: errorCode: type: string enum: - MVOD_ANA_0009 description: エラーコード reason: type: string enum: - >- media_type=audio を指定した場合、group_by に content_id を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0010 properties: errorCode: type: string enum: - MVOD_ANA_0010 description: エラーコード reason: type: string enum: - >- media_type=live を指定した場合、group_by に parent_content_id を指定することはできません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0024 properties: errorCode: type: string enum: - MVOD_CMN_0024 description: エラーコード reason: type: string enum: - 検索開始日fromには本日以前の日付を設定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/timeseries?from=2023-01-01&to=2023-01-02&timeframe=day&group_by=content_id&group_name=グループ名&content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&media_type=video' -H 'Authorization: Bearer {access_token}' summary: コンテンツ時系列統計情報取得 description: コンテンツ時系列統計情報を返します。 /analytics/contents/timeseries/csv: get: tags: - analytics_service operationId: get-analytics-contents-timeseries-csv parameters: - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false - name: timeframe in: query description: 集計期間 schema: type: string enum: - day - month - year description: 集計期間 deprecated: false default: day - name: group_by in: query description: 統計値を集約するディメンション schema: type: string enum: - content_id - parent_content_id - country - referrer - device - os - browser description: 統計値を集約するディメンション deprecated: false default: content_id - name: group_name in: query description: >- ディメンションの集約グループ名
特定のグループ名で集約するときに指定します。
`content_id`で集約するときはコンテンツIDが指定できます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`referrer`で集約して参照元をグループ名に指定すると、その参照元のコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
schema: type: string description: >- ディメンションの集約グループ名
特定のグループ名で集約するときに指定します。
`content_id`で集約するときはコンテンツIDが指定できます。
`parent_content_id`で集約して親フォルダIDをグループ名に指定すると、 親フォルダの配下のフォルダ・コンテンツで集計されます。指定しない場合はルート配下のフォルダで集計されます。
`country`で集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
`referrer`で集約して参照元をグループ名に指定すると、その参照元のコンテンツだけで集計されます。
`device`で集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
`os`で集約してOSをグループ名に指定すると、そのOSだけで集計されます。
`browser`で集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
deprecated: false minLength: 1 nullable: true - name: content_id in: query description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、0で埋められた結果が返ります。 schema: type: string description: >- コンテンツID
集計対象のコンテンツを1つに限定します。
`group_name`フィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、0で埋められた結果が返ります。 deprecated: false minLength: 1 nullable: true - name: media_type in: query description: コンテンツ種別 schema: type: string enum: - pdf - video - live - audio description: コンテンツ種別 deprecated: false default: video responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false params: type: string description: CSV生成するAPIのパラメータをJSON形式に変換した文字列 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false created_at: type: string description: ジョブの作成日時 deprecated: false updated_at: type: string description: ジョブの更新日時 deprecated: false required: - job_id - api_path - params - status - created_at - updated_at example: job_id: 12ab34cd-56ef-78gh-90ij-12kl34mn56op api_path: /vod/contents/statistics params: '{"from": "2024-06-01", "to": "2024-06-30"}' status: generating created_at: '2024-06-01 00:00:00.000000+09:00' updated_at: '2024-06-01 00:00:00.000000+09:00' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0001 properties: errorCode: type: string enum: - MVOD_CSV_0001 description: エラーコード reason: type: string enum: - CSVファイルの生成に失敗しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CSV_0002 properties: errorCode: type: string enum: - MVOD_CSV_0002 description: エラーコード reason: type: string enum: - 現在進行中の変換処理が10個以上存在するためジョブを開始できません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/timeseries/csv?from=2023-01-01&to=2023-01-02&timeframe=day&group_by=content_id&group_name=グループ名&content_id=4ba28124-c54g-83d8-9xxb-5324bddbafc9&media_type=video' -H 'Authorization: Bearer {access_token}' summary: コンテンツ時系列統計情報CSV生成 description: |- コンテンツ時系列統計情報CSVファイルの作成をリクエストします。 当APIはResponses記載のエラーの他、コンテンツ時系列統計情報取得APIのエラーを返します。 /analytics/contents/{content_id}/audience_retention: get: tags: - analytics_service operationId: get-analytics-contents-{content_id}-audience_retention parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false minLength: 1 - name: media_type in: query description: コンテンツ種別 required: true schema: type: string enum: - pdf - video - live description: コンテンツ種別 deprecated: false - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: items: type: array items: type: object properties: playhead: type: integer description: 再生位置
PDFはページ番号になります。 deprecated: false audience_retention: type: number description: 視聴割合 deprecated: false required: - playhead - audience_retention example: playhead: 5 audience_retention: 0.5 contentType: application/json description: 視聴維持率統計 deprecated: false total_count: type: integer description: 視聴維持率データレコード件数 deprecated: false required: - items - total_count example: items: - playhead: 5 audience_retention: 0.5 total_count: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0024 properties: errorCode: type: string enum: - MVOD_CMN_0024 description: エラーコード reason: type: string enum: - 検索開始日fromには本日以前の日付を設定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MVOD_ANA_0004 properties: errorCode: type: string enum: - MVOD_ANA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0007 properties: errorCode: type: string enum: - MVOD_ANA_0007 description: エラーコード reason: type: string enum: - 存在しないユーザーが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/{content_id}/audience_retention?media_type=video&from=2023-01-01&to=2023-01-02' -H 'Authorization: Bearer {access_token}' summary: コンテンツ視聴維持率 description: コンテンツ視聴維持率情報を返します。 /analytics/contents/{content_id}/completion: get: tags: - analytics_service operationId: get-analytics-contents-{content_id}-completion parameters: - name: content_id in: path description: コンテンツID required: true schema: type: string description: コンテンツID deprecated: false minLength: 1 - name: media_type in: query description: コンテンツ種別 required: true schema: type: string enum: - video description: コンテンツ種別 deprecated: false - name: from in: query description: 対象年月日(開始) required: true schema: type: string description: 対象年月日(開始) deprecated: false minimum: '2023-01-01' - name: to in: query description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 schema: type: string description: 対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。 deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: items: type: array items: type: object properties: playback_progress: type: number description: コンテンツの全尺を1としたときの再生位置 deprecated: false view_rate: type: number description: 視聴割合
シークなし視聴回数 / 総視聴回数 deprecated: false required: - playback_progress - view_rate example: playback_progress: 0.25 view_rate: 0.5 contentType: application/json description: 再生達成率統計 deprecated: false total_count: type: integer description: 再生達成率データレコード件数 deprecated: false required: - items - total_count example: items: - playback_progress: 0.25 view_rate: 0.5 total_count: 1 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0020 properties: errorCode: type: string enum: - MVOD_CMN_0020 description: エラーコード reason: type: string enum: - 終了日は、開始日以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0024 properties: errorCode: type: string enum: - MVOD_CMN_0024 description: エラーコード reason: type: string enum: - 検索開始日fromには本日以前の日付を設定してください。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: oneOf: - type: object title: MVOD_ANA_0004 properties: errorCode: type: string enum: - MVOD_ANA_0004 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_ANA_0007 properties: errorCode: type: string enum: - MVOD_ANA_0007 description: エラーコード reason: type: string enum: - 存在しないユーザーが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/analytics/contents/{content_id}/completion?media_type=video&from=2023-01-01&to=2023-01-02' -H 'Authorization: Bearer {access_token}' summary: コンテンツ再生達成率 description: コンテンツ視聴達成情報を返します。 /playlists: post: tags: - playlist_service operationId: post-playlists parameters: [] requestBody: content: application/json: schema: type: object properties: title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 playlist_type: type: string enum: - manual - auto description: プレイリスト種別。2階層構成の親のプレイリスト作成時はmanualを固定で指定します。 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: >- プレイリストの階層種別を指定します。1階層構成のプレイリスト作成時はlevel1を指定し、2階層構成の親もしくは子プレイリスト作成時はlevel2を指定します。 deprecated: false default: level1 description: type: string description: 説明文 deprecated: false maxLength: 8192 default: '' public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false default: public start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定を指定します。2階層構成の子作成時は指定不要で必ずNoneで保存されます。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false default: latest tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false minimum: -1 nullable: true limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false maximum: 100 minimum: 1 default: 100 example: sort_by: latest tags: - tag1 - tag2 latest: 5 limit: 5 contentType: application/json description: プレイリストを自動で作成する際の設定です。playlist_typeにautoを指定した時だけ有効な設定です。 deprecated: false contents: type: array items: type: string description: >- プレイリストに紐づけるコンテンツIDを指定します。プレイリスト種別で`manual`を指定した場合かつ、1階層構成もしくは2階層構成の子作成時のみ有効な設定です。 deprecated: false maxItems: 100 nullable: true is_password_required: type: boolean description: >- コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false`
2階層構成の子作成時は指定不要で必ずNoneで保存されます。 deprecated: false default: false password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true parent_playlist_id: type: string description: >- 2階層構成の子のプレイリスト作成時に親のプレイリストIDを指定します。2階層構成の親か1階層構成のプレイリスト作成時は指定不要です。 deprecated: false minLength: 1 default: root required: - title - playlist_type - media_type example: title: タイトル playlist_type: manual media_type: video level_type: level1 description: 説明 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 auto_playlist_config: sort_by: latest tags: - tag1 - tag2 latest: 5 limit: 5 contents: - 4ba28124-c54f-83d8-9aab-5324bddbafc9 is_password_required: false password: password parent_playlist_id: root contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 contents: type: array items: oneOf: - type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: コンテンツステータス deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true duration: type: number description: コンテンツの再生時間（秒） deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true thumbnail_url: type: string description: PDFサムネイルURL deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg contentType: application/json description: PDF情報 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: true nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: true nullable: true tag: type: array items: type: string description: タグ deprecated: true nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: true nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: true nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: true nullable: true recipe_id: type: string description: レシピID deprecated: true nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: true nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: true nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: true nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json - type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 contentType: application/json description: プレイリスト内のコンテンツの一覧情報 deprecated: false nullable: true playlists: type: array items: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: >- 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: >- プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json description: プレイリスト内のプレイリストの一覧情報 deprecated: false nullable: true required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contents: - content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 playlists: - playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0002 properties: errorCode: type: string enum: - MVOD_PLL_0002 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0003 properties: errorCode: type: string enum: - MVOD_PLL_0003 description: エラーコード reason: type: string enum: - メディアタイプの異なるコンテンツが指定されています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0006 properties: errorCode: type: string enum: - MVOD_PLL_0006 description: エラーコード reason: type: string enum: - 存在しない親のプレイリストIDが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0009 properties: errorCode: type: string enum: - MVOD_PLL_0009 description: エラーコード reason: type: string enum: - contentsに空文字は指定できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0011 properties: errorCode: type: string enum: - MVOD_PLL_0011 description: エラーコード reason: type: string enum: - 子プレイリストは100個を超えて作成することはできません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/playlists' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "title": "タイトル", "playlist_type": "manual", "media_type": "video", "level_type": "level1", "description": "説明", "public_setting": { "type": "period", "start": "2022-03-01T00:00:00.000000+0900", "end": "2022-04-01T00:00:00.000000+0900" }, "auto_playlist_config": { "sort_by": "latest", "tags": [ "tag1", "tag2" ], "latest": 5, "limit": 5 }, "contents": [ "4ba28124-c54f-83d8-9aab-5324bddbafc9" ], "is_password_required": false, "password": "password", "parent_playlist_id": "root" }' summary: プレイリスト作成 description: プレイリストを作成します。 get: tags: - playlist_service operationId: get-playlists parameters: - name: playlist_id in: query description: プレイリストID schema: type: string description: プレイリストID deprecated: false nullable: true - name: title in: query description: プレイリストのタイトルで取得対象を絞り込むときに指定します。 schema: type: string description: プレイリストのタイトルで取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: description in: query description: プレイリストの説明文で取得対象を絞り込むときに指定します。 schema: type: string description: プレイリストの説明文で取得対象を絞り込むときに指定します。 deprecated: false nullable: true - name: media_type in: query description: >- プレイリストのメディアタイプ(`video`,`audio`,`pdf`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメディアタイプを指定した場合無視されます。 schema: type: string description: >- プレイリストのメディアタイプ(`video`,`audio`,`pdf`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないメディアタイプを指定した場合無視されます。 deprecated: false nullable: true - name: level_type in: query description: >- プレイリストの階層種別(`level1`,`level2`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないプレイリストの階層種別を指定した場合無視されます。 schema: type: string description: >- プレイリストの階層種別(`level1`,`level2`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないプレイリストの階層種別を指定した場合無視されます。 deprecated: false nullable: true - name: playlist_type in: query description: >- プレイリスト種別(`manual`,`auto`,`manual_auto`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないプレイリスト種別を指定した場合無視されます。 schema: type: string description: >- プレイリスト種別(`manual`,`auto`,`manual_auto`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しないプレイリスト種別を指定した場合無視されます。 deprecated: false nullable: true - name: public_setting_type in: query description: >- 公開設定の種別(`public`,`private`,`period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開設定の種別を指定した場合無視されます。 schema: type: string description: >- 公開設定の種別(`public`,`private`,`period`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでOR条件で絞り込まれます。
上記に合致しない公開設定の種別を指定した場合無視されます。 deprecated: false nullable: true - name: sort_by in: query description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 schema: type: string enum: - updated_at - created_at - score - title description: 並び替えに使用するフィールド。
同じ値の場合はcreated_atの昇順で並べられます。 deprecated: false default: created_at - name: order in: query description: 昇順(asc) / 降順(desc) schema: type: string enum: - asc - desc description: 昇順(asc) / 降順(desc) deprecated: false default: desc - name: page_size in: query description: 1ページあたりのプレイリスト数 schema: type: integer description: 1ページあたりのプレイリスト数 deprecated: false maximum: 200 minimum: 1 nullable: true - name: page in: query description: ページ番号 schema: type: integer description: ページ番号 deprecated: false minimum: 1 nullable: true responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: >- 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: >- プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 child_playlist_type: type: string enum: - manual - auto - manual_auto description: >- 子のプレイリストのコンテンツ追加方法。1階層構成の場合は自身のplaylist_typeを返す。
2階層構成の場合は配下のプレイリストのplaylist_typeを返す。配下にプレイリストが一つもない場合はNoneを返す。 deprecated: false nullable: true required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 child_playlist_type: null contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 child_playlist_type: null contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/playlists?playlist_id=None&title=None&description=None&media_type=video,audio,pdf&level_type=level1,level2&playlist_type=manual,auto,manual_auto&public_setting_type=public,private,period&sort_by=created_at&order=desc&page_size=200&page=1' -H 'Authorization: Bearer {access_token}' summary: プレイリスト一覧 description: プレイリスト一覧を取得します。 /playlists/{playlist_id}: patch: tags: - playlist_service operationId: patch-playlists-{playlist_id} parameters: - name: playlist_id in: path description: プレイリストID required: true schema: type: string description: プレイリストID deprecated: false requestBody: content: application/json: schema: type: object properties: is_force_delete: type: boolean description: 誤削除防止フラグ。
2階層構成の親の配下の子のプレイリストを削除するときは`true`を指定します。 deprecated: false default: false nullable: true title: type: string description: タイトル deprecated: false maxLength: 1024 minLength: 1 nullable: true description: type: string description: 説明文 deprecated: false maxLength: 8192 nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false default: public start: type: string description: >- 公開開始日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。タイムゾーンを指定しない場合はJSTとして処理します。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目です。 deprecated: false nullable: true tags: type: array items: type: string description: >- プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。
既に設定済みのものを取り消す場合は、空の配列を指定してください。 deprecated: false nullable: true latest: type: integer description: >- プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。
既に設定済みのものを取り消す場合は、-1を指定してください。 deprecated: false minimum: -1 nullable: true limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false maximum: 100 minimum: 1 nullable: true example: sort_by: latest tags: - tag1 - tag2 latest: 5 limit: 5 contentType: application/json description: プレイリストを自動で作成するときの設定です。 deprecated: false nullable: true is_password_required: type: boolean description: コンテンツへのパスワードの機能設定。
パスワード機能をONにする場合は`true`、OFFの場合は`false` deprecated: false nullable: true password: type: string description: | コンテンツへのパスワード。
`"is_password_required": true`の場合、必須です。
半角英数字と以下の記号のみ8文字以上100文字以下で登録できます。
``` ."#?!$%&()]@[,=~|`{}+*<>_/\;:^'- ``` `"is_password_required": false`の場合、passwordは入力されても登録されません。 deprecated: false nullable: true contents: type: array items: type: string description: | 1階層構成もしくは2階層構成の子のプレイリスを更新するときだけ更新可能です。
プレイリストとコンテンツの紐づけ情報の追加、削除、並び替えのみ行えます。 deprecated: false maxItems: 100 nullable: true playlists: type: array items: type: string description: | 2階層構成の親のプレイリストを更新する際のみ更新可能です。
親プレイリスト配下の子プレイリストの削除、並び替えを行えます。
削除は物理削除になり、誤削除を防止するために`"is_force_delete": true`の時だけ行えます。 deprecated: false maxItems: 100 nullable: true example: is_force_delete: false title: タイトル description: 説明 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 auto_playlist_config: sort_by: latest tags: - tag1 - tag2 latest: 5 limit: 5 is_password_required: false password: password contents: - 4ba28124-c54f-83d8-9aab-5324bddbafc9 playlists: - 4ba28124-c54f-83d8-9aab-5324bddbafc9 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 contents: type: array items: oneOf: - type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: コンテンツステータス deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true duration: type: number description: コンテンツの再生時間（秒） deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true thumbnail_url: type: string description: PDFサムネイルURL deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg contentType: application/json description: PDF情報 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: true nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: true nullable: true tag: type: array items: type: string description: タグ deprecated: true nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: true nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: true nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: true nullable: true recipe_id: type: string description: レシピID deprecated: true nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: true nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: true nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: true nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json - type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 contentType: application/json description: プレイリスト内のコンテンツの一覧情報 deprecated: false nullable: true playlists: type: array items: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: >- 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: >- プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json description: プレイリスト内のプレイリストの一覧情報 deprecated: false nullable: true required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contents: - content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 playlists: - playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - パラメーターの値が不適切です。[start, end] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。[password] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0017 properties: errorCode: type: string enum: - MVOD_CMN_0017 description: エラーコード reason: type: string enum: - 日付はyyyy-mm-dd hh:mm:ssの形式で設定してください。[param] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0021 properties: errorCode: type: string enum: - MVOD_CMN_0021 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の範囲で指定する必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0023 properties: errorCode: type: string enum: - MVOD_CMN_0023 description: エラーコード reason: type: string enum: - 2000年以降の日付を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0002 properties: errorCode: type: string enum: - MVOD_PLL_0002 description: エラーコード reason: type: string enum: - 存在しないコンテンツが指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0003 properties: errorCode: type: string enum: - MVOD_PLL_0003 description: エラーコード reason: type: string enum: - メディアタイプの異なるコンテンツが指定されています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0007 properties: errorCode: type: string enum: - MVOD_PLL_0007 description: エラーコード reason: type: string enum: - >- 2階層構成の子のプレイリストを削除するときは`is_force_delete`に`true`を指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0008 properties: errorCode: type: string enum: - MVOD_PLL_0008 description: エラーコード reason: type: string enum: - 存在しない子のプレイリストIDが指定されました。{} description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0009 properties: errorCode: type: string enum: - MVOD_PLL_0009 description: エラーコード reason: type: string enum: - contentsに空文字は指定できません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLL_0010 properties: errorCode: type: string enum: - MVOD_PLL_0010 description: エラーコード reason: type: string enum: - 子のプレイリストIDが重複しています。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLL_0005 properties: errorCode: type: string enum: - MVOD_PLL_0005 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X PATCH 'https://${end_point}/playlists/{playlist_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "is_force_delete": false, "title": "タイトル", "description": "説明", "public_setting": { "type": "period", "start": "2022-03-01T00:00:00.000000+0900", "end": "2022-04-01T00:00:00.000000+0900" }, "auto_playlist_config": { "sort_by": "latest", "tags": [ "tag1", "tag2" ], "latest": 5, "limit": 5 }, "is_password_required": false, "password": "password", "contents": [ "4ba28124-c54f-83d8-9aab-5324bddbafc9" ], "playlists": [ "4ba28124-c54f-83d8-9aab-5324bddbafc9" ] }' summary: プレイリスト更新 description: プレイリストを更新します。 delete: tags: - playlist_service operationId: delete-playlists-{playlist_id} parameters: - name: playlist_id in: path description: >- プレイリストID
2階層構成の親のプレイリストを削除すると、配下の子のプレイリストと、プレイリストとコンテンツの紐づけ情報もまとめて削除されます。 required: true schema: type: string description: >- プレイリストID
2階層構成の親のプレイリストを削除すると、配下の子のプレイリストと、プレイリストとコンテンツの紐づけ情報もまとめて削除されます。 deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false required: - playlist_id example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLL_0005 properties: errorCode: type: string enum: - MVOD_PLL_0005 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X DELETE 'https://${end_point}/playlists/{playlist_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: プレイリスト削除 description: プレイリストを削除します。 get: tags: - playlist_service operationId: get-playlists-{playlist_id} parameters: - name: playlist_id in: path description: プレイリストID required: true schema: type: string description: プレイリストID deprecated: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 contents: type: array items: oneOf: - type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: タイトル deprecated: false status: type: string enum: - FAILED_TO_UPLOAD - NOT_READY_TO_CONVERT - READY_TO_CONVERT - WAIT_TO_CONVERT - CONVERTING - CONVERT_COMPLETED - CONVERT_ERROR - LIVE_ARCHIVING - ARCHIVE_FAILED description: コンテンツステータス deprecated: false created_at: type: string description: コンテンツ登録日 deprecated: false updated_at: type: string description: コンテンツ更新日 deprecated: false description: type: string description: 説明文 deprecated: false nullable: true media_type: type: string enum: - pdf - video - live - audio - folder description: メディアタイプ deprecated: false nullable: true public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定 deprecated: false nullable: true conversion_rate: type: integer description: 変換進捗率 deprecated: false nullable: true duration: type: number description: コンテンツの再生時間（秒） deprecated: false nullable: true thumbnail_info: type: array items: type: object properties: path: type: string description: サムネイルパス deprecated: true id: type: string description: サムネイルID deprecated: false is_active: type: boolean description: そのサムネイルが使用されている場合は`true`を返します。 deprecated: false thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true required: - path - id - is_active example: path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg contentType: application/json description: サムネイル情報。サムネイルurlのリストを返します。 deprecated: false nullable: true pdf_info: type: object properties: image_file_path: type: string description: 変換後のファイルパス deprecated: true nullable: true total_page_count: type: integer description: PDFのページ数 deprecated: false nullable: true thumbnail_url: type: string description: PDFサムネイルURL deprecated: false nullable: true example: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg contentType: application/json description: PDF情報 deprecated: false nullable: true origin_file_name: type: string description: 元ファイル名 deprecated: true nullable: true origin_file_size: type: integer description: アップロードしたファイルのサイズ(byte) deprecated: true nullable: true tag: type: array items: type: string description: タグ deprecated: true nullable: true is_password_required: type: boolean description: パスワード設定情報 deprecated: true nullable: true parent_content_id: type: string description: 親フォルダのコンテンツID deprecated: true nullable: true storage_amount: type: integer description: ストレージ使用量(byte) deprecated: true nullable: true recipe_id: type: string description: レシピID deprecated: true nullable: true subtitles: type: array items: type: object properties: subtitle_id: type: string description: 字幕ID deprecated: false label: type: string description: 字幕ラベル deprecated: false srclang: type: string description: 言語コード deprecated: false is_default: type: boolean description: デフォルト字幕設定 deprecated: false is_enabled: type: boolean description: 字幕の公開非公開設定 deprecated: false order: type: integer description: 表示順 deprecated: false status: type: string enum: - UNPROCESSED - PROCESSING - PROCESSED - FAILURE description: ステータス deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - subtitle_id - label - srclang - is_default - is_enabled - order - status - created_at - updated_at example: subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: 字幕情報 deprecated: true nullable: true chapter: type: object properties: label: type: string description: チャプターラベル deprecated: false is_enabled: type: boolean description: チャプターの公開非公開設定 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false required: - label - is_enabled - created_at - updated_at example: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 contentType: application/json description: チャプター情報 deprecated: true nullable: true origin_file_dimension: type: object properties: width: type: integer description: 動画の幅 deprecated: false height: type: integer description: 動画の高さ deprecated: false required: - width - height example: width: 1920 height: 1080 contentType: application/json description: 動画の幅と高さ deprecated: true nullable: true parent_folders: type: array items: type: object properties: content_id: type: string description: コンテンツID deprecated: false title: type: string description: フォルダ名 deprecated: false required: - content_id - title example: content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json description: 親フォルダ情報 deprecated: true required: - content_id - title - status - created_at - updated_at example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 contentType: application/json - type: object properties: content_id: type: string description: コンテンツID deprecated: false required: - content_id example: content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 contentType: application/json description: プレイリスト内のコンテンツの一覧情報 deprecated: false nullable: true playlists: type: array items: type: object properties: playlist_id: type: string description: プレイリストID deprecated: false title: type: string description: タイトル deprecated: false playlist_type: type: string enum: - manual - auto description: プレイリストへのコンテンツ追加方法 deprecated: false media_type: type: string enum: - video - audio - pdf description: メディアタイプ deprecated: false level_type: type: string enum: - level1 - level2 description: プレイリストの階層種別 deprecated: false public_setting: type: object properties: type: type: string enum: - public - private - period description: 公開タイプ deprecated: false start: type: string description: >- 公開開始日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true end: type: string description: >- 公開終了日時。JSTのタイムゾーン情報が付与されたISO 8601形式の日時文字列です。
`type` が **period** の場合、`start` と `end` のどちらかは必須です。 deprecated: false nullable: true required: - type example: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 contentType: application/json description: 公開設定。2階層構成の親のプレイリストの場合は必ずNoneを返します deprecated: false nullable: true description: type: string description: 説明文 deprecated: false is_password_required: type: boolean description: パスワード設定情報 deprecated: false created_at: type: string description: プレイリスト登録日 deprecated: false updated_at: type: string description: プレイリスト更新日 deprecated: false parent_playlist_id: type: string description: >- 2階層の子のプレイリスト指定時は親のプレイリストIDを返します。2階層の親のプレイリスト指定時はNoneを返します。 deprecated: false nullable: true auto_playlist_config: type: object properties: sort_by: type: string enum: - latest - playcount - random description: プレイリストを自動作成する際に再生順の基準となる項目。 deprecated: false limit: type: integer description: プレイリストを自動作成する際に含めたいコンテンツ数を指定します。 deprecated: false tags: type: array items: type: string description: プレイリストを自動作成する際にコンテンツのタグで取得対象を絞り込むときに指定します。 deprecated: false nullable: true latest: type: integer description: >- プレイリストを自動作成する際に当日から指定日数内に登録されたコンテンツを絞り込むときに指定します。 deprecated: false nullable: true required: - sort_by - limit example: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 contentType: application/json description: プレイリストを自動で作成する際の設定 deprecated: false nullable: true thumbnail_url: type: string description: サムネイルURL deprecated: false nullable: true content_count: type: integer description: プレイリスト内のコンテンツ数 deprecated: false default: 0 required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json description: プレイリスト内のプレイリストの一覧情報 deprecated: false nullable: true required: - playlist_id - title - playlist_type - media_type - level_type - public_setting - description - is_password_required - created_at - updated_at example: playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contents: - content_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル status: CONVERT_COMPLETED created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' description: 説明 media_type: video public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 conversion_rate: 100 duration: 0 thumbnail_info: - path: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg id: '1' is_active: true thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file.0000000.jpg pdf_info: image_file_path: >- a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9xxb-5324bddbafc9/origin_file total_page_count: 1 thumbnail_url: https://example.com/pdf_thumbnail.0000000.jpg origin_file_name: origin_file.mp4 origin_file_size: 1024 tag: - tag1 - tag2 is_password_required: false parent_content_id: 4ba28124-c54f-83d8-9abb-5324bddbafc9 storage_amount: 1024 recipe_id: '1' subtitles: - subtitle_id: 1fb76906-9f13-49fe-a13f-46714d81c250 label: 日本語 srclang: ja is_default: false is_enabled: false order: 0 status: PROCESSED created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 chapter: label: 第1章 is_enabled: false created_at: 2022-01-01T00:00:00.000000+0900 updated_at: 2022-01-01T00:00:00.000000+0900 origin_file_dimension: width: 1920 height: 1080 parent_folders: - content_id: 4ba28124-c54g-83d8-9xxb-5324bddbafc9 title: folder001 playlists: - playlist_id: 4ba28124-c54f-83d8-9aab-5324bddbafc9 title: タイトル playlist_type: manual media_type: video level_type: level1 public_setting: type: period start: 2022-03-01T00:00:00.000000+0900 end: 2022-04-01T00:00:00.000000+0900 description: 説明 is_password_required: false created_at: 2022-03-01T00:00:00.000000+0900 updated_at: 2022-04-01T00:00:00.000000+0900 parent_playlist_id: null auto_playlist_config: sort_by: latest limit: 5 tags: - tag1 - tag2 latest: 5 thumbnail_url: >- https://example.com/a4f648808d00ce7fdc2ccc7477a66620be490c3/4ba28124-c54g-83d8-9aab-5324bddbafc9/origin_file.0000000.jpg content_count: 0 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/playlists/{playlist_id}' -H 'Authorization: Bearer {access_token}' summary: プレイリスト詳細情報取得 description: プレイリスト詳細情報を取得します。 /playlists/{playlist_id}/preview/html: post: tags: - preview operationId: post-playlists-{playlist_id}-preview-html parameters: - name: playlist_id in: path description: プレイリストID required: true schema: type: string description: プレイリストID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 466ed4ac-91b7-40b6-aaea-a742d959dc04 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: url: type: string description: 簡易視聴URL deprecated: false required: - url example: url: >- https://preview.millvi.com/7ZaOhA0Q0tMTqHC8ExpOLDEdetCb3zKzQYFHIh9RpuI= contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLL_0005 properties: errorCode: type: string enum: - MVOD_PLL_0005 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_PPH_0001 properties: errorCode: type: string enum: - MVOD_PPH_0001 description: エラーコード reason: type: string enum: - この条件で簡易視聴ページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/playlists/{playlist_id}/preview/html' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "466ed4ac-91b7-40b6-aaea-a742d959dc04" }' summary: プレイリスト簡易視聴ページURL発行 description: プレイリストコンテンツ簡易視聴ページのURLを返します。 /playlists/{playlist_id}/iframe: post: tags: - iframe operationId: post-playlists-{playlist_id}-iframe parameters: - name: playlist_id in: path description: プレイリストID required: true schema: type: string description: プレイリストID deprecated: false requestBody: content: application/json: schema: type: object properties: player_id: type: integer description: プレイヤーID deprecated: false nullable: true security_config_id: type: string description: セキュリティ設定ID deprecated: false minLength: 1 nullable: true example: player_id: 3 security_config_id: 466ed4ac-91b7-40b6-aaea-a742d959dc04 contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: iframe_tag: type: string description: iframeタグ deprecated: false required: - iframe_tag example: iframe_tag: >- contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_PLY_0005 properties: errorCode: type: string enum: - MVOD_PLY_0005 description: エラーコード reason: type: string enum: - 存在しないプレイヤー設定が指定されました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_SEC_0003 properties: errorCode: type: string enum: - MVOD_SEC_0003 description: エラーコード reason: type: string enum: - 存在しないセキュリティ設定が指定されました。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_PLL_0005 properties: errorCode: type: string enum: - MVOD_PLL_0005 description: エラーコード reason: type: string enum: - 存在しないプレイリストです。 description: エラーメッセージ contentType: application/json '409': headers: Access-Control-Allow-Origin: schema: type: '*' description: Conflict content: application/json: schema: type: object title: MVOD_IPH_0001 properties: errorCode: type: string enum: - MVOD_IPH_0001 description: エラーコード reason: type: string enum: - この条件でiframeページを生成できません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/playlists/{playlist_id}/iframe' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "player_id": 3, "security_config_id": "466ed4ac-91b7-40b6-aaea-a742d959dc04" }' summary: プレイリスト視聴用iframe発行 description: プレイリストコンテンツ視聴用のiframeを発行します。 /jobs/csv/{job_id}: get: tags: - jobs operationId: get-jobs-csv-{job_id} parameters: - name: job_id in: path description: ジョブID required: true schema: type: string description: ジョブID deprecated: false minLength: 1 - name: encode in: query description: エンコード
CSVファイルの文字コードを指定します。 schema: type: string enum: - utf-8 - shift-jis description: エンコード
CSVファイルの文字コードを指定します。 deprecated: false default: utf-8 - name: simplified in: query description: >- 簡略版CSVを取得するかどうか
`true`のとき簡略版CSVのダウンロードURLを返します。簡略版が未生成のジョブでは`download_url`は`null`になります。 schema: type: boolean description: >- 簡略版CSVを取得するかどうか
`true`のとき簡略版CSVのダウンロードURLを返します。簡略版が未生成のジョブでは`download_url`は`null`になります。 deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false api_request: type: string description: CSV生成するAPIに渡すリクエストをJSON化した文字列 deprecated: false requested_at: type: string description: ジョブ作成日時 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false download_url: type: string description: >- CSVファイルダウンロード用のURL
`status: generated`のときだけ設定されます。発行されたダウンロードURLは1時間で失効します。 deprecated: false nullable: true error_code: type: string description: >- ジョブの実行に失敗した際に際に送出されるエラーコード
`status: failed`の場合にのみ値が入ります。エラーの内容については、当該の生成APIの元のAPIのドキュメントを参照してください。 deprecated: false nullable: true required: - job_id - api_path - api_request - requested_at - status example: job_id: job_id api_path: /vod/contents/statistics api_request: '{"from": "2024-06-01", "to": "2024-06-30"}' requested_at: 2020-01-01T00:00:00.000000+0900 status: generated download_url: https://example.com error_code: MVOD_CMN_0020 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/jobs/csv/{job_id}?encode=utf-8&simplified=False' -H 'Authorization: Bearer {access_token}' summary: CSV生成ジョブ詳細取得 description: CSV生成ジョブ詳細情報を取得します。 /jobs/csv: get: tags: - jobs operationId: get-jobs-csv parameters: - name: statuses in: query description: >- ステータス
ジョブのステータス(`generating`,`generated`,`failed`,`expired`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでor条件で絞り込まれます。上記に合致しないステータスを指定した場合無視されます。 schema: type: string description: >- ステータス
ジョブのステータス(`generating`,`generated`,`failed`,`expired`)で取得対象を絞り込むときに指定します。カンマ区切りで複数指定することでor条件で絞り込まれます。上記に合致しないステータスを指定した場合無視されます。 deprecated: false default: generating,generated,failed - name: encode in: query description: エンコード
CSVファイルの文字コードを指定します。 schema: type: string enum: - utf-8 - shift-jis description: エンコード
CSVファイルの文字コードを指定します。 deprecated: false default: utf-8 - name: simplified in: query description: >- 簡略版CSVを取得するかどうか
`true`のとき簡略版CSVのダウンロードURLを返します。簡略版が未生成のジョブでは`download_url`は`null`になります。 schema: type: boolean description: >- 簡略版CSVを取得するかどうか
`true`のとき簡略版CSVのダウンロードURLを返します。簡略版が未生成のジョブでは`download_url`は`null`になります。 deprecated: false default: false responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: itemsの総数 deprecated: false items: type: array items: type: object properties: job_id: type: string description: ジョブID deprecated: false api_path: type: string description: CSV生成するAPIのパス deprecated: false api_request: type: string description: CSV生成するAPIに渡すリクエストをJSON化した文字列 deprecated: false requested_at: type: string description: ジョブ作成日時 deprecated: false status: type: string enum: - generating - generated - failed - expired description: ジョブのステータス deprecated: false download_url: type: string description: >- CSVファイルダウンロード用のURL
`status: generated`のときだけ設定されます。発行されたダウンロードURLは1時間で失効します。 deprecated: false nullable: true error_code: type: string description: >- ジョブの実行に失敗した際に際に送出されるエラーコード
`status: failed`の場合にのみ値が入ります。エラーの内容については、当該の生成APIの元のAPIのドキュメントを参照してください。 deprecated: false nullable: true required: - job_id - api_path - api_request - requested_at - status example: job_id: job_id api_path: /vod/contents/statistics api_request: '{"from": "2024-06-01", "to": "2024-06-30"}' requested_at: 2020-01-01T00:00:00.000000+0900 status: generated download_url: https://example.com error_code: MVOD_CMN_0020 contentType: application/json description: '' deprecated: false required: - total_count - items example: total_count: 1 items: - job_id: job_id api_path: /vod/contents/statistics api_request: '{"from": "2024-06-01", "to": "2024-06-30"}' requested_at: 2020-01-01T00:00:00.000000+0900 status: generated download_url: https://example.com error_code: MVOD_CMN_0020 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X GET 'https://${end_point}/jobs/csv?statuses=generating,generated,failed&encode=utf-8&simplified=False' -H 'Authorization: Bearer {access_token}' summary: CSV生成ジョブ一覧取得 description: CSV生成ジョブ一覧情報を取得します。 /notifications/destination: post: tags: - notifications_destination operationId: post-notifications-destination parameters: [] requestBody: content: application/json: schema: type: object properties: name: type: string description: 通知先名 deprecated: false maxLength: 1024 minLength: 1 email_address: type: string description: メールアドレス deprecated: false maxLength: 1024 minLength: 1 nullable: true webhook_url: type: string description: ウェブフック通知先URL deprecated: false maxLength: 4096 minLength: 1 nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false required: - name example: name: 通知先1 email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: notification_destination_id: type: string description: 通知先ID deprecated: false name: type: string description: 通知先名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false email_address: type: string description: メールアドレス deprecated: false nullable: true webhook_url: type: string description: ウェブフック通知先URL deprecated: false nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false email_verified: type: boolean description: メールアドレス確認済みフラグ deprecated: false default: false nullable: true verification_code_enabled: type: boolean description: 認証コード期限フラグ deprecated: false default: false nullable: true webhook_token: type: string description: Webhook認証トークン deprecated: false nullable: true required: - notification_destination_id - name - created_at - updated_at example: notification_destination_id: sample_notification_destination_id name: 通知先1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start email_verified: 'True' verification_code_enabled: 'True' webhook_token: 550e8400-e29b-41d4-a716-446655440000 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0016 properties: errorCode: type: string enum: - MVOD_CMN_0016 description: エラーコード reason: type: string enum: - パラメーターの値は許容された形式にしてください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0001 properties: errorCode: type: string enum: - MVOD_NOT_0001 description: エラーコード reason: type: string enum: - 指定された通知対象アクションはサポートされていません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0002 properties: errorCode: type: string enum: - MVOD_NOT_0002 description: エラーコード reason: type: string enum: - メールアドレスもしくはウェブフックURLのいずれかを指定してください。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0003 properties: errorCode: type: string enum: - MVOD_NOT_0003 description: エラーコード reason: type: string enum: - 指定されたメールアドレスはすでに登録されています。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X POST 'https://${end_point}/notifications/destination' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "name": "通知先1", "email_address": "example@example.com", "webhook_url": "https://example.com/webhook", "action_categories": [ { "category": "live_content", "sub_category": "live_channel_start" } ] }' summary: 通知先設定作成 description: 通知先設定を作成します。 get: tags: - notifications_destination operationId: get-notifications-destination responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: total_count: type: integer description: 取得した通知先の数 deprecated: false items: type: array items: type: object properties: notification_destination_id: type: string description: 通知先ID deprecated: false name: type: string description: 通知先名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false email_address: type: string description: メールアドレス deprecated: false nullable: true webhook_url: type: string description: ウェブフック通知先URL deprecated: false nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false email_verified: type: boolean description: メールアドレス確認済みフラグ deprecated: false default: false nullable: true verification_code_enabled: type: boolean description: 認証コード期限フラグ deprecated: false default: false nullable: true webhook_token: type: string description: Webhook認証トークン deprecated: false nullable: true required: - notification_destination_id - name - created_at - updated_at example: notification_destination_id: sample_notification_destination_id name: 通知先1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start email_verified: 'True' verification_code_enabled: 'True' webhook_token: 550e8400-e29b-41d4-a716-446655440000 contentType: application/json description: 通知宛先一覧 deprecated: false required: - total_count - items example: total_count: 1 items: - notification_destination_id: sample_notification_destination_id name: 通知先1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start email_verified: true verification_code_enabled: true webhook_token: 550e8400-e29b-41d4-a716-446655440000 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: |- curl -v -X GET 'https://${end_point}/notifications/destination' -H 'Authorization: Bearer {access_token}' summary: 通知宛先一覧取得 description: 通知宛先一覧を取得します。 /notifications/destination/{notification_destination_id}: delete: tags: - notifications_destination operationId: delete-notifications-destination-{notification_destination_id} parameters: - name: notification_destination_id in: path description: 通知先ID required: true schema: type: string description: 通知先ID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: notification_destination_id: type: string description: 通知先ID deprecated: false required: - notification_destination_id example: notification_destination_id: f8412015-f18a-47f6-814b-4a36436f2c71 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_NOT_0009 properties: errorCode: type: string enum: - MVOD_NOT_0009 description: エラーコード reason: type: string enum: - 存在しない通知先IDが指定されました。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X DELETE 'https://${end_point}/notifications/destination/{notification_destination_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: 通知先設定削除 description: 通知先設定を削除します。 patch: tags: - notifications_destination operationId: patch-notifications-destination-{notification_destination_id} parameters: - name: notification_destination_id in: path description: 通知先ID required: true schema: type: string description: 通知先ID deprecated: false requestBody: content: application/json: schema: type: object properties: name: type: string description: 通知先名 deprecated: false maxLength: 1024 minLength: 1 nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false nullable: true example: name: 通知先1 action_categories: - category: live_content sub_category: live_channel_start contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: notification_destination_id: type: string description: 通知先ID deprecated: false name: type: string description: 通知先名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false email_address: type: string description: メールアドレス deprecated: false nullable: true webhook_url: type: string description: ウェブフック通知先URL deprecated: false nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false email_verified: type: boolean description: メールアドレス確認済みフラグ deprecated: false default: false nullable: true verification_code_enabled: type: boolean description: 認証コード期限フラグ deprecated: false default: false nullable: true webhook_token: type: string description: Webhook認証トークン deprecated: false nullable: true required: - notification_destination_id - name - created_at - updated_at example: notification_destination_id: sample_notification_destination_id name: 通知先1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start email_verified: 'True' verification_code_enabled: 'True' webhook_token: 550e8400-e29b-41d4-a716-446655440000 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0022 properties: errorCode: type: string enum: - MVOD_CMN_0022 description: エラーコード reason: type: string enum: - '[param]([value])は [condition] の長さである必要があります。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0001 properties: errorCode: type: string enum: - MVOD_NOT_0001 description: エラーコード reason: type: string enum: - 指定された通知対象アクションはサポートされていません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_NOT_0004 properties: errorCode: type: string enum: - MVOD_NOT_0004 description: エラーコード reason: type: string enum: - 通知先が見つかりません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X PATCH 'https://${end_point}/notifications/destination/{notification_destination_id}' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "name": "通知先1", "action_categories": [ { "category": "live_content", "sub_category": "live_channel_start" } ] }' summary: 通知先設定更新 description: 通知先設定を更新します。 /notifications/destination/{notification_destination_id}/verify/send: post: tags: - notifications_destination operationId: post-notifications-destination-{notification_destination_id}-verify-send parameters: - name: notification_destination_id in: path description: 通知先ID required: true schema: type: string description: 通知先ID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: expires_at: type: string description: 有効期限 deprecated: false required: - expires_at example: expires_at: '2022-01-01T00:00:00+09:00' contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0005 properties: errorCode: type: string enum: - MVOD_NOT_0005 description: エラーコード reason: type: string enum: - 通知先はメールタイプではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0008 properties: errorCode: type: string enum: - MVOD_NOT_0008 description: エラーコード reason: type: string enum: - このメールアドレスは既に確認済みです。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_NOT_0004 properties: errorCode: type: string enum: - MVOD_NOT_0004 description: エラーコード reason: type: string enum: - 通知先が見つかりません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0010 properties: errorCode: type: string enum: - MVOD_NOT_0010 description: エラーコード reason: type: string enum: - 認証メールの送信に失敗しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/notifications/destination/{notification_destination_id}/verify/send' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: 通知宛先確認メール送信 description: 通知宛先のメールアドレスに確認メールを送信します。 /notifications/destination/{notification_destination_id}/verify: post: tags: - notifications_destination operationId: post-notifications-destination-{notification_destination_id}-verify parameters: - name: notification_destination_id in: path description: 通知先ID required: true schema: type: string description: 通知先ID deprecated: false requestBody: content: application/json: schema: type: object properties: verification_code: type: string description: 認証コード deprecated: false required: - verification_code example: verification_code: '123456' contentType: application/json responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: verified: type: boolean description: 確認済みフラグ deprecated: false required: - verified example: verified: true contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0005 properties: errorCode: type: string enum: - MVOD_NOT_0005 description: エラーコード reason: type: string enum: - 通知先はメールタイプではありません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0006 properties: errorCode: type: string enum: - MVOD_NOT_0006 description: エラーコード reason: type: string enum: - 認証コードの有効期限が切れています。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0007 properties: errorCode: type: string enum: - MVOD_NOT_0007 description: エラーコード reason: type: string enum: - 認証コードが一致しません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_NOT_0004 properties: errorCode: type: string enum: - MVOD_NOT_0004 description: エラーコード reason: type: string enum: - 通知先が見つかりません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X POST 'https://${end_point}/notifications/destination/{notification_destination_id}/verify' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' -d '{ "verification_code": "123456" }' summary: 通知宛先確認 description: 通知宛先のメールアドレスを確認します。 /notifications/destination/{notification_destination_id}/webhook_token: patch: tags: - notifications_destination operationId: >- patch-notifications-destination-{notification_destination_id}-webhook_token parameters: - name: notification_destination_id in: path description: 通知先ID required: true schema: type: string description: 通知先ID deprecated: false requestBody: content: {} responses: '200': headers: Access-Control-Allow-Origin: schema: type: '*' description: OK content: application/json: schema: type: object properties: notification_destination_id: type: string description: 通知先ID deprecated: false name: type: string description: 通知先名 deprecated: false created_at: type: string description: 作成日時 deprecated: false updated_at: type: string description: 更新日時 deprecated: false email_address: type: string description: メールアドレス deprecated: false nullable: true webhook_url: type: string description: ウェブフック通知先URL deprecated: false nullable: true action_categories: type: array items: type: object properties: category: type: string enum: - vod_content - live_content - content_security description: >- 通知カテゴリー
通知カテゴリー種類
vod_content通常コンテンツ
live_contentライブコンテンツ
content_securityセキュリティーコンテンツ
deprecated: false sub_category: type: string enum: - create - update - delete - conversion_start - conversion_complete - conversion_failure - transcription_complete - live_channel_start - live_channel_stop - live_channel_auto_stop_alert description: >- 通知サブカテゴリー
通知カテゴリー通知サブカテゴリー種類
vod_contentcreate作成
vod_contentupdate更新
vod_contentdelete削除
vod_contentconversion_complete変換完了
vod_contentconversion_failure変換失敗
vod_contenttranscription_complete文字起こし完了
live_contentlive_channel_startライブ配信開始
live_contentlive_channel_stopライブ配信停止
live_contentlive_channel_auto_stop_alertライブ配信自動停止の警告
deprecated: false required: - category - sub_category example: category: live_content sub_category: live_channel_start contentType: application/json description: 通知対象アクションの分類 deprecated: false email_verified: type: boolean description: メールアドレス確認済みフラグ deprecated: false default: false nullable: true verification_code_enabled: type: boolean description: 認証コード期限フラグ deprecated: false default: false nullable: true webhook_token: type: string description: Webhook認証トークン deprecated: false nullable: true required: - notification_destination_id - name - created_at - updated_at example: notification_destination_id: sample_notification_destination_id name: 通知先1 created_at: '2022-03-01 00:00:00.000000+09:00' updated_at: '2022-04-01 00:00:00.000000+09:00' email_address: example@example.com webhook_url: https://example.com/webhook action_categories: - category: live_content sub_category: live_channel_start email_verified: 'True' verification_code_enabled: 'True' webhook_token: 550e8400-e29b-41d4-a716-446655440000 contentType: application/json '400': headers: Access-Control-Allow-Origin: schema: type: '*' description: Bad Request content: application/json: schema: oneOf: - type: object title: MVOD_CMN_0005 properties: errorCode: type: string enum: - MVOD_CMN_0005 description: エラーコード reason: type: string enum: - 必須パラメーターが存在しません。[param_names] description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0013 properties: errorCode: type: string enum: - MVOD_CMN_0013 description: エラーコード reason: type: string enum: - '[param]の値([value])が不正です。' description: エラーメッセージ contentType: application/json - type: object title: MVOD_CMN_0018 properties: errorCode: type: string enum: - MVOD_CMN_0018 description: エラーコード reason: type: string enum: - 実行ユーザーが存在しません。 description: エラーメッセージ contentType: application/json - type: object title: MVOD_NOT_0011 properties: errorCode: type: string enum: - MVOD_NOT_0011 description: エラーコード reason: type: string enum: - 通知先はWebhookタイプではありません。 description: エラーメッセージ contentType: application/json '401': headers: Access-Control-Allow-Origin: schema: type: '*' description: Unauthorized content: application/json: schema: type: object title: MVOD_CMN_0002 properties: errorCode: type: string enum: - MVOD_CMN_0002 description: エラーコード reason: type: string enum: - 認証に失敗しました。 description: エラーメッセージ contentType: application/json '403': headers: Access-Control-Allow-Origin: schema: type: '*' description: Forbidden content: application/json: schema: type: object title: MVOD_CMN_0027 properties: errorCode: type: string enum: - MVOD_CMN_0027 description: エラーコード reason: type: string enum: - ユーザーに実行権限がありません。 description: エラーメッセージ contentType: application/json '404': headers: Access-Control-Allow-Origin: schema: type: '*' description: Not Found content: application/json: schema: type: object title: MVOD_NOT_0004 properties: errorCode: type: string enum: - MVOD_NOT_0004 description: エラーコード reason: type: string enum: - 通知先が見つかりません。 description: エラーメッセージ contentType: application/json '500': headers: Access-Control-Allow-Origin: schema: type: '*' description: Internal Server Error content: application/json: schema: type: object title: MVOD_CMN_0012 properties: errorCode: type: string enum: - MVOD_CMN_0012 description: エラーコード reason: type: string enum: - サーバー側で何かしらの問題が発生しました。 description: エラーメッセージ contentType: application/json security: - token: [] x-codeSamples: - lang: shell source: >- curl -v -X PATCH 'https://${end_point}/notifications/destination/{notification_destination_id}/webhook_token' -H 'Authorization: Bearer {access_token}' -H 'Content-Type: application/json' summary: Webhook認証トークン更新 description: Webhook通知先の認証トークンを更新します。 components: securitySchemes: token: type: http scheme: bearer x-tagGroups: - name: 管理用API tags: - contents - folder_service - subtitle_service - chapter_service - file_upload_service - recipes - player_customization_service - contents_security_service - embedkey - secret_key_service - preview - iframe - live_content_service - live_channel_service - analytics_service - playlist_service - jobs - notifications_destination - name: 視聴用API tags: - player