编辑全域投放项目

请求地址

https://api.oceanengine.com/open_api/v3.0/uni_project/update/可视化调试SDK下载

请求方法

POST

Header

请求参数

请求示例

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/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
    project_id = PROJECT_ID
    name = NAME
    budget = BUDGET
    uni_roi_goal = UNI_ROI_GOAL
    monetization_mode = MONETIZATION_MODE
    schedule_type = SCHEDULE_TYPE
    start_time = START_TIME
    end_time = END_TIME
    schedule_time = SCHEDULE_TIME
    aigc_dynamic_creative_switch = AIGC_DYNAMIC_CREATIVE_SWITCH
    yuntu_category_id = YUNTU_CATEGORY_ID
    cdp_brand_id = CDP_BRAND_ID
    ecom_brand_id = ECOM_BRAND_ID
    brand_name_id = BRAND_NAME_ID
    cdp_brand_name = CDP_BRAND_NAME
    sub_brand_names_list = SUB_BRAND_NAMES
    sub_brand_names = json.dumps(sub_brand_names_list)
    sub_brand_name_ids_list = SUB_BRAND_NAME_IDS
    sub_brand_name_ids = json.dumps(sub_brand_name_ids_list)
    district = DISTRICT
    name = NAME
    long = LONG
    lat = LAT
    radius = RADIUS
    region_version = REGION_VERSION
    city_list = CITY
    city = json.dumps(city_list)
    location_type = LOCATION_TYPE
    gender = GENDER
    age_list = AGE
    age = json.dumps(age_list)
    platform_list = PLATFORM
    platform = json.dumps(platform_list)
    hide_if_converted = HIDE_IF_CONVERTED
    converted_time_duration = CONVERTED_TIME_DURATION
    retargeting_tags_include_list = RETARGETING_TAGS_INCLUDE
    retargeting_tags_include = json.dumps(retargeting_tags_include_list)
    retargeting_tags_exclude_list = RETARGETING_TAGS_EXCLUDE
    retargeting_tags_exclude = json.dumps(retargeting_tags_exclude_list)
    playlet_series_url_type = PLAYLET_SERIES_URL_TYPE
    playlet_series_url = PLAYLET_SERIES_URL
    titles_list = TITLES
    titles = json.dumps(titles_list)
    image_ids_list = IMAGE_IDS
    image_ids = json.dumps(image_ids_list)
    selling_points_list = SELLING_POINTS
    selling_points = json.dumps(selling_points_list)
    call_to_action_buttons_list = CALL_TO_ACTION_BUTTONS
    call_to_action_buttons = json.dumps(call_to_action_buttons_list)
    title = TITLE

    # Args in JSON format
    my_args = "{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"name\": \"%s\", \"budget\": \"%s\", \"uni_roi_goal\": \"%s\", \"monetization_mode\": \"%s\", \"schedule_type\": \"%s\", \"start_time\": \"%s\", \"end_time\": \"%s\", \"schedule_time\": \"%s\", \"aigc_dynamic_creative_switch\": \"%s\", \"brand_info\": {\"yuntu_category_id\": \"%s\", \"cdp_brand_id\": \"%s\", \"ecom_brand_id\": \"%s\", \"brand_name_id\": \"%s\", \"cdp_brand_name\": \"%s\", \"sub_brand_names\": %s, \"sub_brand_name_ids\": %s}, \"audience\": {\"district\": \"%s\", \"geolocation\": [{\"name\": \"%s\", \"long\": \"%s\", \"lat\": \"%s\", \"radius\": \"%s\"}], \"region_version\": \"%s\", \"city\": %s, \"location_type\": \"%s\", \"gender\": \"%s\", \"age\": %s, \"platform\": %s, \"hide_if_converted\": \"%s\", \"converted_time_duration\": \"%s\", \"retargeting_tags_include\": %s, \"retargeting_tags_exclude\": %s}, \"playlet_series_url_info\": [{\"playlet_series_url_type\": \"%s\", \"playlet_series_url\": \"%s\"}], \"product_info\": {\"titles\": %s, \"image_ids\": %s, \"selling_points\": %s}, \"call_to_action_buttons\": %s, \"title_material_list\": [{\"title\": \"%s\"}]}" % (advertiser_id, project_id, name, budget, uni_roi_goal, monetization_mode, schedule_type, start_time, end_time, schedule_time, aigc_dynamic_creative_switch, yuntu_category_id, cdp_brand_id, ecom_brand_id, brand_name_id, cdp_brand_name, sub_brand_names, sub_brand_name_ids, district, name, long, lat, radius, region_version, city, location_type, gender, age, platform, hide_if_converted, converted_time_duration, retargeting_tags_include, retargeting_tags_exclude, playlet_series_url_type, playlet_series_url, titles, image_ids, selling_points, call_to_action_buttons, title)
    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/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;
        Long project_id = PROJECT_ID;
        String name = NAME;
        Double budget = BUDGET;
        Double uni_roi_goal = UNI_ROI_GOAL;
        String monetization_mode = MONETIZATION_MODE;
        String schedule_type = SCHEDULE_TYPE;
        String start_time = START_TIME;
        String end_time = END_TIME;
        String schedule_time = SCHEDULE_TIME;
        String aigc_dynamic_creative_switch = AIGC_DYNAMIC_CREATIVE_SWITCH;
        Long yuntu_category_id = YUNTU_CATEGORY_ID;
        Long cdp_brand_id = CDP_BRAND_ID;
        Long ecom_brand_id = ECOM_BRAND_ID;
        Long brand_name_id = BRAND_NAME_ID;
        String cdp_brand_name = CDP_BRAND_NAME;
        List < String > sub_brand_names_list = SUB_BRAND_NAMES;
        String sub_brand_names = mapper.writeValueAsString(sub_brand_names_list);
        List < String > sub_brand_name_ids_list = SUB_BRAND_NAME_IDS;
        String sub_brand_name_ids = mapper.writeValueAsString(sub_brand_name_ids_list);
        String district = DISTRICT;
        String name = NAME;
        Double long = LONG;
        Double lat = LAT;
        Long radius = RADIUS;
        String region_version = REGION_VERSION;
        List < Long > city_list = CITY;
        String city = mapper.writeValueAsString(city_list);
        String location_type = LOCATION_TYPE;
        String gender = GENDER;
        List < String > age_list = AGE;
        String age = mapper.writeValueAsString(age_list);
        List < String > platform_list = PLATFORM;
        String platform = mapper.writeValueAsString(platform_list);
        String hide_if_converted = HIDE_IF_CONVERTED;
        String converted_time_duration = CONVERTED_TIME_DURATION;
        List < Long > retargeting_tags_include_list = RETARGETING_TAGS_INCLUDE;
        String retargeting_tags_include = mapper.writeValueAsString(retargeting_tags_include_list);
        List < Long > retargeting_tags_exclude_list = RETARGETING_TAGS_EXCLUDE;
        String retargeting_tags_exclude = mapper.writeValueAsString(retargeting_tags_exclude_list);
        String playlet_series_url_type = PLAYLET_SERIES_URL_TYPE;
        String playlet_series_url = PLAYLET_SERIES_URL;
        List < String > titles_list = TITLES;
        String titles = mapper.writeValueAsString(titles_list);
        List < String > image_ids_list = IMAGE_IDS;
        String image_ids = mapper.writeValueAsString(image_ids_list);
        List < String > selling_points_list = SELLING_POINTS;
        String selling_points = mapper.writeValueAsString(selling_points_list);
        List < String > call_to_action_buttons_list = CALL_TO_ACTION_BUTTONS;
        String call_to_action_buttons = mapper.writeValueAsString(call_to_action_buttons_list);
        String title = TITLE;

        // Args in JSON format
        String myArgs = String.format("{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"name\": \"%s\", \"budget\": \"%s\", \"uni_roi_goal\": \"%s\", \"monetization_mode\": \"%s\", \"schedule_type\": \"%s\", \"start_time\": \"%s\", \"end_time\": \"%s\", \"schedule_time\": \"%s\", \"aigc_dynamic_creative_switch\": \"%s\", \"brand_info\": {\"yuntu_category_id\": \"%s\", \"cdp_brand_id\": \"%s\", \"ecom_brand_id\": \"%s\", \"brand_name_id\": \"%s\", \"cdp_brand_name\": \"%s\", \"sub_brand_names\": %s, \"sub_brand_name_ids\": %s}, \"audience\": {\"district\": \"%s\", \"geolocation\": [{\"name\": \"%s\", \"long\": \"%s\", \"lat\": \"%s\", \"radius\": \"%s\"}], \"region_version\": \"%s\", \"city\": %s, \"location_type\": \"%s\", \"gender\": \"%s\", \"age\": %s, \"platform\": %s, \"hide_if_converted\": \"%s\", \"converted_time_duration\": \"%s\", \"retargeting_tags_include\": %s, \"retargeting_tags_exclude\": %s}, \"playlet_series_url_info\": [{\"playlet_series_url_type\": \"%s\", \"playlet_series_url\": \"%s\"}], \"product_info\": {\"titles\": %s, \"image_ids\": %s, \"selling_points\": %s}, \"call_to_action_buttons\": %s, \"title_material_list\": [{\"title\": \"%s\"}]}",advertiser_id, project_id, name, budget, uni_roi_goal, monetization_mode, schedule_type, start_time, end_time, schedule_time, aigc_dynamic_creative_switch, yuntu_category_id, cdp_brand_id, ecom_brand_id, brand_name_id, cdp_brand_name, sub_brand_names, sub_brand_name_ids, district, name, long, lat, radius, region_version, city, location_type, gender, age, platform, hide_if_converted, converted_time_duration, retargeting_tags_include, retargeting_tags_exclude, playlet_series_url_type, playlet_series_url, titles, image_ids, selling_points, call_to_action_buttons, title);
        System.out.println(post(myArgs));
    }
}

php

$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v3.0/uni_project/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;
$project_id = PROJECT_ID;
$name = NAME;
$budget = BUDGET;
$uni_roi_goal = UNI_ROI_GOAL;
$monetization_mode = MONETIZATION_MODE;
$schedule_type = SCHEDULE_TYPE;
$start_time = START_TIME;
$end_time = END_TIME;
$schedule_time = SCHEDULE_TIME;
$aigc_dynamic_creative_switch = AIGC_DYNAMIC_CREATIVE_SWITCH;
$yuntu_category_id = YUNTU_CATEGORY_ID;
$cdp_brand_id = CDP_BRAND_ID;
$ecom_brand_id = ECOM_BRAND_ID;
$brand_name_id = BRAND_NAME_ID;
$cdp_brand_name = CDP_BRAND_NAME;
$sub_brand_names_list = SUB_BRAND_NAMES;
$sub_brand_names = json_encode($sub_brand_names_list);
$sub_brand_name_ids_list = SUB_BRAND_NAME_IDS;
$sub_brand_name_ids = json_encode($sub_brand_name_ids_list);
$district = DISTRICT;
$name = NAME;
$long = LONG;
$lat = LAT;
$radius = RADIUS;
$region_version = REGION_VERSION;
$city_list = CITY;
$city = json_encode($city_list);
$location_type = LOCATION_TYPE;
$gender = GENDER;
$age_list = AGE;
$age = json_encode($age_list);
$platform_list = PLATFORM;
$platform = json_encode($platform_list);
$hide_if_converted = HIDE_IF_CONVERTED;
$converted_time_duration = CONVERTED_TIME_DURATION;
$retargeting_tags_include_list = RETARGETING_TAGS_INCLUDE;
$retargeting_tags_include = json_encode($retargeting_tags_include_list);
$retargeting_tags_exclude_list = RETARGETING_TAGS_EXCLUDE;
$retargeting_tags_exclude = json_encode($retargeting_tags_exclude_list);
$playlet_series_url_type = PLAYLET_SERIES_URL_TYPE;
$playlet_series_url = PLAYLET_SERIES_URL;
$titles_list = TITLES;
$titles = json_encode($titles_list);
$image_ids_list = IMAGE_IDS;
$image_ids = json_encode($image_ids_list);
$selling_points_list = SELLING_POINTS;
$selling_points = json_encode($selling_points_list);
$call_to_action_buttons_list = CALL_TO_ACTION_BUTTONS;
$call_to_action_buttons = json_encode($call_to_action_buttons_list);
$title = TITLE;

/* Args in JSON format */
$my_args = sprintf("{\"advertiser_id\": \"%s\", \"project_id\": \"%s\", \"name\": \"%s\", \"budget\": \"%s\", \"uni_roi_goal\": \"%s\", \"monetization_mode\": \"%s\", \"schedule_type\": \"%s\", \"start_time\": \"%s\", \"end_time\": \"%s\", \"schedule_time\": \"%s\", \"aigc_dynamic_creative_switch\": \"%s\", \"brand_info\": {\"yuntu_category_id\": \"%s\", \"cdp_brand_id\": \"%s\", \"ecom_brand_id\": \"%s\", \"brand_name_id\": \"%s\", \"cdp_brand_name\": \"%s\", \"sub_brand_names\": %s, \"sub_brand_name_ids\": %s}, \"audience\": {\"district\": \"%s\", \"geolocation\": [{\"name\": \"%s\", \"long\": \"%s\", \"lat\": \"%s\", \"radius\": \"%s\"}], \"region_version\": \"%s\", \"city\": %s, \"location_type\": \"%s\", \"gender\": \"%s\", \"age\": %s, \"platform\": %s, \"hide_if_converted\": \"%s\", \"converted_time_duration\": \"%s\", \"retargeting_tags_include\": %s, \"retargeting_tags_exclude\": %s}, \"playlet_series_url_info\": [{\"playlet_series_url_type\": \"%s\", \"playlet_series_url\": \"%s\"}], \"product_info\": {\"titles\": %s, \"image_ids\": %s, \"selling_points\": %s}, \"call_to_action_buttons\": %s, \"title_material_list\": [{\"title\": \"%s\"}]}", $advertiser_id, $project_id, $name, $budget, $uni_roi_goal, $monetization_mode, $schedule_type, $start_time, $end_time, $schedule_time, $aigc_dynamic_creative_switch, $yuntu_category_id, $cdp_brand_id, $ecom_brand_id, $brand_name_id, $cdp_brand_name, $sub_brand_names, $sub_brand_name_ids, $district, $name, $long, $lat, $radius, $region_version, $city, $location_type, $gender, $age, $platform, $hide_if_converted, $converted_time_duration, $retargeting_tags_include, $retargeting_tags_exclude, $playlet_series_url_type, $playlet_series_url, $titles, $image_ids, $selling_points, $call_to_action_buttons, $title);
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",
    "name": "NAME",
    "budget": "BUDGET",
    "uni_roi_goal": "UNI_ROI_GOAL",
    "monetization_mode": "MONETIZATION_MODE",
    "schedule_type": "SCHEDULE_TYPE",
    "start_time": "START_TIME",
    "end_time": "END_TIME",
    "schedule_time": "SCHEDULE_TIME",
    "aigc_dynamic_creative_switch": "AIGC_DYNAMIC_CREATIVE_SWITCH",
    "brand_info": {
        "yuntu_category_id": "YUNTU_CATEGORY_ID",
        "cdp_brand_id": "CDP_BRAND_ID",
        "ecom_brand_id": "ECOM_BRAND_ID",
        "brand_name_id": "BRAND_NAME_ID",
        "cdp_brand_name": "CDP_BRAND_NAME",
        "sub_brand_names": [
            "SUB_BRAND_NAMES"
        ],
        "sub_brand_name_ids": [
            "SUB_BRAND_NAME_IDS"
        ]
    },
    "audience": {
        "district": "DISTRICT",
        "geolocation": [
            {
                "name": "NAME",
                "long": "LONG",
                "lat": "LAT",
                "radius": "RADIUS"
            }
        ],
        "region_version": "REGION_VERSION",
        "city": [
            "CITY"
        ],
        "location_type": "LOCATION_TYPE",
        "gender": "GENDER",
        "age": [
            "AGE"
        ],
        "platform": [
            "PLATFORM"
        ],
        "hide_if_converted": "HIDE_IF_CONVERTED",
        "converted_time_duration": "CONVERTED_TIME_DURATION",
        "retargeting_tags_include": [
            "RETARGETING_TAGS_INCLUDE"
        ],
        "retargeting_tags_exclude": [
            "RETARGETING_TAGS_EXCLUDE"
        ]
    },
    "playlet_series_url_info": [
        {
            "playlet_series_url_type": "PLAYLET_SERIES_URL_TYPE",
            "playlet_series_url": "PLAYLET_SERIES_URL"
        }
    ],
    "product_info": {
        "titles": [
            "TITLES"
        ],
        "image_ids": [
            "IMAGE_IDS"
        ],
        "selling_points": [
            "SELLING_POINTS"
        ]
    },
    "call_to_action_buttons": [
        "CALL_TO_ACTION_BUTTONS"
    ],
    "title_material_list": [
        {
            "title": "TITLE"
        }
    ]
}' \
https://api.oceanengine.com/open_api/v3.0/uni_project/update/

应答字段

应答示例

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

业务错误码

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

品牌信息，仅关联云图的客户可以按需填写，以下参数可通过【获取关联云图的投放账户信息】获取电商品牌id