カテゴリの更新
    • PDF

    カテゴリの更新

    • PDF

    記事の要約

    VOD Stationはカテゴリを更新するための APIを提供します。

    リクエスト

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

    リクエストヘッダ

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

    リクエストボディ

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

    フィールド名必須の有無タイプ制限事項デフォルト値説明
    encodingOptions[]NoArray(Integer)NULLカテゴリに設定するエンコードオプション
    encodingOptionTemplateIdNoIntegerエンコードテンプレート IDで、encodingOptions[]と encodingOptionTemplateIdは重複して設定不可
    thumbnailNoBooleantrue, falseFALSEサムネイル抽出設定
    outputYesObjectカテゴリの出力設定
    output.thumbnailBucketNameOptionalStringサムネイル出力バケット名
    output.thumbnailFilePathOptionalString1~256文字以内で入力(英数字、< > : " / \ ? * %を除く記号は入力可)サムネイル出力ファイルをアップロードする詳細パス
    advancedOptionsNoObjectNULL高度な設定
    advancedOptions.trimmingNoObjectNULL出力ファイルのトリミング設定
    advancedOptions.trimming.startTimeCodeYesString形式: 「HH:MM:SS.S」トリミングの開始時点で、タイムコードフォーマットに合わせて値を入力
    advancedOptions.trimming.endTimeCodeYesString- 形式: 「HH:MM:SS.S」
    - startTimeCodeより小さな値は入力不可
    トリミングの終了時点で、タイムコードフォーマットに合わせて値を入力
    advancedOptions.imageOverlayNoObjectNULL画像オーバーレイ設定
    advancedOptions.imageOverlay.inputYesObject入力画像
    advancedOptions.imageOverlay.input.bucketNameYesString入力画像がアップロードされているバケット名
    advancedOptions.imageOverlay.input.filePathYesString入力画像の詳細パス
    advancedOptions.imageOverlay.positionYesObject挿入する画像位置の設定
    advancedOptions.imageOverlay.position.xYesIntegerx軸の位置
    advancedOptions.imageOverlay.position.yYesIntegery軸の位置
    advancedOptions.imageOverlay.sizeYesObejct挿入する画像サイズの設定
    advancedOptions.imageOverlay.size.widthYesInteger画像の幅
    advancedOptions.imageOverlay.size.heightYesInteger画像の高さ

    レスポンス

    | フィールド名 | タイプ | 説明 | 備考 |
    |--- |--- |--- |--- |
    | 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 | subaccountで提供されるフィールド
    そのリソースが subaccountで有効になっているかどうか | |
    | content.inputTotal | Integer | 入力ファイルの総数 | |
    | content.lastWorkStart | Integer | 最後の作業時間 | |
    | content.outputTotal | Integer | 出力ファイルの総数 | |
    | content.outputTotalSize | Integer | 出力ファイルの総容量(単位: byte) | |
    | 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 | 画像の高さ | |

    リクエスト例

    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
      }
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.