Ocean Engine Open Platform

https://open.oceanengine.com
Admin
Ocean Engine Open Platform provides APIs, documentation, and developer tools for integrating with...
Tokens:53,734
Snippets:454
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Placeholder Request Example

Source: https://open.oceanengine.com/labels/35/docs/1771739377034318

A generic placeholder for API request examples.

```text
xxxxxxxxxx
```

--------------------------------

### GET /open_api/v3.0/report/custom/config/get/

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

获取自定义报表可用指标和维度。

```APIDOC
## GET /open_api/v3.0/report/custom/config/get/

### Description
获取自定义报表可用指标和维度。

### Method
GET

### Endpoint
https://api.oceanengine.com/open_api/v3.0/report/custom/config/get/

### Parameters
#### Query Parameters
- **advertiser_id** (number) - Required - 客户ID
- **data_topics** (string[]) - Required - 数据主题查询列表，允许值：BASIC_DATA, QUERY_DATA, BIDWORD_DATA, MATERIAL_DATA, PRODUCT_DATA, ONE_KEY_BOOST_DATA, DMP_DATA, VIDEO_DUARATION_DATA, MATERIAL_BOOST_DATA, STD_BASIC_DATA, STD_MATERIAL_DATA, STD_QUERY_DATA, STD_BIDWORD_DATA, STD_DMP_DATA, STD_PRODUCT_DATA
```

--------------------------------

### cURL GET 请求示例

Source: https://open.oceanengine.com/labels/13/docs/1799006604968971

使用命令行工具发送 GET 请求。

```bash
curl --get -H "Access-Token:xxx" \
--data-urlencode "account_ids=[\"ACCOUNT_IDS\"]" \
--data-urlencode "account_type=ACCOUNT_TYPE" \
--data-urlencode "grant_type_split=GRANT_TYPE_SPLIT" \
https://api.oceanengine.com/open_api/v3.0/account/fund/get/
```

--------------------------------

### Java GET 请求示例

Source: https://open.oceanengine.com/labels/13/docs/1799006604968971

使用 OkHttp 和 Jackson 处理参数并发送 GET 请求。

```java
        map.forEach((k, v) -> {
            try {
                ub.addParameter(k, v instanceof String ? (String) v : mapper.writeValueAsString(v));
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        });
        URL url = ub.build().toURL();

        Request request = new Request.Builder()
                .url(url)
                .method("GET", null)
                .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 {
        List < Long > account_ids_list = ACCOUNT_IDS;
        String account_ids = mapper.writeValueAsString(account_ids_list);
        String account_type = ACCOUNT_TYPE;
        String grant_type_split = GRANT_TYPE_SPLIT;

        // Args in JSON format
        String myArgs = String.format("{\"account_ids\": %s, \"account_type\": \"%s\", \"grant_type_split\": \"%s\"}",account_ids, account_type, grant_type_split);
        System.out.println(get(myArgs));
    }
}
```

--------------------------------

### cURL GET 请求示例

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

使用命令行工具 cURL 发送带有 Access-Token 和查询参数的 GET 请求。

```bash
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "data_topics=[\"DATA_TOPICS\"]" \
https://api.oceanengine.com/open_api/v3.0/report/custom/config/get/
```

--------------------------------

### GET /open_api/v3.0/tools/extreme_material_limit/get/

Source: https://open.oceanengine.com/labels/34/docs/1873286070954012

查询投放账户近 30 天基建粒度的警告或限制通知信息。

```APIDOC
## GET https://api.oceanengine.com/open_api/v3.0/tools/extreme_material_limit/get/

### Description
查询投放账户近 30 天基建（单元*素材）粒度在关联组×二级行业、company_id×二级行业两维度的警告/限制通知、命中层级、限制周期。

### Method
GET

### Endpoint
https://api.oceanengine.com/open_api/v3.0/tools/extreme_material_limit/get/

### Parameters
#### Header Parameters
- **Access-Token** (string) - Required - 授权access_token

#### Query Parameters
- **advertiser_id** (number) - Required - 投放账号ID
- **start_date** (string) - Optional - 历史 records 查询起始日期，格式 yyyy-mm-dd，默认 t-29
- **end_date** (string) - Optional - 历史 records 查询截止日期，格式 yyyy-mm-dd，默认 t（今日）
- **notification_type** (string) - Optional - 通知类型筛选，可选值: LIMIT（限制）, WARN（警告）
```

--------------------------------

### GET /open_api/2/star/info/

Source: https://open.oceanengine.com/labels/13/docs/1795928648995961

获取巨量星图账户全量信息。

```APIDOC
## GET /open_api/2/star/info/

### Description
获取巨量星图账户全量信息。

### Method
GET

### Endpoint
https://api.oceanengine.com/open_api/2/star/info/

### Parameters
#### Header Parameters
- **Access-Token** (string) - Required - 授权access_token，可以通过【获取Access token】接口获取

#### Query Parameters
- **star_ids** (number[]) - Required - 星图id

### Request Example
GET /open_api/2/star/info/?star_ids=[123456]
```

--------------------------------

### POST /open_api/2/tools/clue/life/get/

Source: https://open.oceanengine.com/docs/1794759460056076

获取客户的本地推线索列表。该接口仅允许巨量引擎工作台（组织）账户授权后调用，不支持代理商账户授权。

```APIDOC
## POST /open_api/2/tools/clue/life/get/

### Description
获取客户的本地推线索列表。该接口仅允许巨量引擎工作台（组织）账户授权后调用，不支持代理商账户授权。线索列表中不包含来客账户下自然流量线索。

### Method
POST

### Endpoint
https://api.oceanengine.com/open_api/2/tools/clue/life/get/

### Parameters
#### Header
- **Access-Token** (string) - Required - 授权access_token
- **Content-Type** (string) - Required - 请求消息类型，允许值: application/json

#### Request Body
- **local_account_ids** (number[]) - Required - 客户ids，上限50
- **start_time** (string) - Required - 查询起始时间，格式：yyyy-MM-dd hh:mm:ss
- **end_time** (string) - Required - 查询截止时间，格式：yyyy-MM-dd hh:mm:ss
- **page** (number) - Required - 页数，默认值: 1
- **page_size** (number) - Required - 页面大小，默认值: 10，上限：100
```

--------------------------------

### POST /open_api/2/tools/clue/life/callback/

Source: https://open.oceanengine.com/labels/37/docs/1805613694863499

回传线索的当前事件状态及相关业务数据，支持多种行业扩展标签。

```APIDOC
## POST /open_api/2/tools/clue/life/callback/

### Description
用于向巨量引擎回传线索的当前事件状态及相关业务数据，支持根据不同的线索状态选择对应的行业扩展标签。

### Method
POST

### Endpoint
https://api.oceanengine.com/open_api/2/tools/clue/life/callback/

### Parameters
#### Header Parameters
- **Access-Token** (string) - Required - 授权access_token
- **Content-Type** (string) - Required - 请求消息类型，固定为 application/json

#### Request Body
- **local_account_ids** (string[]) - Required - 本地推客户id列表
- **clue_convert_state** (string) - Required - 线索当前事件状态 (ARRIVAL, CLUE_CONFIRM, CLUE_HIGH_INTENTION, CONVERSION_CLASS, INVALID_EVENT)
- **clue_id** (string) - Required - 线索id
- **event_data** (object) - Optional - 无效事件标签，当clue_convert_state为INVALID_EVENT时必填
- **reason_code** (string) - Optional - 扩展标签，根据clue_convert_state选择对应的行业标签
- **reason_message** (string) - Optional - 自定义原因信息，当reason_code为OTHER时建议填写
- **deal_sub_amount** (number) - Optional - 成单金额，正整数，单位（元）
```

--------------------------------

### Java GET 请求示例

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

使用 OkHttp 构建并发送 GET 请求，参数通过 JSON 格式化。

```java
        Request request = new Request.Builder()
                .url(url)
                .method("GET", null)
                .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;
        List < String > data_topics_list = DATA_TOPICS;
        String data_topics = mapper.writeValueAsString(data_topics_list);

        // Args in JSON format
        String myArgs = String.format("{\"advertiser_id\": \"%s\", \"data_topics\": %s}",advertiser_id, data_topics);
        System.out.println(get(myArgs));
    }
}
```

--------------------------------

### POST /open_api/2/tools/clue/life/callback/

Source: https://open.oceanengine.com/labels/37/docs/1805613694863499

Reports the conversion state of a specific clue to the Ocean Engine platform.

```APIDOC
## POST /open_api/2/tools/clue/life/callback/

### Description
Reports the conversion state of a clue, including account IDs and event-specific data.

### Method
POST

### Endpoint
https://api.oceanengine.com/open_api/2/tools/clue/life/callback/

### Request Body
- **local_account_ids** (array) - Required - List of local account IDs.
- **clue_convert_state** (string) - Required - The conversion state of the clue.
- **event_data** (object) - Required - Object containing event details.
  - **reason_code** (string) - Required - Code representing the reason for the state.
  - **reason_message** (string) - Required - Message describing the reason.
- **clue_id** (string) - Required - The unique identifier for the clue.

### Request Example
{
    "local_account_ids": ["LOCAL_ACCOUNT_IDS"],
    "clue_convert_state": "CLUE_CONVERT_STATE",
    "event_data": {
        "reason_code": "REASON_CODE",
        "reason_message": "REASON_MESSAGE"
    },
    "clue_id": "CLUE_ID"
}
```

--------------------------------

### PHP GET 请求示例

Source: https://open.oceanengine.com/labels/13/docs/1799006604968971

使用 cURL 库发送带有 JSON 格式参数的 GET 请求。

```php
$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v3.0/account/fund/get/";

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

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

    $args = json_decode($json_str, true);

    /* Values of querystring is also in JSON format */
    foreach ($args as $key => $value) {
        $args[$key] = is_string($value) ? $value : json_encode($value);
    }

    $url = build_url($PATH) . "?" . http_build_query(
            $args
        );

    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 => "GET",
        CURLOPT_HTTPHEADER => array(
            "Access-Token: " . $ACCESS_TOKEN,
        ),
    ));

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

$account_ids_list = ACCOUNT_IDS;
$account_ids = json_encode($account_ids_list);
$account_type = ACCOUNT_TYPE;
$grant_type_split = GRANT_TYPE_SPLIT;

/* Args in JSON format */
$my_args = sprintf("{\"account_ids\": %s, \"account_type\": \"%s\", \"grant_type_split\": \"%s\"}", $account_ids, $account_type, $grant_type_split);
echo get($my_args);
```

--------------------------------

### Executing API Request via cURL

Source: https://open.oceanengine.com/labels/35/docs/1771739377034318

Example of a cURL command to fetch order report data from the OceanEngine API.

```bash
curl --get -H "Access-Token:xxx" \
```

```bash
--data-urlencode "aweme_sec_uid=AWEME_SEC_UID" \
```

```bash
--data-urlencode "stat_time={\"begin_time\": \"BEGIN_TIME\", \"end_time\": \"END_TIME\"}" \
```

```bash
--data-urlencode "group_by=[\"GROUP_BY\"]" \
```

```bash
--data-urlencode "filter={\"item_ids\": [\"ITEM_IDS\"], \"order_ids\": [\"ORDER_IDS\"], \"room_ids\": [\"ROOM_IDS\"], \"author_unique_ids\": [\"AUTHOR_UNIQUE_IDS\"]}" \
```

```bash
--data-urlencode "page_size=PAGE_SIZE" \
```

```bash
--data-urlencode "page=PAGE" \
```

```bash
https://api.oceanengine.com/open_api/v3.0/douplus/order/report/
```

--------------------------------

### PHP GET 请求示例

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

使用 cURL 库发送 GET 请求，包含 URL 构建和参数编码逻辑。

```php
$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v3.0/report/custom/config/get/";

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

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

    $args = json_decode($json_str, true);

    /* Values of querystring is also in JSON format */
    foreach ($args as $key => $value) {
        $args[$key] = is_string($value) ? $value : json_encode($value);
    }

    $url = build_url($PATH) . "?" . http_build_query(
            $args
        );

    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 => "GET",
        CURLOPT_HTTPHEADER => array(
            "Access-Token: " . $ACCESS_TOKEN,
        ),
    ));

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


$advertiser_id = ADVERTISER_ID;
$data_topics_list = DATA_TOPICS;
$data_topics = json_encode($data_topics_list);

/* Args in JSON format */
$my_args = sprintf("{\"advertiser_id\": \"%s\", \"data_topics\": %s}", $advertiser_id, $data_topics);
echo get($my_args);
```

--------------------------------

### Python调用自定义报表配置接口

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

使用requests库发送GET请求获取报表配置，需预先设置ACCESS_TOKEN。

```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/report/custom/config/get/"


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 get(json_str):
    # type: (str) -> dict
    """
    Send GET request
    :param json_str: Args in JSON format
    :return: Response in JSON format
    """
    args = json.loads(json_str)
    query_string = urlencode({k: v if isinstance(v, string_types) else json.dumps(v) for k, v in args.items()})
    url = build_url(PATH, query_string)
    headers = {
        "Access-Token": ACCESS_TOKEN,
    }
    rsp = requests.get(url, headers=headers)
    return rsp.json()


if __name__ == '__main__':
    advertiser_id = ADVERTISER_ID
    data_topics_list = DATA_TOPICS
    data_topics = json.dumps(data_topics_list)

    # Args in JSON format
    my_args = "{\"advertiser_id\": \"%s\", \"data_topics\": %s}" % (advertiser_id, data_topics)
    print(get(my_args))
```

--------------------------------

### GET /open_api/2/star/report/custom_data_topic_report/

Source: https://open.oceanengine.com/labels/13/docs/1792052602066947

获取指定任务的作品投后数据主题累计数据。

```APIDOC
## GET /open_api/2/star/report/custom_data_topic_report/

### Description
获取星图各类型任务的投后数据主题对应指标的累计数据。支持短视频及直播任务，数据更新频率为每日16:00后更新前一日数据。

### Method
GET

### Endpoint
https://api.oceanengine.com/open_api/2/star/report/custom_data_topic_report/

### Parameters
#### Header Parameters
- **Access-Token** (string) - Required - 授权access_token

#### Query Parameters
- **star_id** (number) - Required - 客户星图Id
- **work_id** (number) - Required - 交付作品Id（如视频Id、直播间Id）
- **demand_id** (number) - Required - 任务id
- **topics** (string[]) - Required - 数据主题: BASIC_DATA, FLOW_DATA, CONVERT_DATA, SEARCH_DATA, RECOMMEND_DATA, DY_SHOP_DATA, USER_DISTRIBUTION_DATA, INDEX_SCORE_DATA, COMMENT_DATA
```

--------------------------------

### POST https://api.oceanengine.com/open_api/2/tools/clue/life/get/

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794759460056076

Retrieves a list of local promotion clues.

```APIDOC
## POST https://api.oceanengine.com/open_api/2/tools/clue/life/get/

### Description
Retrieves the list of local promotion clues for the specified accounts.

### Method
POST

### Endpoint
https://api.oceanengine.com/open_api/2/tools/clue/life/get/

### Parameters
#### Request Body
- **local_account_ids** (array) - Required - List of local account IDs
- **start_time** (string) - Optional - Start time for filtering clues
- **end_time** (string) - Optional - End time for filtering clues
- **page** (integer) - Optional - Page number
- **page_size** (integer) - Optional - Number of items per page
```

--------------------------------

### GET /open_api/v3.0/account/fund/get/

Source: https://open.oceanengine.com/labels/13/docs/1799006604968971

批量查询账号余额，支持AD、星图、本地推账户。

```APIDOC
## GET /open_api/v3.0/account/fund/get/

### Description
批量查询账号余额，支持AD、星图、本地推账户。

### Method
GET

### Endpoint
https://api.oceanengine.com/open_api/v3.0/account/fund/get/

### Parameters
#### Query Parameters
- **account_ids** (number[]) - Required - 需要查询的账户ids，支持客户、代理商、星图客户、星图MCN、星图服务商、本地推。最多支持50个账户。
- **account_type** (string) - Required - 账户业务类型，可选值: AD, STAR, LOCAL。
- **grant_type_split** (string) - Optional - 是否拆分赠款类型，允许值: ON, OFF(默认)。

### Request Example
{
  "account_ids": [123456789],
  "account_type": "AD",
  "grant_type_split": "OFF"
}
```

--------------------------------

### 刷新Access Token请求示例

Source: https://open.oceanengine.com/labels/13

使用Refresh Token获取新Access Token的接口调用示例。刷新成功后原Refresh Token失效，需使用新返回的Refresh Token进行后续刷新。

```bash
curl --location --request POST 'https://ad.oceanengine.com/open_api/oauth2/refresh_token/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id":123456,
    "secret":"xxxx",
    "grant_type":"refresh_token",
    "refresh_token":"xxxx"
}'
```

--------------------------------

### Java调用自定义报表配置接口

Source: https://open.oceanengine.com/labels/7/docs/1755261744248832

使用OkHttp和Jackson库构建请求并获取报表配置，需处理JSON序列化及URI参数构建。

```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/report/custom/config/get/";
    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 GET request
     *
     * @param jsonStr:Args in JSON format
     * @return Response in JSON format
     */
    private static String get(String jsonStr) throws IOException, URISyntaxException {
        OkHttpClient client = new OkHttpClient().newBuilder().build();
        URIBuilder ub = new URIBuilder(buildUrl(PATH));
        Map< String, Object > map = mapper.readValue(jsonStr, Map.class);
        map.forEach((k, v) -> {
            try {
                ub.addParameter(k, v instanceof String ? (String) v : mapper.writeValueAsString(v));
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        });
        URL url = ub.build().toURL();
```
Tokens:
Raw