---
id: "f7078b5375d7f776f7e5"
url: "https://www.xmcsl.cn/project/ocean-engine-api/%E8%8E%B7%E5%8F%96%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8A%A5%E8%A1%A8%E5%8F%AF%E7%94%A8%E6%8C%87%E6%A0%87%E5%92%8C%E7%BB%B4%E5%BA%A6-1755261744248832.html"
source_url: "https://open.oceanengine.com/labels/7/docs/1755261744248832"
source_date: null
checked_at: "2026-11-05T04:21:48.909937+00:00"
status: "ready"
check_scope: "structure_only; not a factual or human review"
body_sha256: "dca0068e54108d1773f2a0d57ae764c2b0f8de8bc9160684a3dc53db64170d95"
---

# 获取自定义报表可用指标和维度 — 巨量引擎 API

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

 

<table><tr><th>关键信息</th><th>详情</th></tr><tr><th>文档 ID</th><td>1755261744248832</td></tr>&#10;<tr><th>标签 ID</th><td>7</td></tr>&#10;<tr><th>原始文档</th><td>&#91;https://open.oceanengine.com/labels/7/docs/1755261744248832&#93;(https://open.oceanengine.com/labels/7/docs/1755261744248832)</td></tr>&#10;<tr><th>接口标识</th><td>report.custom&#95;config.get</td></tr>&#10;</table>

 

💡获取自定义报表的可用指标和维度，可根据客户 ID 和数据主题查询列表进行查询，应答中包含数据主题配置列表、维度列表、指标列表等信息。 获取自定义报表可用指标和维度

 

GET \[https://api.oceanengine.com/open\_api/v3.0/report/custom/config/get/\](https://api.oceanengine.com/open\_api/v3.0/report/custom/config/get/) <a href="https://open.oceanengine.com/tools/visual_debug.html?docId=1755261744248832">🔍 可视化调试</a> <a href="https://open.oceanengine.com/labels/7/docs/1773083358100557">📦 SDK下载</a>

 

## 接口说明

 

获取自定义报表的可用指标和维度，可根据客户 ID 和数据主题查询列表进行查询，应答中包含数据主题配置列表、维度列表、指标列表等信息。

 

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

 

## 请求地址

 

<a href="https://api.oceanengine.com/open_api/v3.0/report/custom/config/get/">https://api.oceanengine.com/open&#95;api/v3.0/report/custom/config/get/</a><a href="https://open.oceanengine.com/tools/visual_debug.html?docId=1755261744248832">可视化调试</a><a href="https://open.oceanengine.com/labels/7/docs/1773083358100557">SDK下载</a><a href="https://open.oceanengine.com/labels/7/docs/1847394521222599">MCP调用</a>

 

## 请求方法

 

GET

 

## Header

 

<table>&#10;<thead>&#10;<tr>&#10;<th>字段</th>&#10;<th>类型</th>&#10;<th>必填</th>&#10;<th>描述</th>&#10;</tr>&#10;</thead>&#10;<tbody>&#10;<tr>&#10;<td><code>Access-Token</code></td>&#10;<td>string</td>&#10;<td>必填</td>&#10;<td>授权access&#95;token，可以通过【<a href="https://open.oceanengine.com/labels/7/docs/1696710505596940">获取Access token</a>】接口获取</td>&#10;</tr>&#10;</tbody>&#10;</table>

 

## 请求参数

 

<table>&#10;<thead>&#10;<tr>&#10;<th>字段</th>&#10;<th>类型</th>&#10;<th>必填</th>&#10;<th>描述</th>&#10;</tr>&#10;</thead>&#10;<tbody>&#10;<tr>&#10;<td><code>advertiser&#95;id</code></td>&#10;<td>number</td>&#10;<td>必填</td>&#10;<td>客户ID</td>&#10;</tr>&#10;<tr>&#10;<td><code>data&#95;topics</code></td>&#10;<td>string&#91;&#93;</td>&#10;<td>必填</td>&#10;<td>数据主题查询列表，允许值：<br><code>BASIC&#95;DATA</code>营销基础数据<br><code>QUERY&#95;DATA</code>搜索词数据<br><code>BIDWORD&#95;DATA</code>关键词数据<br><code>MATERIAL&#95;DATA</code>素材数据<br><code>PRODUCT&#95;DATA</code>产品数据<br><code>ONE&#95;KEY&#95;BOOST&#95;DATA</code>一键起量（巨量营销升级版）<br><code>DMP&#95;DATA</code>人群包数据<br><code>VIDEO&#95;DUARATION&#95;DATA</code>视频分秒数据<br><code>MATERIAL&#95;BOOST&#95;DATA</code>素材一键起量<br><code>STD&#95;BASIC&#95;DATA</code> 标准投放-基础报表<br><code>STD&#95;MATERIAL&#95;DATA</code> 标准投放-素材报表<br><code>STD&#95;QUERY&#95;DATA</code> 标准投放-搜索词数据<br><code>STD&#95;BIDWORD&#95;DATA</code> 标准投放-关键词数据<br><code>STD&#95;DMP&#95;DATA</code> 标准投放-人群包数据<br><code>STD&#95;PRODUCT&#95;DATA</code>标准投放-产品数据</td>&#10;</tr>&#10;</tbody>&#10;</table>

 

## 请求示例

 

### python

 

```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))
```

 

### java

 

```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();

        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));
    }
}
```

 

### php

 

```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);
```

 

### curl

 

```curl
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/
```

 

## 应答字段

 

<table>&#10;<thead>&#10;<tr>&#10;<th>字段</th>&#10;<th>类型</th>&#10;<th>必填</th>&#10;<th>描述</th>&#10;</tr>&#10;</thead>&#10;<tbody>&#10;<tr>&#10;<td><code>code</code></td>&#10;<td>number</td>&#10;<td>否</td>&#10;<td>返回码,详见 <a href="https://open.oceanengine.com/labels/7/docs/1696710760866831">【附录-返回码】</a></td>&#10;</tr>&#10;<tr>&#10;<td><code>message</code></td>&#10;<td>string</td>&#10;<td>否</td>&#10;<td>返回信息,详见 <a href="https://open.oceanengine.com/labels/7/docs/1696710760866831">【附录-返回码】</a></td>&#10;</tr>&#10;</tbody>&#10;</table>

 

<code>data</code>（json，否） — json返回值

 

<code>list</code>（object\[\]，否） — 数据主题配置列表

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`data\_topic\` \| string \| 否 \| 数据主体，枚举值：  
\`BASIC\_DATA\` 营销基础数据  
\`BIDWORD\_DATA\` 关键词数据  
\`DMP\_DATA\` 人群包数据  
\`MATERIAL\_DATA\` 素材数据  
\`ONE\_KEY\_BOOST\_DATA\` 一键起量数据  
\`PRODUCT\_DATA\` 产品数据  
\`QUERY\_DATA\` 搜索词数据  
\`VIDEO\_DUARATION\_DATA\` 视频分秒数据 \| 

<code>dimensions</code>（object\[\]，否） — 维度列表

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`field\` \| string \| 否 \| 维度字段 \| \| \`name\` \| string \| 否 \| 维度名称 \| \| \`description\` \| string \| 否 \| 维度描述 \| \| \`sort\_able\` \| bool \| 否 \| 是否支持排序 \| \| \`filter\_able\` \| bool \| 否 \| 是否支持筛选 \| 

<code>filter&#95;config</code>（object，否） — 筛选条件

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`type\` \| number \| 否 \| 筛选字段类型 \| \| \`operator\` \| number \| 否 \| 筛选方式，枚举值：  
\`1\` 等于  
\`2\` 小于  
\`3\` 小于等于  
\`4\` 大于  
\`5\` 大于等于  
\`6\` 不等于  
\`7\` 包含  
\`8\` 不包含  
\`9\` 范围查询  
\`10\` 多个值匹配包含  
\`11\` 多个值匹配都要包含 \| \| \`value\_limit\` \| number \| 否 \| 筛选字段传入数量上限 \| 

<code>range&#95;value</code>（object\[\]，否） — 筛选字段枚举列表

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`label\` \| string \| 否 \| 筛选字段名称 \| \| \`value\` \| string \| 否 \| 筛选字段具体值 \|

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`exclusion\_dims\` \| string\[\] \| 否 \| 与维度互斥的维度列表 \| \| \`exclusion\_metrics\` \| string\[\] \| 否 \| 与维度互斥的指标列表 \|

 

<code>metrics</code>（object\[\]，否） — 指标列表

 \| 字段 \| 类型 \| 必填 \| 描述 \| \| \-\-\- \| \-\-\- \| \-\-\- \| \-\-\- \| \| \`field\` \| string \| 否 \| 字段 \| \| \`name\` \| string \| 否 \| 字段名称 \| \| \`description\` \| string \| 否 \| 字段描述 \| \| \`exclusion\_dims\` \| string\[\] \| 否 \| 与指标互斥的维度 \|

 

<table>&#10;<thead>&#10;<tr>&#10;<th>字段</th>&#10;<th>类型</th>&#10;<th>必填</th>&#10;<th>描述</th>&#10;</tr>&#10;</thead>&#10;<tbody>&#10;<tr>&#10;<td><code>request&#95;id</code></td>&#10;<td>string</td>&#10;<td>否</td>&#10;<td>请求日志id</td>&#10;</tr>&#10;</tbody>&#10;</table>

 

## 应答示例

 

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

 

## 业务错误码

 

仅披露当前接口高频的参数校验报错，更多常见报错详见<a href="https://open.oceanengine.com/labels/34/docs/1696710760866831">「返回码」</a>文档