分享受众

您可以使用本接口与其他广告主分享受众。

广告账号的所有者、管理员或操作员用户可以将从客户文件或受众细分接口创建的自定义受众，广告互动、应用事件或网站访客类型的自定义受众，或相似受众分享给同一个商务中心下的广告主。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 ``xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径|/v1.2/dmp/custom_audience/share/| /v1.3/dmp/custom_audience/share/ |请求参数类型|shared_advertiser_ids: number[]<br>advertiser_id: number<br>custom_audience_ids: number[]|shared_advertiser_ids: string[]<br>advertiser_id: string<br>custom_audience_ids`: string[]|

## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/share/

**方法** POST

**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式：`application/json`。|

参数

|字段|类型|描述|
|---|---|---|
|custom_audience_ids {必填}|string[]|您想要分享的受众ID。数量大小：1-10。|
|shared_advertiser_ids{必填}|string[]|您想要分享给的广告主ID，这些广告主必须与您在同一个商务中心下。数量大小：1-10。|
|advertiser_id{必填}|string|执行操作的广告主ID。

示例

(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/dmp/custom_audience/share/";
    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 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 {
        List < Long > custom_audience_ids_list = CUSTOM_AUDIENCE_IDS;
        String custom_audience_ids = mapper.writeValueAsString(custom_audience_ids_list);
        List < Long > shared_advertiser_ids_list = SHARED_ADVERTISER_IDS;
        String shared_advertiser_ids = mapper.writeValueAsString(shared_advertiser_ids_list);
        Long advertiser_id = ADVERTISER_ID;

        // Args in JSON format
        String myArgs = String.format("{\"custom_audience_ids\": %s, \"shared_advertiser_ids\": %s, \"advertiser_id\": \"%s\"}",custom_audience_ids, shared_advertiser_ids, advertiser_id);
        System.out.println(post(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/dmp/custom_audience/share/"


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 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__':
    custom_audience_ids_list = CUSTOM_AUDIENCE_IDS
    custom_audience_ids = json.dumps(custom_audience_ids_list)
    shared_advertiser_ids_list = SHARED_ADVERTISER_IDS
    shared_advertiser_ids = json.dumps(shared_advertiser_ids_list)
    advertiser_id = ADVERTISER_ID

    # Args in JSON format
    my_args = "{\"custom_audience_ids\": %s, \"shared_advertiser_ids\": %s, \"advertiser_id\": \"%s\"}" % (custom_audience_ids, shared_advertiser_ids, advertiser_id)
    print(post(my_args))

(/code)

(code PHP php)

$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v1.3/dmp/custom_audience/share/";

/**
 * Build request URL
 * @param $path : Request path
 * @return string
 */
function build_url($path)
{
    return "https://business-api.tiktok.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;
}


$custom_audience_ids_list = CUSTOM_AUDIENCE_IDS;
$custom_audience_ids = json_encode($custom_audience_ids_list);
$shared_advertiser_ids_list = SHARED_ADVERTISER_IDS;
$shared_advertiser_ids = json_encode($shared_advertiser_ids_list);
$advertiser_id = ADVERTISER_ID;

/* Args in JSON format */
$my_args = sprintf("{\"custom_audience_ids\": %s, \"shared_advertiser_ids\": %s, \"advertiser_id\": \"%s\"}", $custom_audience_ids, $shared_advertiser_ids, $advertiser_id);
echo post($my_args);

(/code)

(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
    "custom_audience_ids": [
        "CUSTOM_AUDIENCE_IDS"
    ],
    "shared_advertiser_ids": [
        "SHARED_ADVERTISER_IDS"
    ],
    "advertiser_id": "ADVERTISER_ID"
}' \
https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/share/
(/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);