← 返回 API 列表 ← 项目门户

批量添加投放项目下素材

关键信息详情
文档 ID1854929666566346
标签 ID7
原始文档[https://open.oceanengine.com/labels/7/docs/1854929666566346](https://open.oceanengine.com/labels/7/docs/1854929666566346)
接口标识oc_project.material.create
💡用于批量添加投放项目下的素材,包括视频、图片、图文、试玩、直玩等素材。支持多种素材类型和相关配置,如视频素材主页可见性设置等。配合接口有【获取视频素材】【获取图片素材】等。 批量添加投放项目下素材
POST https://api.oceanengine.com/open_api/v3.0/oc_project/material/create/ 🔍 可视化调试 📦 SDK下载

接口说明

用于批量添加投放项目下的素材,包括视频、图片、图文、试玩、直玩等素材。支持多种素材类型和相关配置,如视频素材主页可见性设置等。配合接口有【获取视频素材】【获取图片素材】等。

批量添加投放项目下素材

请求地址

https://api.oceanengine.com/open_api/v3.0/oc_project/material/create/可视化调试SDK下载

请求方法

POST

Header

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

请求参数

字段 类型 必填 描述
advertiser_id number 必填 客户id
project_id number 必填 项目id
video_material_list(object[],否) — 视频素材信息,单次追投最多可添加200个素材(总素材量,包含视频、图片、图文) | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `image_mode` | string | 否 | 视频素材类型,允许值:- `CREATIVE_IMAGE_MODE_VIDEO_VERTICAL` 竖版视频
- `CREATIVE_IMAGE_MODE_VIDE`横版视频 | | `video_id` | string | 否 | 视频ID,可通过[【获取视频素材】](https://open.oceanengine.com/doc/index.html?key=ad&type=api&id=1696710601820172)或【获取账户可用的组织视频列表】接口获得 | | `video_cover_id` | string | 否 | 视频封面图片ID,可通过[【获取图片素材】](https://open.oceanengine.com/labels/7/docs/1696710601254912)接口获得 | | `item_id` | number | 否 | 注:当aweme_id传入时有效
抖音短视频ID,通过[【获取抖音主页视频】](https://open.oceanengine.com/labels/7/docs/1729982871844879)或 [【获取抖音授权关系】](https://open.oceanengine.com/labels/7/docs/1729983667746823)获取主页视频或合作授权视频 | | `video_hp_visibility` | string | 否 | 视频素材主页可见性设置,该参数只针对非抖音视频生效,可选值:- ALWAYS_VISIBLE 主页始终可见
- HIDE_VIDEO_ON_HP 仅单次展示可见(默认值) | | `guide_video_id` | string | 否 | 引导视频id |
image_material_list(object[],否) — 图片素材信息,,单次追投最多可添加200个素材 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `image_mode` | string | 否 | 可选值:
- `AWEME_PHOTO` 图文素材
- `CREATIVE_IMAGE_MODE_AWEME_LIVE` 直播创意素材
- `CREATIVE_IMAGE_MODE_CALIBRATION_FREE_SINGLE_IMAGE` 穿山甲免校验
- `CREATIVE_IMAGE_MODE_CALIBRATION_FREE_VIDEO` 穿山甲免校验
- `CREATIVE_IMAGE_MODE_DISPLAY_WINDOW` 头条搜索投放通用橱窗样式
- `CREATIVE_IMAGE_MODE_GIF`
- `CREATIVE_IMAGE_MODE_GROUP`
- `CREATIVE_IMAGE_MODE_INSTANT_PLAY` 直玩
- `CREATIVE_IMAGE_MODE_LARGE`
- `CREATIVE_IMAGE_MODE_LARGE_VERTICAL` 大图竖版图
- `CREATIVE_IMAGE_MODE_PLAYABLE_HORIZONTAL` 试玩
- `CREATIVE_IMAGE_MODE_PLAYABLE_VERTICAL` 试玩
- `CREATIVE_IMAGE_MODE_SMALL`
- `CREATIVE_IMAGE_MODE_TRIAL_PLAY_LARGE` 试玩横屏
- `CREATIVE_IMAGE_MODE_TRIAL_PLAY_VERTICAL` 试玩竖屏
- `CREATIVE_IMAGE_MODE_UNION_SPLASH` 网盟开屏
- `CREATIVE_IMAGE_MODE_UNION_SPLASH_VIDEO` 互动创意
- `CREATIVE_IMAGE_MODE_VIDEO` 视频
- `CREATIVE_IMAGE_MODE_VIDEO_VERTICAL` 抖音&火山竖版视频素材
- `SEARCH_AD_SMALL_IMAGE` 搜索小图
- `TOUTIAO_SEARCH_AD_IMAGE` 搜索大图 | | `images` | string | 否 | 图片ID | | `image_id` | string | 否 | 图片ID,可通过[【获取图片素材】](https://open.oceanengine.com/labels/7/docs/1696710601254912)接口获得 |
carousel_material_list(object[],否) — 图文素材信息 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `carousel_id` | string | 否 | 图文id,可通过【[获取图文素材](https://open.oceanengine.com/labels/34/docs/1773554026740736)】接口获得 | | `item_id` | string | 否 | 抖音图文id,需从【[获取创编可用的抖音图文素材](https://open.oceanengine.com/labels/34/docs/1812353010729227)】接口获取item_id传入
注意:投放抖音图文素材时,只需要传入item_id,不要传入carousel_id(2个同时传入只会使用item_id) | | `video_hp_visibility` | string | 否 | 抖音主页图文可见性,可选值:
- `ALWAYS_VISIBLE` 主页始终可见
- `HIDE_VIDEO_ON_HP` 主页隐藏 |
trial_play_material_list(object[],否) — 试玩素材信息 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `app_play_uri` | string | 否 | 试玩/直玩素材uri,可通过【[获取试玩/直玩素材列表](https://open.oceanengine.com/labels/7/docs/1836615534374475)】获取可用于创编的素材 | | `guide_video_id` | string | 否 | 通过【[上传视频](https://open.oceanengine.com/labels/34/docs/1696710600730639)】接口上传引导视频,获取引导视频的video_id
引导视频ID,引导视频时长≥5s,文件≤100M |
title_material_list(object[],否) — 标题信息 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `title` | string | 否 | 标题 |
instant_play_material_list(object[],否) — 直玩素材信息 | 字段 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | `app_play_uri` | string | 否 | 试玩/直玩素材uri,可通过【[获取试玩/直玩素材列表](https://open.oceanengine.com/labels/7/docs/1836615534374475)】获取可用于创编的素材 |

请求示例

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/v3.0/uni_project/material/create/"


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
    project_id = PROJECT_ID
    image_mode = IMAGE_MODE
    video_id = VIDEO_ID
    video_cover_id = VIDEO_COVER_ID
    item_id = ITEM_ID
    video_hp_visibility = VIDEO_HP_VISIBILITY

    # Args in JSON format
    my_args = "{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"video_material_list\": [{\"image_mode\": \"%s\", \"video_id\": \"%s\", \"video_cover_id\": \"%s\", \"item_id\": \"%s\", \"video_hp_visibility\": \"%s\"}]}" % (advertiser_id, project_id, image_mode, video_id, video_cover_id, item_id, video_hp_visibility)
    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/v3.0/uni_project/material/create/";
    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;
        Long project_id = PROJECT_ID;
        String image_mode = IMAGE_MODE;
        String video_id = VIDEO_ID;
        String video_cover_id = VIDEO_COVER_ID;
        Long item_id = ITEM_ID;
        String video_hp_visibility = VIDEO_HP_VISIBILITY;

        // Args in JSON format
        String myArgs = String.format("{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"video_material_list\": [{\"image_mode\": \"%s\", \"video_id\": \"%s\", \"video_cover_id\": \"%s\", \"item_id\": \"%s\", \"video_hp_visibility\": \"%s\"}]}",advertiser_id, project_id, image_mode, video_id, video_cover_id, item_id, video_hp_visibility);
        System.out.println(post(myArgs));
    }
}

php


$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v3.0/uni_project/material/create/";

/**
 * 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;
$project_id = PROJECT_ID;
$image_mode = IMAGE_MODE;
$video_id = VIDEO_ID;
$video_cover_id = VIDEO_COVER_ID;
$item_id = ITEM_ID;
$video_hp_visibility = VIDEO_HP_VISIBILITY;

/* Args in JSON format */
$my_args = sprintf("{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"video_material_list\": [{\"image_mode\": \"%s\", \"video_id\": \"%s\", \"video_cover_id\": \"%s\", \"item_id\": \"%s\", \"video_hp_visibility\": \"%s\"}]}", $advertiser_id, $project_id, $image_mode, $video_id, $video_cover_id, $item_id, $video_hp_visibility);
echo post($my_args);

curl

curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
    "advertiser_id": "ADVERTISER_ID",
    "project_id": "PROJECT_ID",
    "video_material_list": [
        {
            "image_mode": "IMAGE_MODE",
            "video_id": "VIDEO_ID",
            "video_cover_id": "VIDEO_COVER_ID",
            "item_id": "ITEM_ID",
            "video_hp_visibility": "VIDEO_HP_VISIBILITY"
        }
    ]
}' \
https://api.oceanengine.com/open_api/v3.0/uni_project/material/create/

应答字段

字段 类型 必填 描述
code number 否 返回码,详见 【附录-返回码】
message string 否 返回信息,详见 【附录-返回码】
data json 否 json返回值
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 每日平台更新简报 →