← 返回 API 列表 ← 项目门户

更新视频

关键信息详情
文档 ID1696710605909004
标签 ID7
原始文档[https://open.oceanengine.com/labels/7/docs/1696710605909004](https://open.oceanengine.com/labels/7/docs/1696710605909004)
接口标识material.video.update
💡通过此接口,用户可以批量更新素材视频的名称。需配合【获取Access token】接口获取授权access_token,对于短漫剧行业白名单客户,可通过【查询白名单能力】接口查询账户是否具备特定标签能力。 通过此接口,用户可以批量更新素材视频的名称。
POST https://api.oceanengine.com/open_api/2/file/video/update/ 🔍 可视化调试 📦 SDK下载

接口说明

通过此接口,用户可以批量更新素材视频的名称。需配合【获取Access token】接口获取授权access_token,对于短漫剧行业白名单客户,可通过【查询白名单能力】接口查询账户是否具备特定标签能力。

通过此接口,用户可以批量更新素材视频的名称。

请求地址

https://api.oceanengine.com/open_api/2/file/video/update/可视化调试SDK下载MCP调用

请求方法

POST

Header

字段 类型 必填 描述
Access-Token string 必填 授权access_token,可以通过【获取Access token】接口获取
Content-Type string 必填 请求消息类型
允许值: application/json

请求参数

字段 类型 必填 描述
advertiser_id number 必填 客户ID
videos(object[],必填) — 限制最多 100 个 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `video_id` | string | 必填 | 视频id | | `filename` | string | 必填 | 视频素材名称,最多255个字 | | `labels` | string[] | 否 | 标签- 注意:采用全量更新逻辑。不传该字段默认不更新;传入非空数组将完全替换该视频当前的所有标签;传入空数组即清空当前所有标签。
- 请优先为无需付费信息的素材传入`仅IAA`标签,标记该素材仅IAA模式投放,不参与IAP模式投放;未传入该标签,素材默认为通用素材,可同时参与IAA和IAP投放。(该标签能力仅对短漫剧行业白名单客户生效,您可通过[【查询白名单能力】](https://open.oceanengine.com/labels/7/docs/1763407285579840)接口传入gray_key = `R3_material`查询您的账户是否具备该能力。未开通权限的账户传入标签将返回错误) |

请求示例

python

# coding=utf-8
import json
import requests

from six import string_types
from six.moves.urllib.parse import urlencode, urlunparse  # noqa

ACCESS_TOKEN = "xxx"
PATH = "/open_api/2/file/video/update/"


def build_url(path, query=""):
    # type: (str, str) -> str
    """
    Build request URL
    :param path: Request path
    :param query: Querystring
    :return: Request URL
    """
    scheme, netloc = "https", "api.oceanengine.com"
    return urlunparse((scheme, netloc, path, "", query, ""))

def post(json_str):
    # type: (str) -> dict
    """
    Send POST request
    :param json_str: Args in JSON format
    :return: Response in JSON format
    """
    url = build_url(PATH)
    args = json.loads(json_str)
    headers = {
        "Access-Token": ACCESS_TOKEN,
        "Content-Type": "application/json",
    }
    rsp = requests.post(url, headers=headers, json=args)
    return rsp.json()


if __name__ == '__main__':
    advertiser_id = ADVERTISER_ID
    video_id = VIDEO_ID
    filename = FILENAME
    labels_list = LABELS
    labels = json.dumps(labels_list)

    # Args in JSON format
    my_args = "{\"advertiser_id\": \"%s\", \"videos\": [{\"video_id\": \"%s\", \"filename\": \"%s\", \"labels\": %s}]}" % (advertiser_id, video_id, filename, labels)
    print(post(my_args))

java

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import okhttp3.*;
import org.apache.http.client.utils.URIBuilder;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

public class Demo {
    private static final String ACCESS_TOKEN = "xxx";
    private static final String PATH = "/open_api/2/file/video/update/";
    private static final ObjectMapper mapper = new ObjectMapper();

    /**
     * Build request URL
     *
     * @param path Request path
     * @return Request URL
     */
    private static String buildUrl(String path) throws URISyntaxException {
        URI uri = new URI("https", "api.oceanengine.com", path, "", "");
        return uri.toString();
    }


    /**
     * Send POST request
     *
     * @param jsonStr Args in JSON format
     * @return Response in JSON format
     */
    private static String post(String jsonStr) throws IOException, URISyntaxException {
        OkHttpClient client = new OkHttpClient().newBuilder().build();
        String url = buildUrl(PATH);

        RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonStr);
        Request request = new Request.Builder()
                .url(url)
                .method("POST", body)
                .addHeader("Content-Type", "application/json")
                .addHeader("Access-Token", ACCESS_TOKEN)
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }


    public static void main(String[] args) throws IOException, URISyntaxException {
        Long advertiser_id = ADVERTISER_ID;
        String video_id = VIDEO_ID;
        String filename = FILENAME;
        List < String > labels_list = LABELS;
        String labels = mapper.writeValueAsString(labels_list);

        // Args in JSON format
        String myArgs = String.format("{\"advertiser_id\": \"%s\", \"videos\": [{\"video_id\": \"%s\", \"filename\": \"%s\", \"labels\": %s}]}",advertiser_id, video_id, filename, labels);
        System.out.println(post(myArgs));
    }
}

php


$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/2/file/video/update/";

/**
 * Build request URL
 * @param $path : Request path
 * @return string
 */
function build_url($path)
{
    return "https://api.oceanengine.com" . $path;
}


/**
 * Send POST request
 * @param $json_str : Args in JSON format
 * @return bool|string : Response in JSON format
 */
function post($json_str)
{
    global $ACCESS_TOKEN, $PATH;
    $curl = curl_init();

    $url = build_url($PATH);

    curl_setopt_array($curl, array(
        CURLOPT_URL => $url,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => $json_str,
        CURLOPT_HTTPHEADER => array(
            "Content-Type: application/json",
            "Access-Token: " . $ACCESS_TOKEN,
        ),
    ));

    $response = curl_exec($curl);
    curl_close($curl);
    return $response;
}


$advertiser_id = ADVERTISER_ID;
$video_id = VIDEO_ID;
$filename = FILENAME;
$labels_list = LABELS;
$labels = json_encode($labels_list);

/* Args in JSON format */
$my_args = sprintf("{\"advertiser_id\": \"%s\", \"videos\": [{\"video_id\": \"%s\", \"filename\": \"%s\", \"labels\": %s}]}", $advertiser_id, $video_id, $filename, $labels);
echo post($my_args);

curl

curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
    "advertiser_id": "ADVERTISER_ID",
    "videos": [
        {
            "video_id": "VIDEO_ID",
            "filename": "FILENAME",
            "labels": [
                "LABELS"
            ]
        }
    ]
}' \
https://api.oceanengine.com/open_api/2/file/video/update/

应答字段

字段 类型 必填 描述
code number 否 返回码,详见 【附录-返回码】
message string 否 返回信息,详见 【附录-返回码】
data(json,否) — json返回值
videos(object[],否) — 视频列表 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `video_id` | string | 否 | 视频id | | `labels` | string[] | 否 | 标签 | | `status_code` | number | 否 | 更新状态- `SUCCESS` 成功
- `FAILURE` 失败(原因:操作视频非当前客户所有或操作的视频不存在) |
字段 类型 必填 描述
request_id string 否 请求日志id

应答示例

HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {}
}

业务错误码

仅披露当前接口高频的参数校验报错,更多常见报错详见「返回码」文档

在接这个接口时卡住了?
Stuck wiring this API into production? We build ad-delivery tooling on these platforms — campaign automation, reporting pipelines, error-handling and migration between API versions.
联系我们 · Talk to us 每日平台更新简报 →