| 关键信息 | 详情 |
|---|---|
| 文档 ID | 1854929666566346 |
| 标签 ID | 7 |
| 原始文档 | [https://open.oceanengine.com/labels/7/docs/1854929666566346](https://open.oceanengine.com/labels/7/docs/1854929666566346) |
| 接口标识 | oc_project.material.create |
用于批量添加投放项目下的素材,包括视频、图片、图文、试玩、直玩等素材。支持多种素材类型和相关配置,如视频素材主页可见性设置等。配合接口有【获取视频素材】【获取图片素材】等。
批量添加投放项目下素材
https://api.oceanengine.com/open_api/v3.0/oc_project/material/create/可视化调试SDK下载
POST
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
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_material_list(object[],否) — 图片素材信息,,单次追投最多可添加200个素材carousel_material_list(object[],否) — 图文素材信息trial_play_material_list(object[],否) — 试玩素材信息title_material_list(object[],否) — 标题信息instant_play_material_list(object[],否) — 直玩素材信息# 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))
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));
}
}
$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 -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": {}
}
仅披露当前接口高频的参数校验报错,更多常见报错详见「返回码」文档