カテゴリ作成

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VOD Stationは、カテゴリの作成のための APIをご提供し、作成されたカテゴリの照会のために、カテゴリリストの照会 APIとカテゴリ情報の照会 APIを提供します。

リクエスト

POST https://vodstation.apigw.ntruss.com/api/v2/category

リクエストヘッダ

ヘッダ名	説明
x-ncp-region_code	NAVERクラウドプラットフォームの region code `x-ncp_region_code:{Region Code}`
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルで発行された Access Key ID値 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエストボディ

APIリクエスト時にフィールド名の大文字・小文字の区別が必要です。

フィールド名	必須の有無	タイプ	制約事項	デフォルト値	説明
name	Yes	String			- 作成するカテゴリ名 output.bucketNameにこのカテゴリ名を持つフォルダを自動作成
encodingOptions[]	No	Array(Integer)		NULL	カテゴリに設定するエンコードオプション
encodingOptionTemplateId	No	Integer			- エンコードテンプレート ID エンコードテンプレートを照会して確認した IDを入力テンプレートに含まれている encodingOptionIdを encodingOptions[]フィールド値に設定 encodingOptions[]フィールド値で、テンプレート内の encodingOptionId以外の IDは設定不可
thumbnail	No	Boolean	true, false	FALSE	サムネイル抽出設定
notificationUrl	No	String			Callback URL設定
output	Yes	Object			カテゴリの出力設定
output.bucketName	Yes	String			出力バケット名
output.filePath	Yes	String	最低1文字以上、最大256文字まで入力(英字、数字、< > : " / \ ? * %を除く特殊文字は入力可能)		出力ファイルをアップロードする詳細パス
output.thumbnailBucketName	Optional	String	入力しない場合に、 output.bucketName設定に従う		サムネイル出力バケット名
output.thumbnailFilePath	Optional	String	入力しない場合に、 output.filePath設定に従う最低1文字以上、最大256文字まで入力(英字、数字、< > : " / \ ? * %を除く特殊文字は入力可能)		サムネイル出力ファイルをアップロードする詳細パス
output.accessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	出力ファイルの公開範囲
output.thumbnailAccessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	出力サムネイルの公開範囲
advancedOptions	No	Object		NULL	高度な設定
advancedOptions.trimming	No	Object		NULL	出力ファイルのトリミング設定
advancedOptions.trimming.startTimeCode	Yes	String	フォーマット: "HH:MM:SS.S"		- トリミングの開始時点タイムコードフォーマットに合わせて値を入力
advancedOptions.trimming.endTimeCode	Yes	String	フォーマット: "HH:MM:SS.S", startTimeCodeより小さな値は入力不可		- トリミングの終了時点タイムコードフォーマットに合わせて値を入力
advancedOptions.imageOverlay	No	Object		NULL	画像オーバーレイ設定
advancedOptions.imageOverlay.input	Yes	Object			入力画像
advancedOptions.imageOverlay.input.bucketName	Yes	String			入力画像がアップロードされているバケット名
advancedOptions.imageOverlay.input.filePath	Yes	String			ファイル名を含む入力画像の詳細パス
advancedOptions.imageOverlay.position	Yes	Object			挿入する画像位置の設定
advancedOptions.imageOverlay.position.x	Yes	Integer			x軸の位置
advancedOptions.imageOverlay.position.y	Yes	Integer			y軸の位置
advancedOptions.imageOverlay.size	Yes	Obejct			挿入する画像サイズの設定
advancedOptions.imageOverlay.size.width	Yes	Integer			画像の幅
advancedOptions.imageOverlay.size.height	Yes	Integer			画像の高さ

レスポンス

フィールド名	タイプ	説明	備考
error	Object	リクエスト失敗時のレスポンスエラーレスポンスコードとメッセージ
error.code	Integer	エラーレスポンスコード
error.message	String	エラーレスポンスメッセージ
content	Object	VOD Station OPEN APIレスポンスオブジェクト
content.id	String	作成されたカテゴリの ID
content.name	String	カテゴリ名
content.encodingOptions[]	Array(Integer)	エンコードオプション ID
content.encodingOptionTemplateId	Integer	エンコードテンプレート ID
content.thumbnail	Boolean	サムネイル抽出設定
content.notificationUrl	String	Callback URL設定
content.output	Object	出力設定
content.output.bucketName	String	出力バケット名
content.output.filePath	String	出力ファイルをアップロードする詳細パス
content.output.thumbnailBucketName	String	サムネイル出力バケット名
content.output.thumbnailFilePath	String	サムネイル出力出力ファイルのアップロードの詳細パス
content.output.accessControl	String	出力ファイルの公開範囲
content.output.thumbnailAccessControl	String	出力サムネイルの公開範囲
content.status	String	カテゴリの状態	CREATED, DELETED, RUNNING
content.createTime	Integer	カテゴリの作成時間
content.updateTime	Integer	カテゴリの修正時間
content.disabled	Boolean	Sub Accountで提供されるフィールド当該リソースの subaccountでの有効有無
content.outputType	Integer	設定されたエンコード設定に応じた出力タイプ数
content.advancedOptions	Object	高度な設定
content.advancedOptions.trimming	Object	出力ファイルのトリミング設定
content.advancedOptions.trimming.startTimeCode	String	トリミングの開始時点
content.advancedOptions.trimming.endTimeCode	String	トリミングの終了時点
content.advancedOptions.imageOverlay	Object	画像オーバーレイ設定
content.advancedOptions.imageOverlay.input	Object	入力画像
content.advancedOptions.imageOverlay.input.bucketName	String	入力画像がアップロードされているバケット名
content.advancedOptions.imageOverlay.input.filePath	String	入力画像の詳細パス
content.advancedOptions.imageOverlay.position	Object	挿入する画像位置の設定
content.advancedOptions.imageOverlay.position.x	Integer	x軸の位置
content.advancedOptions.imageOverlay.position.y	Integer	y軸の位置
content.advancedOptions.imageOverlay.size	Obejct	挿入する画像サイズの設定
content.advancedOptions.imageOverlay.size.width	Integer	画像の幅
content.advancedOptions.imageOverlay.size.height	Integer	画像の高さ

例

リクエスト例

POST https://vodstation.apigw.ntruss.com/api/v2/category

POST /api/v2/category
HOST: vodstation.apigw.ntruss.com
Content-Type: application/json
x-ncp-region_code:KR
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

Reqeust body
{
  "encodingOptions": [
    1, 2, 3
  ],
  "name": "3type-basic-category",
  "output": {
    "bucketName": "vs-output",
    "filePath": "/"
  },
  "thumbnail": false
}

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": {
    "disabled": false,
    "id": 10095,
    "name": "3type-basic-category",
    "thumbnail": false,
    "output": {
      "bucketName": "vs-output",
      "filePath": "/"
    },
    "createTime": 1631594152000,
    "updateTime": 1631594152000,
    "status": "CREATED",
    "outputType": 3,
    "encodingOptions": [
      1,
      2,
      3
    ]
  }
}

Callback Bodyの例

{
  "categoryId":10268,
  "categoryName":"callback-test",
  "encodingOptionId":3,
  "fileId":10808,
  "filePath":"/.../Guide720_AVC_HD_1Pass_30fps.mp4",
  "outputType":"AVC_HD_1Pass_30fps",
  "status":"RUNNING"
}

この記事は役に立ちましたか?

What's Next

カテゴリ削除

リクエスト
レスポンス
例

タグ

VOD Station