リクエスト

PUT https://vodstation.apigw.ntruss.com/api/v2/category/{categoryId}

リクエストヘッダ

ヘッダ名	説明
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リクエスト時はフィールド名の大文字、小文字の区別が必要です。

フィールド名	必須の有無	タイプ	制限事項	デフォルト値	説明
encodingOptions[]	No	Array(Integer)		NULL	カテゴリに設定するエンコードオプション
encodingOptionTemplateId	No	Integer			エンコードテンプレート IDで、encodingOptions[]と encodingOptionTemplateIdは重複して設定不可
thumbnail	No	Boolean	true, false	FALSE	サムネイル抽出設定
output	Yes	Object			カテゴリの出力設定
output.thumbnailBucketName	Optional	String			サムネイル出力バケット名
output.thumbnailFilePath	Optional	String	1~256文字以内で入力(英数字、< > : " / \ ? * %を除く記号は入力可)		サムネイル出力ファイルをアップロードする詳細パス
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			画像の高さ

レスポンス

例

リクエスト例

PUT https://vodstation.apigw.ntruss.com/api/v2/category/10095

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

Reqeust body
{
  "encodingOptionTemplateId": 1,
  "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": "/"
    },
    "lastWorkStart": 1631594173000,
    "createTime": 1631594152000,
    "updateTime": 1631597071000,
    "status": "CREATED",
    "outputTotalSize": 50182015,
    "outputTotal": 2,
    "inputTotal": 2,
    "encodingOptionTemplateId": 1
  }
}

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

リクエスト
- リクエストヘッダ
- リクエストボディ
レスポンス
例
- リクエスト例
- レスポンス例

タグ

VOD Station