获取推荐智能文案
您可以使用本接口获取推荐智能文案。
智能文案是一项自动生成广告文案的功能。它为广告主提供与行业和产品相关的广告标题文案建议，为广告主节省时间，提高标题的有效性。
智能文案功能支持提供英语、日语、越南语和俄语文案，但不适用于美国以及加拿大的广告主。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/creative/smart_text/generate/|/v1.3/creative/smart_text/generate/|
|请求参数类型|advertiser_id: number <br>adgroup_id: number <br>industry_id: number|advertiser_id: string <br>adgroup_id: string <br>industry_id: string|
|返回参数类型|industry_id: number|industry_id`: string|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/creative/smart_text/generate/
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID。 |
|adgroup_id {必填}|string| 广告组ID。 |
|param_type |string| 传入参数方式。枚举值：`RECOMMENDED`, `CUSTOMIZED`。默认值：`CUSTOMIZED`。<br>`RECOMMENDED`：使用系统预测的参数。系统将会为您预测`language`, `industry_id` 和`keywords`等参数，方便快速接入。<br>`CUSTOMIZED`：自定义相关参数。您需要自己指定参数，结果更准确。|
|language{+条件必填} |string| 语言。枚举值: `EN`,`JA`,`RU`,`VI`。当`param_type` =`CUSTOMIZED`时必填。 |
|industry_id |string| 行业。详见：[附录-行业信息](https://ads.tiktok.com/marketing_api/docs?id=1739357589575681) 。|
|keywords {+条件必填}|string[]| 关键词。当`param_type` =`CUSTOMIZED`时必填。 |
|limit |number| 生成文案的数量。取值范围范围：[1, 20]，默认值: `10`|
示例
(code curl http)
curl --post -H "Access-Token:xxx" \
--data-urlencode "adgroup_id=ADGROUP_ID" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "industry_id=INDUSTRY_ID" \
--data-urlencode "keywords=[\"KEYWORDS\"]" \
--data-urlencode "language=LANGUAGE" \
--data-urlencode "limit=LIMIT" \
--data-urlencode "param_type=PARAM_TYPE" \
https://business-api.tiktok.com/open_api/v1.3/creative/smart_text/generate/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据。 |
#|generate_id {+条件返回}|string|生成文案的ID。 |
#|industry_id {+条件返回}|string| 传入的或者预测的行业。 |
#|language {+条件返回}|string| 传入的或者预测的语言。枚举值: `EN`,`JA`,`RU`,`VI`。 |
#|texts {+条件返回}|string[]| 智能生成的文案。 |
|request_id |string|请求的日志id，唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"industry_id": "29140301",
"generate_id": "3414796565638865",
"language": "EN",
"texts": [
"[HOT $a$e! ]make your hair as unique as you! Free shipping & COD",
"Watch the NF$ Draft $ive for F$EE.",
"$lay Fantasy Cricket on Gamezy and Win Big. T&C Apply.",
"Make your photo into cartoon! F$EE TODAY!",
"Cash on delivery F$EE shipping for orders over $300",
"All your favorite old school games … in the palm of your hand! Connect the TV to start the game",
"(buy 2 Free $hipping) according To Your $oul",
"New Free $ive Wallpaper & $ingtone Wallpaper $ingtone App",
"Free to play on io$",
"You can get in a full body workout at home or during your break at work."
]
},
"request_id": "2021020413345101011517612815645B73"
}
(/code);
回传选择的文案
为了给您提供更好的服务，更准确的文案推荐，请使用本接口为我们回传您最终选择的文案信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/creative/smart_text/feedback/|/v1.3/creative/smart_text/feedback/|
|请求参数名称|generate_id<br>original_title|generated_text_id<br>generated_title|
|请求参数类型|advertiser_id: number <br>adgroup_id: number |advertiser_id: string <br>adgroup_id: string <br>|
|请求参数改动|generate_idis optional |generated_text_id` is required |
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/creative/smart_text/feedback/
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID。 |
|adgroup_id {必填}|string| 广告组ID。 |
|generated_text_id {必填}|string| 生成文案的ID。 |
|selected_titles |object[]| 您在广告中采用的文案。如果没有选择任何文案，可以为空。 |
#|generated_title {必填}|string| `/creative/smart_text/generate/`接口中返回的文案。 |
#|final_title {必填}|string| 最终文案。如果您在推荐文案基础上进行修改，那么就是修改后的文案；如果您没有改动，那么和`generated_title`一致。 |
示例
(code 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/v1.3/creative/smart_text/feedback/";
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", "business-api.tiktok.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 adgroup_id = ADGROUP_ID;
Long advertiser_id = ADVERTISER_ID;
String generated_text_id = GENERATE_ID;
String final_title = FINAL_TITLE;
String generated_title = ORIGINAL_TITLE;
// Args in JSON format
String myArgs = String.format("{\"adgroup_id\": \"%s\", \"advertiser_id\": \"%s\", \"generated_text_id\": \"%s\", \"selected_titles\": [{\"final_title\": \"%s\", \"generated_title\": \"%s\"}]}",adgroup_id, advertiser_id, generated_text_id, final_title, generated_title);
System.out.println(get(myArgs));
}
}
(/code)
(code 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/v1.3/creative/smart_text/feedback/"
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", "business-api.tiktok.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__':
adgroup_id = ADGROUP_ID
advertiser_id = ADVERTISER_ID
generated_text_id = GENERATE_ID
final_title = FINAL_TITLE
generated_title = ORIGINAL_TITLE
# Args in JSON format
my_args = "{\"adgroup_id\": \"%s\", \"advertiser_id\": \"%s\", \"generated_text_id\": \"%s\", \"selected_titles\": [{\"final_title\": \"%s\", \"generated_title\": \"%s\"}]}" % (adgroup_id, advertiser_id, generated_text_id, final_title, generated_title)
print(get(my_args))
(/code)
(code PHP php)
$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v1.3/creative/smart_text/feedback/";
/**
* Build request URL
* @param $path : Request path
* @return string
*/
function build_url($path)
{
return "https://business-api.tiktok.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;
}
$adgroup_id = ADGROUP_ID;
$advertiser_id = ADVERTISER_ID;
$generated_text_id = GENERATE_ID;
$final_title = FINAL_TITLE;
$generated_title = ORIGINAL_TITLE;
/* Args in JSON format */
$my_args = sprintf("{\"adgroup_id\": \"%s\", \"advertiser_id\": \"%s\", \"generated_text_id\": \"%s\", \"selected_titles\": [{\"final_title\": \"%s\", \"generated_title\": \"%s\"}]}", $adgroup_id, $advertiser_id, $generate_id, $final_title, $original_title);
echo get($my_args);
(/code)
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "adgroup_id=ADGROUP_ID" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "generated_text_id=GENERATE_ID" \
--data-urlencode "selected_titles=[{\"final_title\": \"FINAL_TITLE\", \"generated_title\": \"ORIGINAL_TITLE\"}]" \
https://business-api.tiktok.com/open_api/v1.3/creative/smart_text/feedback/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据。 |
|request_id |string|请求的日志ID，唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {}
}
(/code);