← 返回 API 列表 ← 项目门户

上传视频

关键信息详情
文档 ID1696710600730639
标签 ID7
原始文档[https://open.oceanengine.com/labels/7/docs/1696710600730639](https://open.oceanengine.com/labels/7/docs/1696710600730639)
接口标识``
💡可通过本接口创建视频素材，需要提供客户ID、视频详细信息等参数。 > 通过此接口，用户可以上传和营销投放相关的素材视频
建议：对于连山url链接上传视频，请及时切换至[异步上传接口](https://open.oceanengine.com/labels/7/docs/1801533703648324)
POST [https://api.oceanengine.com/open_api/2/file/video/ad/](https://api.oceanengine.com/open_api/2/file/video/ad/) 🔍 可视化调试 📦 SDK下载

接口说明

可通过本接口创建视频素材，需要提供客户ID、视频详细信息等参数。

通过此接口，用户可以上传和营销投放相关的素材视频
建议：对于连山url链接上传视频，请及时切换至异步上传接口

请求地址

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

请求方法

POST

Header

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

请求参数

字段 类型 必填 描述
advertiser_id number 必填 客户ID
upload_type string 否 视频/音频上传方式，允许值：- UPLOAD_BY_FILE 文件上传
- UPLOAD_BY_URL 网址上传
默认值: UPLOAD_BY_FILE
video_signature string 否 视频的md5值(用于服务端校验)- upload_type =UPLOAD_BY_FILE有效且必填
video_file file 条件必填 视频文件，允许格式：mp4、mpeg、3gp、avi、m4v，文件大小≤500M- upload_type为UPLOAD_BY_FILE有效且必填
filename string 条件必填 upload_type = UPLOAD_BY_URL有效且必填
素材的文件名，可自定义素材名，不传择默认取文件名，最长255个字符
注：若同一素材已进行上传，重新上传不会改名。
labels string[] 否 标签，多个标签以数组形式传入。- 请优先为无需付费信息的素材传入仅IAA标签，标记该素材仅IAA模式投放，不参与IAP模式投放；未传入该标签，素材默认为通用素材，可同时参与IAA和IAP投放。（该标签能力仅对短漫剧行业白名单客户生效，您可通过【查询白名单能力】接口传入gray_key =R3_material查询您的账户是否具备该能力。未开通权限的账户传入标签将返回错误）
video_url string 否 视频 url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填- 仅支持开发者购置连山云素材服务上传生成的tos链接上传，不支持其他三方链接地址，具体见接入指南
- 建议：对于连山url链接上传视频，请及时切换至异步上传接口
is_aigc bool 否 视频素材是否为AIGC生成
is_guide_video bool 否 上传视频场景是否是引导视频（此功能仅游戏行业白名单客户可用，如需使用请联系运营）

请求示例

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/ad/"


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
    upload_type = UPLOAD_TYPE
    video_signature = VIDEO_SIGNATURE
    video_file = VIDEO_FILE
    filename = FILENAME
    labels_list = LABELS
    labels = json.dumps(labels_list)
    video_url = VIDEO_URL
    is_aigc = IS_AIGC
    is_guide_video = IS_GUIDE_VIDEO

    # Args in JSON format
    my_args = "{\"advertiser_id\": \"%s\", \"upload_type\": \"%s\", \"video_signature\": \"%s\", \"video_file\": \"%s\", \"filename\": \"%s\", \"labels\": %s, \"video_url\": \"%s\", \"is_aigc\": \"%s\", \"is_guide_video\": \"%s\"}" % (advertiser_id, upload_type, video_signature, video_file, filename, labels, video_url, is_aigc, is_guide_video)
    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/ad/";
    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 upload_type = UPLOAD_TYPE;
        String video_signature = VIDEO_SIGNATURE;
        String video_file = VIDEO_FILE;
        String filename = FILENAME;
        List < String > labels_list = LABELS;
        String labels = mapper.writeValueAsString(labels_list);
        String video_url = VIDEO_URL;
        String is_aigc = IS_AIGC;
        String is_guide_video = IS_GUIDE_VIDEO;

        // Args in JSON format
        String myArgs = String.format("{\"advertiser_id\": \"%s\", \"upload_type\": \"%s\", \"video_signature\": \"%s\", \"video_file\": \"%s\", \"filename\": \"%s\", \"labels\": %s, \"video_url\": \"%s\", \"is_aigc\": \"%s\", \"is_guide_video\": \"%s\"}",advertiser_id, upload_type, video_signature, video_file, filename, labels, video_url, is_aigc, is_guide_video);
        System.out.println(post(myArgs));
    }
}

php


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

/**
 * 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;
$upload_type = UPLOAD_TYPE;
$video_signature = VIDEO_SIGNATURE;
$video_file = VIDEO_FILE;
$filename = FILENAME;
$labels_list = LABELS;
$labels = json_encode($labels_list);
$video_url = VIDEO_URL;
$is_aigc = IS_AIGC;
$is_guide_video = IS_GUIDE_VIDEO;

/* Args in JSON format */
$my_args = sprintf("{\"advertiser_id\": \"%s\", \"upload_type\": \"%s\", \"video_signature\": \"%s\", \"video_file\": \"%s\", \"filename\": \"%s\", \"labels\": %s, \"video_url\": \"%s\", \"is_aigc\": \"%s\", \"is_guide_video\": \"%s\"}", $advertiser_id, $upload_type, $video_signature, $video_file, $filename, $labels, $video_url, $is_aigc, $is_guide_video);
echo post($my_args);

curl

curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
    "advertiser_id": "ADVERTISER_ID",
    "upload_type": "UPLOAD_TYPE",
    "video_signature": "VIDEO_SIGNATURE",
    "video_file": "VIDEO_FILE",
    "filename": "FILENAME",
    "labels": [
        "LABELS"
    ],
    "video_url": "VIDEO_URL",
    "is_aigc": "IS_AIGC",
    "is_guide_video": "IS_GUIDE_VIDEO"
}' \
https://api.oceanengine.com/open_api/2/file/video/ad/

应答字段

字段 类型 必填 描述
code number 否 返回码,详见 【附录-返回码】
message string 否 返回信息,详见 【附录-返回码】
data（json，否） — json返回值 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `video_id` | string | 否 | 视频ID | | `size` | number | 否 | 视频大小 | | `width` | number | 否 | 视频宽度 | | `height` | number | 否 | 视频高度 | | `video_url` | string | 否 | 视频地址 | | `duration` | double | 否 | 视频时长 | | `material_id` | number | 否 | 素材id，即多合一报表中的素材id，一个素材唯一对应一个素材id | | `video_signature` | string | 否 | 视频的md5值 |
字段 类型 必填 描述
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 每日平台更新简报 →