ToolApi

All URIs are relative to https://business-api.tiktok.com

Method	HTTP request	Description
searchRegion	GET /open_api/v1.3/search/region/	Get available locations by advertiser ID Search Region
toolActionCategory	GET /open_api/v1.3/tool/action_category/	Get action categories Tool action
toolBidRecommend	POST /open_api/v1.3/tool/bid/recommend/	Get a suggested bid Tool Bid Recommend
toolBrandSafetyPartnerAuthorizeStatus	GET /open_api/v1.3/tool/brand_safety/partner/authorize/status/	Get the authorization status of a Brand Safety partner Tool Brand_safety Partner Authorize Status
toolCarrier	GET /open_api/v1.3/tool/carrier/	Get carriers Tool carrier
toolContextualTagGet	GET /open_api/v1.3/tool/contextual_tag/get/	Get available contextual tags Tool Contextual_tag Get
toolContextualTagInfo	GET /open_api/v1.3/tool/contextual_tag/info/	Get details of contextual tags Tool Contextual_tag Info
toolDeviceModel	GET /open_api/v1.3/tool/device_model/	Get device models Tool device model
toolHashtagGet	GET /open_api/v1.3/tool/hashtag/get/	Get targeting hashtags by ID Tool Hashtag Get
toolHashtagRecommend	GET /open_api/v1.3/tool/hashtag/recommend/	Search for targeting hashtags Tool Hashtag Recommend
toolInterestCategory	GET /open_api/v1.3/tool/interest_category/	Get interest categories Tool Interest category
toolInterestKeywordGet	GET /open_api/v1.3/tool/interest_keyword/get/	Get additional interest categories by ID Tool Interest_keyword Get
toolInterestKeywordRecommend	GET /open_api/v1.3/tool/interest_keyword/recommend/	Get interest keywords Tool kyword recommend
toolLanguage	GET /open_api/v1.3/tool/language/	Get languages Tool Language
toolOpenUrl	GET /open_api/v1.3/tool/open_url/	Get a TikTok in-app link Tool Open_url
toolOsVersion	GET /open_api/v1.3/tool/os_version/	Get OS versions Tool Os_version
toolPhoneRegionCode	GET /open_api/v1.3/tool/phone_region_code/	Get region calling codes and region codes for phone numbers Tool Phone_region_code
toolRegion	GET /open_api/v1.3/tool/region/	Get available locations Tool Region
toolTargetingInfo	POST /open_api/v1.3/tool/targeting/info/	Obtain details about location targeting tags by ID Tool Targeting Info
toolTargetingList	GET /open_api/v1.3/tool/targeting/list/	Get internet service providers Tool Targeting List
toolTargetingSearch	POST /open_api/v1.3/tool/targeting/search/	Search for location targeting tags Tool Targeting Search
toolTimezone	GET /open_api/v1.3/tool/timezone/	Get time zones Tool Timezone
toolUrlValidate	GET /open_api/v1.3/tool/url_validate/	Get the verification results of a URL Tool Url_validate
toolVboStatus	GET /open_api/v1.3/tool/vbo_status/	Check Value-Based Optimization eligibility Tool Vbo_status

searchRegion

Response searchRegion(advertiserId, accessToken, language)

Get available locations by advertiser ID Search Region

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
String language = "language_example"; // String | The language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en.
try {
    Response result = apiInstance.searchRegion(advertiserId, accessToken, language);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#searchRegion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
language	String	The language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en.	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolActionCategory

Response toolActionCategory(advertiserId, accessToken, specialIndustries)

Get action categories Tool action

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
List<String> specialIndustries = Arrays.asList("specialIndustries_example"); // List<String> | Ad categories. Enum values:`HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. `EMPLOYMENT`: Ads for job offers, internship, professional certification programs or other related opportunities. `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities.Note: This field is only supported for advertisers who are registered in America or Canada
try {
    Response result = apiInstance.toolActionCategory(advertiserId, accessToken, specialIndustries);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolActionCategory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
specialIndustries	List<String>	Ad categories. Enum values:`HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. `EMPLOYMENT`: Ads for job offers, internship, professional certification programs or other related opportunities. `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities.Note: This field is only supported for advertisers who are registered in America or Canada	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolBidRecommend

Response toolBidRecommend(accessToken, body)

Get a suggested bid Tool Bid Recommend

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
BidRecommendBody body = new BidRecommendBody(); // BidRecommendBody | 
try {
    Response result = apiInstance.toolBidRecommend(accessToken, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolBidRecommend");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accessToken	String	Authorized access token. For details, see Authentication.	[required]
body	BidRecommendBody		[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

toolBrandSafetyPartnerAuthorizeStatus

Response toolBrandSafetyPartnerAuthorizeStatus(partner, advertiserId, accessToken)

Get the authorization status of a Brand Safety partner Tool Brand_safety Partner Authorize Status

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String partner = "partner_example"; // String | Brand Safety post bid measurement partner. Enum values: Zefr.
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolBrandSafetyPartnerAuthorizeStatus(partner, advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolBrandSafetyPartnerAuthorizeStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
partner	String	Brand Safety post bid measurement partner. Enum values: Zefr.	[required]
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolCarrier

Response toolCarrier(advertiserId, accessToken)

Get carriers Tool carrier

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolCarrier(advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolCarrier");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolContextualTagGet

Response toolContextualTagGet(advertiserId, objectiveType, accessToken, regionCodes, brandSafetyType, rfCampaignType)

Get available contextual tags Tool Contextual_tag Get

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String objectiveType = "objectiveType_example"; // String | Advertising objective. Only supports REACH, VIDEO_VIEWS, RF_REACH.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
List<String> regionCodes = Arrays.asList("regionCodes_example"); // List<String> | Country or region codes.
String brandSafetyType = "brandSafetyType_example"; // String | Brand safety type. Default value: STANDARD_INVENTORY. Enum values: EXPANDED_INVENTORY: Use TikTok's brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and may contain some mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok's brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok's brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.
String rfCampaignType = "rfCampaignType_example"; // String | Note: When objective_type is specified as RF_REACH, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Do not pass in this field when objective_type is not specified as RF_REACH. Enum values: STANDARD (Reach & Frequency campaign), PULSE（TikTok Pulse campaign）
try {
    Response result = apiInstance.toolContextualTagGet(advertiserId, objectiveType, accessToken, regionCodes, brandSafetyType, rfCampaignType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolContextualTagGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
objectiveType	String	Advertising objective. Only supports REACH, VIDEO_VIEWS, RF_REACH.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
regionCodes	List<String>	Country or region codes.	[optional]
brandSafetyType	String	Brand safety type. Default value: STANDARD_INVENTORY. Enum values: EXPANDED_INVENTORY: Use TikTok's brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and may contain some mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok's brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok's brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.	[optional]
rfCampaignType	String	Note: When objective_type is specified as RF_REACH, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Do not pass in this field when objective_type is not specified as RF_REACH. Enum values: STANDARD (Reach & Frequency campaign), PULSE（TikTok Pulse campaign）	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolContextualTagInfo

Response toolContextualTagInfo(advertiserId, contextualTagIds, accessToken)

Get details of contextual tags Tool Contextual_tag Info

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
List<String> contextualTagIds = Arrays.asList("contextualTagIds_example"); // List<String> | Contextual tag IDs.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolContextualTagInfo(advertiserId, contextualTagIds, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolContextualTagInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
contextualTagIds	List<String>	Contextual tag IDs.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolDeviceModel

Response toolDeviceModel(advertiserId, accessToken)

Get device models Tool device model

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolDeviceModel(advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolDeviceModel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolHashtagGet

Response toolHashtagGet(advertiserId, keywordIds, accessToken)

Get targeting hashtags by ID Tool Hashtag Get

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
List<String> keywordIds = Arrays.asList("keywordIds_example"); // List<String> | List of keyword IDs
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolHashtagGet(advertiserId, keywordIds, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolHashtagGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
keywordIds	List<String>	List of keyword IDs	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolHashtagRecommend

Response toolHashtagRecommend(advertiserId, keywords, accessToken, operator)

Search for targeting hashtags Tool Hashtag Recommend

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
List<String> keywords = Arrays.asList("keywords_example"); // List<String> | Keywords that you want to get recommended hashtags for. If you specify multiple unrelated keywords and set operator to AND, it is possible that no recommended hashtags are returned. Max size: 10.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
String operator = "AND"; // String | The operator to be used between the keywords. Enum values: AND: Recommended hashtags will be generated based on all the keywords specified in keywords. OR: Recommended hashtags will be generated separately for each individual keyword in keywords. Default value: AND.
try {
    Response result = apiInstance.toolHashtagRecommend(advertiserId, keywords, accessToken, operator);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolHashtagRecommend");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
keywords	List<String>	Keywords that you want to get recommended hashtags for. If you specify multiple unrelated keywords and set operator to AND, it is possible that no recommended hashtags are returned. Max size: 10.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
operator	String	The operator to be used between the keywords. Enum values: AND: Recommended hashtags will be generated based on all the keywords specified in keywords. OR: Recommended hashtags will be generated separately for each individual keyword in keywords. Default value: AND.	[optional] [default to AND]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolInterestCategory

Response toolInterestCategory(advertiserId, accessToken, version, placements, specialIndustries, language)

Get interest categories Tool Interest category

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
Integer version = 56; // Integer | Version of interest category. Enum values:`1`(`interest_category`), `2` (`interest_category_v2`)。Default: `2`
List<String> placements = Arrays.asList("placements_example"); // List<String> | The apps where you want to deliver your ads. For enum values, see [Enumeration - Placement](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138). The interest categories available for different placements may be different, and the field only takes effect when `version` = `2`.
List<String> specialIndustries = Arrays.asList("specialIndustries_example"); // List<String> | Defines ad categories. Enum values:`HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. `EMPLOYMENT`: Ads for job offers, internship, professional certification programs or other related opportunities. `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: This field is only supported for advertisers who are registered in America or Canada
String language = "language_example"; // String | Category name language in repsonse. Default value: `en`. Supported languages: `en`, ` zh`, ` ja`, ` de`, ` es`, ` fr`, ` id`, ` it`, ` ko`, ` ru`, ` th`, ` tr`, ` vi`, ` ar`, ` pt`, ` ms`.For details, see [Enumeration - Language Code](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)
try {
    Response result = apiInstance.toolInterestCategory(advertiserId, accessToken, version, placements, specialIndustries, language);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolInterestCategory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
version	Integer	Version of interest category. Enum values:`1`(`interest_category`), `2` (`interest_category_v2`)。Default: `2`	[optional]
placements	List<String>	The apps where you want to deliver your ads. For enum values, see Enumeration - Placement. The interest categories available for different placements may be different, and the field only takes effect when `version` = `2`.	[optional]
specialIndustries	List<String>	Defines ad categories. Enum values:`HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. `EMPLOYMENT`: Ads for job offers, internship, professional certification programs or other related opportunities. `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: This field is only supported for advertisers who are registered in America or Canada	[optional]
language	String	Category name language in repsonse. Default value: `en`. Supported languages: `en`, ` zh`, ` ja`, ` de`, ` es`, ` fr`, ` id`, ` it`, ` ko`, ` ru`, ` th`, ` tr`, ` vi`, ` ar`, ` pt`, ` ms`.For details, see Enumeration - Language Code	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolInterestKeywordGet

Response toolInterestKeywordGet(advertiserId, accessToken, filtering, keywordQuery)

Get additional interest categories by ID Tool Interest_keyword Get

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
Object filtering = null; // Object | Filtering conditions.
List<Object> keywordQuery = null; // List<Object> | Information of the additional interest category you want to get. Max size = 50.
try {
    Response result = apiInstance.toolInterestKeywordGet(advertiserId, accessToken, filtering, keywordQuery);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolInterestKeywordGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
filtering	Object	Filtering conditions.	[optional]
keywordQuery	List<Object>	Information of the additional interest category you want to get. Max size = 50.	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolInterestKeywordRecommend

Response toolInterestKeywordRecommend(advertiserId, keyword, accessToken, language, limit, mode, audienceType)

Get interest keywords Tool kyword recommend

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String keyword = "keyword_example"; // String | Seed keyword that you use to get recommended keywords. You can specify only one seed keyword
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
String language = "language_example"; // String | Keyword language. Default value: `en`. Note that target audience languages are not limited by keyword languages. You can use English keywords to target audience that do not speak English. Supported languages: `fr`, `id`, `it`, `ja`, `ms`, `ar`, `vi`, `en`, `ru`, `es`, `th`, `tr`, `hi`, `zh`, `de`, `ko`
Integer limit = 56; // Integer | Number of recommended keywords you want to get. Default value: 50. Value range: 1-50
String mode = "mode_example"; // String | Search mode. Enum values: `FUZZ_MATCH`, `SEMANTIC_RECOMMEND`. Default value: `FUZZ_MATCH`
String audienceType = "audienceType_example"; // String | Audience type. Enum values: `GENERAL_INTEREST`: General interest. The audiences have a general, long-term interest in a video category. `PURCHASE_INTENTION`: Purchase intent. The audiences recent behavior suggests they may buy something related to a content category. Default value: `GENERAL_INTEREST`
try {
    Response result = apiInstance.toolInterestKeywordRecommend(advertiserId, keyword, accessToken, language, limit, mode, audienceType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolInterestKeywordRecommend");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
keyword	String	Seed keyword that you use to get recommended keywords. You can specify only one seed keyword	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
language	String	Keyword language. Default value: `en`. Note that target audience languages are not limited by keyword languages. You can use English keywords to target audience that do not speak English. Supported languages: `fr`, `id`, `it`, `ja`, `ms`, `ar`, `vi`, `en`, `ru`, `es`, `th`, `tr`, `hi`, `zh`, `de`, `ko`	[optional]
limit	Integer	Number of recommended keywords you want to get. Default value: 50. Value range: 1-50	[optional]
mode	String	Search mode. Enum values: `FUZZ_MATCH`, `SEMANTIC_RECOMMEND`. Default value: `FUZZ_MATCH`	[optional]
audienceType	String	Audience type. Enum values: `GENERAL_INTEREST`: General interest. The audiences have a general, long-term interest in a video category. `PURCHASE_INTENTION`: Purchase intent. The audiences recent behavior suggests they may buy something related to a content category. Default value: `GENERAL_INTEREST`	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolLanguage

Response toolLanguage(advertiserId, accessToken)

Get languages Tool Language

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolLanguage(advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolLanguage");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolOpenUrl

Response toolOpenUrl(advertiserId, url, urlType, accessToken)

Get a TikTok in-app link Tool Open_url

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String url = "url_example"; // String | Open URL that you want to get the internal link for.
String urlType = "urlType_example"; // String | Type of the open TikTok URL. Enum: USER_PROFILE VIDEO: Video detail page HASHTAG_CHALLENGE: Hashtag challenge page MUSIC: Music page STICKER: Sticker (special effect) page STICKER_SHOOTER: Shoot a video with a sticker (special effect).
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolOpenUrl(advertiserId, url, urlType, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolOpenUrl");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
url	String	Open URL that you want to get the internal link for.	[required]
urlType	String	Type of the open TikTok URL. Enum: USER_PROFILE VIDEO: Video detail page HASHTAG_CHALLENGE: Hashtag challenge page MUSIC: Music page STICKER: Sticker (special effect) page STICKER_SHOOTER: Shoot a video with a sticker (special effect).	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolOsVersion

Response toolOsVersion(advertiserId, osType, accessToken)

Get OS versions Tool Os_version

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String osType = "osType_example"; // String | OS type. Enum values: ANDROID,IOS.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolOsVersion(advertiserId, osType, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolOsVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
osType	String	OS type. Enum values: ANDROID,IOS.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolPhoneRegionCode

Response toolPhoneRegionCode(advertiserId, accessToken)

Get region calling codes and region codes for phone numbers Tool Phone_region_code

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolPhoneRegionCode(advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolPhoneRegionCode");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolRegion

Response toolRegion(advertiserId, placements, objectiveType, accessToken, promotionTargetType, operatingSystem, brandSafetyType, brandSafetyPartner, levelRange, rfCampaignType)

Get available locations Tool Region

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
List<String> placements = Arrays.asList("placements_example"); // List<String> | The apps where you want to deliver your ads. For enum values, see [Enumeration - Placement](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)
String objectiveType = "objectiveType_example"; // String | Your objective type. For enum values and descriptions, see [Objectives](https://ads.tiktok.com/marketing_api/docs?id=1737585562434561)
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
String promotionTargetType = "promotionTargetType_example"; // String | Valid when `objective_type` is `LEAD_GENERATION`. The promotion type for Lead Generation objective. Enum values: `INSTANT_PAGE`：Instant Form. To create a fast-loading in-app TikTok Instant Form to collect more leads. `EXTERNAL_WEBSITE`：Website Form. To use a landing page that has the Website Form or the TikTok Instant Page that redirects to the website with the Website Form to collect more leads.Note: The field is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative
String operatingSystem = "operatingSystem_example"; // String | Operating systems that you want to target. Enum values: `ANDROID`, `IOS`
String brandSafetyType = "brandSafetyType_example"; // String | Brand safety type. Valid only when `placements` is set as `PLACEMENT_TIKTOK`. Default value: `NO_BRAND_SAFETY`
String brandSafetyPartner = "brandSafetyPartner_example"; // String | Brand safety partner. Required when `brand_safety_type` is `THIRD_PARTY`, and `placements` needs to be set as `PLACEMENT_TIKTOK`. Enum values: `IAS`, `OPEN_SLATE`.Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative
String levelRange = "levelRange_example"; // String | Location level you want to get. Enum values: `ALL`: all levels`TO_COUNTRY`: only country or region level `TO_PROVINCE`: country and province level; DMA and Metropolitan are at province level.`TO_CITY`: country, province, and city levels`TO_DISTRICT`: country, province, city, and district levels.
String rfCampaignType = "rfCampaignType_example"; // String | When `objective_type` is specified as `RF_REACH`, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Enum values: `STANDARD` (Reach & Frequency campaign), `PULSE` (TikTok Pulse campaign). If you set this field as `PULSE`, only one location ID (`location_id`) will be returned.Note: Do not pass in this field when `objective_type` is not specified as `RF_REACH`. You need to pass the `location_id` value returned in this endpoint to `location_ids` when you use [/adgroup/rf/create/](https://ads.tiktok.com/marketing_api/docs?id=1738235338194945) to create a TikTok Pulse ad group.
try {
    Response result = apiInstance.toolRegion(advertiserId, placements, objectiveType, accessToken, promotionTargetType, operatingSystem, brandSafetyType, brandSafetyPartner, levelRange, rfCampaignType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolRegion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
placements	List<String>	The apps where you want to deliver your ads. For enum values, see Enumeration - Placement	[required]
objectiveType	String	Your objective type. For enum values and descriptions, see Objectives	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
promotionTargetType	String	Valid when `objective_type` is `LEAD_GENERATION`. The promotion type for Lead Generation objective. Enum values: `INSTANT_PAGE`：Instant Form. To create a fast-loading in-app TikTok Instant Form to collect more leads. `EXTERNAL_WEBSITE`：Website Form. To use a landing page that has the Website Form or the TikTok Instant Page that redirects to the website with the Website Form to collect more leads.Note: The field is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative	[optional]
operatingSystem	String	Operating systems that you want to target. Enum values: `ANDROID`, `IOS`	[optional]
brandSafetyType	String	Brand safety type. Valid only when `placements` is set as `PLACEMENT_TIKTOK`. Default value: `NO_BRAND_SAFETY`	[optional]
brandSafetyPartner	String	Brand safety partner. Required when `brand_safety_type` is `THIRD_PARTY`, and `placements` needs to be set as `PLACEMENT_TIKTOK`. Enum values: `IAS`, `OPEN_SLATE`.Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative	[optional]
levelRange	String	Location level you want to get. Enum values: `ALL`: all levels`TO_COUNTRY`: only country or region level `TO_PROVINCE`: country and province level; DMA and Metropolitan are at province level.`TO_CITY`: country, province, and city levels`TO_DISTRICT`: country, province, city, and district levels.	[optional]
rfCampaignType	String	When `objective_type` is specified as `RF_REACH`, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Enum values: `STANDARD` (Reach & Frequency campaign), `PULSE` (TikTok Pulse campaign). If you set this field as `PULSE`, only one location ID (`location_id`) will be returned.Note: Do not pass in this field when `objective_type` is not specified as `RF_REACH`. You need to pass the `location_id` value returned in this endpoint to `location_ids` when you use /adgroup/rf/create/ to create a TikTok Pulse ad group.	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolTargetingInfo

Response toolTargetingInfo(accessToken, body)

Obtain details about location targeting tags by ID Tool Targeting Info

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
TargetingInfoBody body = new TargetingInfoBody(); // TargetingInfoBody | 
try {
    Response result = apiInstance.toolTargetingInfo(accessToken, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolTargetingInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accessToken	String	Authorized access token. For details, see Authentication.	[required]
body	TargetingInfoBody		[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

toolTargetingList

Response toolTargetingList(advertiserId, locationIds, scene, accessToken)

Get internet service providers Tool Targeting List

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
List<String> locationIds = Arrays.asList("locationIds_example"); // List<String> | IDs of the locations that you want to get the supported ISP IDs for. Max size: 1000. To find out the list of location IDs, see Location IDs. Note: You need to pass location IDs at the country or region level. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/region/ and the returned level for location IDs at the country or region level will be COUNTRY.
String scene = "scene_example"; // String | The targeting type that the targeting tags are used for. The allowed enum values: ISP ( Internet Service Provider targeting).
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolTargetingList(advertiserId, locationIds, scene, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolTargetingList");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
locationIds	List<String>	IDs of the locations that you want to get the supported ISP IDs for. Max size: 1000. To find out the list of location IDs, see Location IDs. Note: You need to pass location IDs at the country or region level. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/region/ and the returned level for location IDs at the country or region level will be COUNTRY.	[required]
scene	String	The targeting type that the targeting tags are used for. The allowed enum values: ISP ( Internet Service Provider targeting).	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolTargetingSearch

Response toolTargetingSearch(accessToken, body)

Search for location targeting tags Tool Targeting Search

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
TargetingSearchBody body = new TargetingSearchBody(); // TargetingSearchBody | 
try {
    Response result = apiInstance.toolTargetingSearch(accessToken, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolTargetingSearch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accessToken	String	Authorized access token. For details, see Authentication.	[required]
body	TargetingSearchBody		[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

toolTimezone

Response toolTimezone(advertiserId, accessToken)

Get time zones Tool Timezone

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolTimezone(advertiserId, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolTimezone");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolUrlValidate

Response toolUrlValidate(advertiserId, url, accessToken)

Get the verification results of a URL Tool Url_validate

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String url = "url_example"; // String | The URL that you want to get verification results for.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
try {
    Response result = apiInstance.toolUrlValidate(advertiserId, url, accessToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolUrlValidate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
url	String	The URL that you want to get verification results for.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

toolVboStatus

Response toolVboStatus(advertiserId, objectiveType, promotionType, placements, accessToken, pixelId, appId, optimizationEvent, ios14QuotaType, appPromotionType, storeId, campaignAppProfilePageState, isSmartPerformanceCampaign, budgetOptimizeOn, campaignType)

Check Value-Based Optimization eligibility Tool Vbo_status

Example

// Import classes:
//import business_api.ApiException;
//import io.swagger.client.api.ToolApi;


ToolApi apiInstance = new ToolApi();
String advertiserId = "advertiserId_example"; // String | Advertiser ID.
String objectiveType = "objectiveType_example"; // String | Advertising objective. Set this field to APP_PROMOTION, WEB_CONVERSIONS, or PRODUCT_SALES. When you set this field to any other objective, vo_status will be NOT_SUPPORT because these objectives are not supported for VBO. For enum values and descriptions, see Objectives. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.
String promotionType = "promotionType_example"; // String | Promotion type and you can decide where you'd like to promote your products using this field. For enum values, see Enumeration - Promotion Type. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.
List<String> placements = Arrays.asList("placements_example"); // List<String> | The apps where you want to deliver your ads. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported.
String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
String pixelId = "pixelId_example"; // String | Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. Pixel ID. When you pass in this field, you need to specify optimization_event at the same time. To get Pixel IDs, use the /pixel/list/ endpoint.
String appId = "appId_example"; // String | Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. The Application ID of the promoted app. To get App IDs, use the /app/list/ endpoint.
String optimizationEvent = "optimizationEvent_example"; // String | Required when pixel_id is passed. Ignored when app_id is passed. Conversion event for the ad group. See Conversion events for more.
String ios14QuotaType = "ios14QuotaType_example"; // String | Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. We recommend using campaign_type alone when you specify an iOS 14 Dedicated Campaign. campaign_type as REGULAR_CAMPAIGN or ios14_quota_type as UNOCCUPIED both indicate a non-iOS 14 Dedicated Campaign. campaign_type as IOS14_CAMPAIGN or ios14_quota_type as OCCUPIED both indicate an iOS 14 Dedicated Campaign. Whether the campaign will be counted towards the iOS 14 Dedicated Campaign quota. Enum values: OCCUPIED: The campaign is an iOS 14 Dedicated Campaign. UNOCCUPIED: The campaign is not an iOS 14 Dedicated Campaign.
String appPromotionType = "appPromotionType_example"; // String | Required when objective_type is APP_PROMOTION. App promotion type. Enum values: APP_INSTALL: Get new users to install your app. APP_RETARGETING: Re-engage existing users to take action in your app. Note: Only the enum value APP_INSTALL can be used in an iOS14 Dedicated Campaign.
String storeId = "storeId_example"; // String | Valid only when objective_type is PRODUCT_SALES. ID of the TikTok Shop. Note: To get the TikTok Shop ID, you can use /bc/asset/get/: When in the response asset_type is TIKTOK_SHOP, the returned asset_id is the TikTok Shop ID.
String campaignAppProfilePageState = "campaignAppProfilePageState_example"; // String | Whether to use App Profile Page at the campaign level to optimize delivery. Enum values: ON, OFF. You can use the field only when objective_type is APP_PROMOTION and your campaign is an iOS14 Dedicated Campaign (ios14_quota_type =OCCUPIED). Otherwise, an error will occur.
Boolean isSmartPerformanceCampaign = true; // Boolean | Whether the campaign is a Smart+ Campaign or not. Enum values: true, false.
Boolean budgetOptimizeOn = false; // Boolean | Whether to enable Campaign Budget Optimization (CBO). Enum values: true, false. For details about CBO, see Campaign Budget Optimization.
String campaignType = "campaignType_example"; // String | Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. Campaign type. Enums values: REGULAR_CAMPAIGN: non-iOS 14 Dedicated Campaign. IOS14_CAMPAIGN: iOS 14 Dedicated Campaign. The value IOS14_CAMPAIGN can only be used when: objective_type is PRODUCT_SALES. objective_type is APP_PROMOTION and app_promotion_type is APP_INSTALL.
try {
    Response result = apiInstance.toolVboStatus(advertiserId, objectiveType, promotionType, placements, accessToken, pixelId, appId, optimizationEvent, ios14QuotaType, appPromotionType, storeId, campaignAppProfilePageState, isSmartPerformanceCampaign, budgetOptimizeOn, campaignType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ToolApi#toolVboStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
advertiserId	String	Advertiser ID.	[required]
objectiveType	String	Advertising objective. Set this field to APP_PROMOTION, WEB_CONVERSIONS, or PRODUCT_SALES. When you set this field to any other objective, vo_status will be NOT_SUPPORT because these objectives are not supported for VBO. For enum values and descriptions, see Objectives. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.	[required]
promotionType	String	Promotion type and you can decide where you'd like to promote your products using this field. For enum values, see Enumeration - Promotion Type. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.	[required]
placements	List<String>	The apps where you want to deliver your ads. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported.	[required]
accessToken	String	Authorized access token. For details, see Authentication.	[required]
pixelId	String	Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. Pixel ID. When you pass in this field, you need to specify optimization_event at the same time. To get Pixel IDs, use the /pixel/list/ endpoint.	[optional]
appId	String	Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. The Application ID of the promoted app. To get App IDs, use the /app/list/ endpoint.	[optional]
optimizationEvent	String	Required when pixel_id is passed. Ignored when app_id is passed. Conversion event for the ad group. See Conversion events for more.	[optional]
ios14QuotaType	String	Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. We recommend using campaign_type alone when you specify an iOS 14 Dedicated Campaign. campaign_type as REGULAR_CAMPAIGN or ios14_quota_type as UNOCCUPIED both indicate a non-iOS 14 Dedicated Campaign. campaign_type as IOS14_CAMPAIGN or ios14_quota_type as OCCUPIED both indicate an iOS 14 Dedicated Campaign. Whether the campaign will be counted towards the iOS 14 Dedicated Campaign quota. Enum values: OCCUPIED: The campaign is an iOS 14 Dedicated Campaign. UNOCCUPIED: The campaign is not an iOS 14 Dedicated Campaign.	[optional]
appPromotionType	String	Required when objective_type is APP_PROMOTION. App promotion type. Enum values: APP_INSTALL: Get new users to install your app. APP_RETARGETING: Re-engage existing users to take action in your app. Note: Only the enum value APP_INSTALL can be used in an iOS14 Dedicated Campaign.	[optional]
storeId	String	Valid only when objective_type is PRODUCT_SALES. ID of the TikTok Shop. Note: To get the TikTok Shop ID, you can use /bc/asset/get/: When in the response asset_type is TIKTOK_SHOP, the returned asset_id is the TikTok Shop ID.	[optional]
campaignAppProfilePageState	String	Whether to use App Profile Page at the campaign level to optimize delivery. Enum values: ON, OFF. You can use the field only when objective_type is APP_PROMOTION and your campaign is an iOS14 Dedicated Campaign (ios14_quota_type =OCCUPIED). Otherwise, an error will occur.	[optional]
isSmartPerformanceCampaign	Boolean	Whether the campaign is a Smart+ Campaign or not. Enum values: true, false.	[optional]
budgetOptimizeOn	Boolean	Whether to enable Campaign Budget Optimization (CBO). Enum values: true, false. For details about CBO, see Campaign Budget Optimization.	[optional] [default to false]
campaignType	String	Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. Campaign type. Enums values: REGULAR_CAMPAIGN: non-iOS 14 Dedicated Campaign. IOS14_CAMPAIGN: iOS 14 Dedicated Campaign. The value IOS14_CAMPAIGN can only be used when: objective_type is PRODUCT_SALES. objective_type is APP_PROMOTION and app_promotion_type is APP_INSTALL.	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

ToolApi.md

Latest commit

History

ToolApi.md

File metadata and controls

ToolApi

searchRegion

Example

Parameters

Return type

Authorization

HTTP request headers

toolActionCategory

Example

Parameters

Return type

Authorization

HTTP request headers

toolBidRecommend

Example

Parameters

Return type

Authorization

HTTP request headers

toolBrandSafetyPartnerAuthorizeStatus

Example

Parameters

Return type

Authorization

HTTP request headers

toolCarrier

Example

Parameters

Return type

Authorization

HTTP request headers

toolContextualTagGet

Example

Parameters

Return type

Authorization

HTTP request headers

toolContextualTagInfo

Example

Parameters

Return type

Authorization

HTTP request headers

toolDeviceModel

Example

Parameters

Return type

Authorization

HTTP request headers

toolHashtagGet

Example

Parameters

Return type

Authorization

HTTP request headers

toolHashtagRecommend

Example

Parameters

Return type

Authorization

HTTP request headers

toolInterestCategory

Example

Parameters

Return type

Authorization

HTTP request headers

toolInterestKeywordGet

Example

Parameters

Return type

Authorization

HTTP request headers

toolInterestKeywordRecommend