tiktok-business-api-sdk-official
Advanced tools
Comprehensive_collection_of_client_libraries_that_enable_our_developers_to_build_software_to_integrate_with_Business_API_faster_and_in_a_more_standardized_way_
Comprehensive collection of client libraries that enable our developers to build software to integrate with Business API faster and in a more standardized way. This SDK is automatically generated by the Swagger Codegen project:
Download the TikTok Business API SDK
git clone https://github.com/tiktok/tiktok-business-api-sdk.git
Install js-sdk dependencies
cd your_path/tiktok-business-api-sdk/js_sdk
npm install
In your project, run the following command
npm install your_path/tiktok-business-api-sdk/js_sdk --save
In your project, add the following code in package.json to set js_sdk as module
{
...
"type": "module",
...
}
Please follow the installation instruction and execute the following JS code:
var js_sdk = require('business_api_client');
var api = new js_sdk.AccountApi()
var Access_Token = "Access_Token_example"; // {String} Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
var opts = {
'body': new js_sdk.AdvertiserUpdateBody() // {AdvertiserUpdateBody} Advertiser update body parameters
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.advertiserUpdate(Access_Token, opts, callback);
All URIs are relative to https://business-api.tiktok.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| js_sdk.AccountApi | advertiserUpdate | POST /advertiser/update/ | Update an ad account Advertiser Update |
| js_sdk.AdApi | adCreate | POST /ad/create/ | Upload your ad creatives (pictures, videos, texts, call-to-action) and create an ad. For different placements, the creative formats and requirements are different. Upload your ad creatives according to the placement requirements. Each ad group can have up to 20 ads. See here to learn about how to create ads. Ad create |
| js_sdk.AdApi | adGet | GET /ad/get/ | Get the data of regular ads and ACO ads. Ad get |
| js_sdk.AdApi | adStatusUpdate | POST /ad/status/update/ | To enable, disable or delete an ad or ads Ad status update |
| js_sdk.AdApi | adUpdate | POST /ad/update/ | Modify your custom ad creatives such as call-to-action, ad name, text image and video material. To update ACO ads, use the /ad/aco/update/ endpoint. Ad update |
| js_sdk.AdAcoApi | adAcoCreate | POST /ad/aco/create/ | Create an ACO ad by uploading necessary ad creatives to the library. Ad Aco Create |
| js_sdk.AdAcoApi | adAcoGet | GET /ad/aco/get/ | Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. Ad Aco Get |
| js_sdk.AdAcoApi | adAcoMaterialStatusUpdate | POST /ad/aco/material_status/update/ | Update the status of creative materials for an ACO ad, including ad texts, images, and video materials Update materials |
| js_sdk.AdAcoApi | adAcoUpdate | POST /ad/aco/update/ | Modify ACO ad creatives. Update ACO |
| js_sdk.AdgroupApi | adgroupCreate | POST /adgroup/create/ | Create an ad group. At the ad group level, you can configure placement, audience settings (see Ad Targeting), budget, schedules, as well as bidding and optimization options for ads. To learn about the procedure and the essential data fields to create an ad group, see Create an Ad Group. Ad Update |
| js_sdk.AdgroupApi | adgroupGet | GET /adgroup/get/ | Obtain detailed information of an ad group or ad groups. Adgroup get |
| js_sdk.AdgroupApi | adgroupQuota | GET /adgroup/quota/ | Get the dynamic quota Adgroup Quota |
| js_sdk.AdgroupApi | adgroupStatusUpdate | POST /adgroup/status/update/ | Enable, disable or delete an ad group. Adgroup status update |
| js_sdk.AdgroupApi | adgroupUpdate | POST /adgroup/update/ | Obtain detailed information of an ad group or ad groups. Adgroup update |
| js_sdk.AudienceApi | dmpCustomAudienceApply | POST /dmp/custom_audience/apply/ | Apply a shared custom audience Dmp Custom_audience Apply |
| js_sdk.AudienceApi | dmpCustomAudienceApplyLog | GET /dmp/custom_audience/apply/log/ | Get the latest application log of custom audiences Dmp Custom_audience Apply Log |
| js_sdk.AudienceApi | dmpCustomAudienceCreate | POST /dmp/custom_audience/create/ | Create an audience by file Dmp Custom_audience Create |
| js_sdk.AudienceApi | dmpCustomAudienceDelete | POST /dmp/custom_audience/delete/ | Delete audiences Dmp Custom_audience Delete |
| js_sdk.AudienceApi | dmpCustomAudienceFileUpload | POST /dmp/custom_audience/file/upload/ | Upload a data file Dmp Custom_audience File Upload |
| js_sdk.AudienceApi | dmpCustomAudienceGet | GET /dmp/custom_audience/get/ | Obtain the details of specified audiences Dmp Custom_audience Get |
| js_sdk.AudienceApi | dmpCustomAudienceList | GET /dmp/custom_audience/list/ | Get all audiences Dmp Custom_audience List |
| js_sdk.AudienceApi | dmpCustomAudienceLookalikeCreate | POST /dmp/custom_audience/lookalike/create/ | Create a lookalike audience Dmp Custom_audience Lookalike Create |
| js_sdk.AudienceApi | dmpCustomAudienceLookalikeUpdate | POST /dmp/custom_audience/lookalike/update/ | Manually refresh a Lookalike Audience Dmp Custom_audience Lookalike Update |
| js_sdk.AudienceApi | dmpCustomAudienceRuleCreate | POST /dmp/custom_audience/rule/create/ | Create an audience by rules Dmp Custom_audience Rule Create |
| js_sdk.AudienceApi | dmpCustomAudienceShare | POST /dmp/custom_audience/share/ | Share custom audiences with other advertisers Dmp Custom_audience Share |
| js_sdk.AudienceApi | dmpCustomAudienceShareCancel | POST /dmp/custom_audience/share/cancel/ | Stop sharing custom audiences with other advertisers Dmp Custom_audience Share Cancel |
| js_sdk.AudienceApi | dmpCustomAudienceShareLog | GET /dmp/custom_audience/share/log/ | Get the sharing log of a custom audience Dmp Custom_audience Share Log |
| js_sdk.AudienceApi | dmpCustomAudienceUpdate | POST /dmp/custom_audience/update/ | Update the details of an audience Dmp Custom_audience Update |
| js_sdk.AudienceApi | dmpSavedAudienceCreate | POST /dmp/saved_audience/create/ | Create a Saved Audience Dmp Saved_audience Create |
| js_sdk.AudienceApi | dmpSavedAudienceDelete | POST /dmp/saved_audience/delete/ | Delete Saved Audiences Dmp Saved_audience Delete |
| js_sdk.AudienceApi | dmpSavedAudienceList | GET /dmp/saved_audience/list/ | Get the details of Saved Audiences Dmp Saved_audience List |
| js_sdk.AuthenticationApi | oauth2AccessToken | POST /oauth2/access_token/ | Get access_token and refresh_token by auth_code. The creator access token is valid for 24 hours and the refresh token is valid for one year. Within one year you will need to refresh the access token with the refresh token on a daily basis. After one year you will need to ask the creator to reauthorize. Oauth2 Access Token |
| js_sdk.AuthenticationApi | oauth2AdvertiserGet | GET /oauth2/advertiser/get/ | Get a list of advertisers that have granted you permission to manage their accounts. Authentication Oauth2 Advertiser Get |
| js_sdk.BCApi | advertiserBalanceGet | GET /advertiser/balance/get/ | Get ad account balance and budget. BC Advertiser Balance Get |
| js_sdk.BCApi | advertiserTransactionGet | GET /advertiser/transaction/get/ | Get transaction records of an ad account. BC Advertiser Transaction Get |
| js_sdk.BCApi | bcAccountTransactionGet | GET /bc/account/transaction/get/ | Get the transaction records of a BC or ad accounts. BC Account Transaction Get |
| js_sdk.BCApi | bcAdvertiserCreate | POST /bc/advertiser/create/ | Create an ad account BC advertiser create |
| js_sdk.BCApi | bcAssetAdminDelete | POST /bc/asset/admin/delete/ | Delete assets. BC Asset Admin Delete |
| js_sdk.BCApi | bcAssetAdminGet | GET /bc/asset/admin/get/ | Get assets of a Business Center as admins. BC Asset Admin Get |
| js_sdk.BCApi | bcAssetAssign | POST /bc/asset/assign/ | Assign assets to a user. BC Asset Assign |
| js_sdk.BCApi | bcAssetGet | GET /bc/asset/get/ | Get assets of a Business Center. BC Asset Get |
| js_sdk.BCApi | bcAssetGroupCreate | POST /bc/asset_group/create/ | Create an Asset Group in your Business Center. BC Asset Group Create |
| js_sdk.BCApi | bcAssetGroupDelete | POST /bc/asset_group/delete/ | Remove members' access to an Asset Group. BC Asset Group Delete |
| js_sdk.BCApi | bcAssetGroupGet | GET /bc/asset_group/get/ | Get the assets or members of an Asset Group in a Business Center. BC Asset Group Get |
| js_sdk.BCApi | bcAssetGroupList | GET /bc/asset_group/list/ | Get all Asset Groups in your Business Center. BC Asset Group List |
| js_sdk.BCApi | bcAssetGroupUpdate | POST /bc/asset_group/update/ | Update assets, members or the name of an Asset Group. BC Asset Group Update |
| js_sdk.BCApi | bcAssetMemberGet | GET /bc/asset/member/get/ | Get members by assets. BC Asset Member Get |
| js_sdk.BCApi | bcAssetPartnerGet | GET /bc/asset/partner/get/ | Get partners by assets. BC Asset Partner Get |
| js_sdk.BCApi | bcAssetUnassign | POST /bc/asset/unassign/ | Revoke the access to an asset from a user. BC Asset Unassign |
| js_sdk.BCApi | bcBalanceGet | GET /bc/balance/get/ | Get the balance of a Business Center. BC Balance Get |
| js_sdk.BCApi | bcBillingGroupCreate | POST /bc/billing_group/create/ | Create a billing group in a Business Center. BC Billing Group Create |
| js_sdk.BCApi | bcBillingGroupGet | GET /bc/billing_group/get/ | Get all billing groups in a Business Center. BC Billing Group Get |
| js_sdk.BCApi | bcBillingGroupUpdate | POST /bc/billing_group/update/ | Update settings of a billing group. BC Billing Group Update |
| js_sdk.BCApi | bcGet | GET /bc/get/ | Get Business Centers that you have access to. BC Get |
| js_sdk.BCApi | bcImageUpload | POST /bc/image/upload/ | Upload certificate images for an ad account. BC Image Upload |
| js_sdk.BCApi | bcMemberDelete | POST /bc/member/delete/ | Delete member. BC Member Delete |
| js_sdk.BCApi | bcMemberGet | GET /bc/member/get/ | Get BC members. BC Member Get |
| js_sdk.BCApi | bcMemberInvite | POST /bc/member/invite/ | Invite members to BC. BC Member Invite |
| js_sdk.BCApi | bcMemberUpdate | POST /bc/member/update/ | Update member information. BC Member Update |
| js_sdk.BCApi | bcPartnerAdd | POST /bc/partner/add/ | Add partner to Business Center. BC Partner Add |
| js_sdk.BCApi | bcPartnerAssetDelete | POST /bc/partner/asset/delete/ | Cancel asset sharing. BC Partner Asset Delete |
| js_sdk.BCApi | bcPartnerAssetGet | GET /bc/partner/asset/get/ | Get partner assets. BC Partner Asset Get |
| js_sdk.BCApi | bcPartnerDelete | POST /bc/partner/delete/ | Delete partner. BC Partner Delete |
| js_sdk.BCApi | bcPartnerGet | GET /bc/partner/get/ | Get partners. BC Partner Get |
| js_sdk.BCApi | bcPixelLinkGet | GET /bc/pixel/link/get/ | Use this endpoint to get a list of ad accounts that have been linked to the request pixel. BC Pixel Link Get |
| js_sdk.BCApi | bcPixelLinkUpdate | POST /bc/pixel/link/update/ | Use this endpoint to link and unlink pixel to advertiser accounts. BC Pixel Link Update |
| js_sdk.BCApi | bcPixelTransfer | POST /bc/pixel/transfer/ | Transfer Pixel from Advertiser to BC. BC Pixel Transfer |
| js_sdk.BCApi | bcTransactionGet | GET /bc/transaction/get/ | Get translaction records of a Business Center. BC Transaction Get |
| js_sdk.BCApi | bcTransfer | POST /bc/transfer/ | Process payments (recharge money to or deduct money from an ad account in a Business Center. BC Transfer |
| js_sdk.CampaignCreationApi | campaignCreate | POST /campaign/create/ | To create a campaign. To advertise on TikTok Ads, you need to create a campaign and set the Advertising objectives and budget. A regular campaign can contain one or more ad groups. Campaign Create |
| js_sdk.CampaignCreationApi | campaignGet | GET /campaign/get/ | Get all campaigns for an ad account. Optionally, you can use filters in your request to return only certain campaigns. Campaign get |
| js_sdk.CampaignCreationApi | campaignStatusUpdate | POST /campaign/status/update/ | Enable, disable or delete a campaign. Campaign status update |
| js_sdk.CampaignCreationApi | campaignUpdate | POST /campaign/update/ | To modify a campaign after it has been created. Information like campaign name, budget, and budget type can be updated. Campaign Update |
| js_sdk.CatalogApi | catalogAvailableCountryGet | GET /catalog/available_country/get/ | Get the countries and regions that ads for a catalog can be delivered to. Catalog Available Country Get |
| js_sdk.CatalogApi | catalogCapitalize | POST /catalog/capitalize/ | Migrate catalogs under your ad account to your Business Center. Catalog Capitalize |
| js_sdk.CatalogApi | catalogCreate | POST /catalog/create/ | Create a catalog by specifying information such as name, targeted locations, and currency. Catalog Create |
| js_sdk.CatalogApi | catalogDelete | POST /catalog/delete/ | Delete a catalog. Catalog Delete |
| js_sdk.CatalogApi | catalogEventsourceBind | POST /catalog/eventsource/bind/ | Bind app or website event sources to a catalog in a Business Center. Catalog Eventsource Bind |
| js_sdk.CatalogApi | catalogEventsourceBindGet | GET /catalog/eventsource_bind/get/ | Get event source binding information. Catalog Eventsource Bind Get |
| js_sdk.CatalogApi | catalogEventsourceUnbind | POST /catalog/eventsource/unbind/ | Unbind event sources from a catalog. Catalog Eventsource Unbind |
| js_sdk.CatalogApi | catalogFeedDelete | POST /catalog/feed/delete/ | Delete a feed. Catalog Feed Delete |
| js_sdk.CatalogApi | catalogFeedGet | GET /catalog/feed/get/ | Get all feeds or a particular feed. Catalog Feed Get |
| js_sdk.CatalogApi | catalogGet | GET /catalog/get/ | Get all catalogs or a particular catalog. Catalog Get |
| js_sdk.CatalogApi | catalogLexiconGet | GET /catalog/lexicon/get/ | Get the lexicon for your catalog for use in ad texts. Catalog Lexicon Get |
| js_sdk.CatalogApi | catalogLocationCurrencyGet | GET /catalog/location_currency/get/ | Get supported locations and corresponding currencies for Catalog API. Catalog Location Currency Get |
| js_sdk.CatalogApi | catalogOverview | GET /catalog/overview/ | Get the number of products in different audit statuses in a catalog. Catalog Overview |
| js_sdk.CatalogApi | catalogProductDelete | POST /catalog/product/delete/ | Delete products in bulk. Catalog Product Delete |
| js_sdk.CatalogApi | catalogProductFile | POST /catalog/product/file/ | Upload products via file URL. Catalog Product File |
| js_sdk.CatalogApi | catalogSetProductGet | GET /catalog/set/product/get/ | Get products in a product set. Catalog Set Product Get |
| js_sdk.CatalogApi | catalogUpdate | POST /catalog/update/ | Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. Catalog Update |
| js_sdk.CreativeAssetApi | creativePortfolioCreate | POST /creative/portfolio/create/ | Create a portfolio Portfolio create |
| js_sdk.EventCallbackApi | pixelBatch | POST /pixel/batch/ | Pixel Track server-to-server batch api |
| js_sdk.EventCallbackApi | pixelTrack | POST /pixel/track/ | Pixel Track server-to-server api |
| js_sdk.FileApi | adImageUpload | POST /file/image/ad/upload/ | The function is used to to upload pictures to the Asset Library and use the obtained image ID for creating ads. File image Upload |
| js_sdk.FileApi | adVideoInfo | GET /file/video/ad/info/ | The function is used to get the information about a list of videos File Video Ad Info from the Asset Library. |
| js_sdk.FileApi | adVideoSearch | GET /file/video/ad/search/ | The function is used to to search for video creatives in the Asset Library of an ad account. [File Video Search](to search for video creatives in the Asset Library of an ad account.) Library. |
| js_sdk.FileApi | adVideoUpload | POST /file/video/ad/upload/ | The function is used to upload a video to the Asset Library and use the obtained video ID for creating ads. File Video Upload |
| js_sdk.FileApi | fileImageAdInfo | GET /file/image/ad/info/ | Get image information. File Image Info |
| js_sdk.IdentityApi | identityCreate | POST /identity/create/ | Create a customized user identity. Identity Create |
| js_sdk.IdentityApi | identityGet | GET /identity/get/ | Get a list of identities under an ad account. You can filter results by identity type. Identity Get |
| js_sdk.IdentityApi | identityVideoInfo | GET /identity/video/info/ | Get the information about a TikTok post that you own, if your identity is AUTH_CODE, TT_USER or BC_AUTH_TT. Identity Video Info |
| js_sdk.MeasurementApi | appList | GET /app/list/ | Get the app list App list |
| js_sdk.MeasurementApi | appOptimizationEvent | GET /app/optimization_event/ | Get App Events App events |
| js_sdk.RecommendToolApi | toolTargetingCategoryRecommend | POST /tool/targeting_category/recommend/ | Get recommended interest and action categories Tool targeting category |
| js_sdk.ReportingApi | reportIntegratedGet | GET /report/integrated/get/ | Create a synchronous report task. This endpoint can currently return the reporting data of up to 10,000 advertisements. If your number of advertisements exceeds 10,000, please use campaign_ids / adgroup_ids / ad_ids as a filter to obtain the reporting data of all advertisements in batches. Additionally, with CHUNK mode on, up to 20,000 advertisements can be returned. If you use campaign_ids / adgroup_ids / ad_ids as a filter, you can pass in up to 100 IDs at a time. Reporting Get |
| js_sdk.ToolApi | searchRegion | GET /search/region/ | Get available locations by advertiser ID Search Region |
| js_sdk.ToolApi | toolActionCategory | GET /tool/action_category/ | Get action categories Tool action |
| js_sdk.ToolApi | toolBidRecommend | POST /tool/bid/recommend/ | Get a suggested bid Tool Bid Recommend |
| js_sdk.ToolApi | toolBrandSafetyPartnerAuthorizeStatus | GET /tool/brand_safety/partner/authorize/status/ | Get the authorization status of a Brand Safety partner Tool Brand_safety Partner Authorize Status |
| js_sdk.ToolApi | toolCarrier | GET /tool/carrier/ | Get carriers Tool carrier |
| js_sdk.ToolApi | toolContextualTagGet | GET /tool/contextual_tag/get/ | Get available contextual tags Tool Contextual_tag Get |
| js_sdk.ToolApi | toolContextualTagInfo | GET /tool/contextual_tag/info/ | Get details of contextual tags Tool Contextual_tag Info |
| js_sdk.ToolApi | toolDeviceModel | GET /tool/device_model/ | Get device models Tool device model |
| js_sdk.ToolApi | toolHashtagGet | GET /tool/hashtag/get/ | Get targeting hashtags by ID Tool Hashtag Get |
| js_sdk.ToolApi | toolHashtagRecommend | GET /tool/hashtag/recommend/ | Search for targeting hashtags Tool Hashtag Recommend |
| js_sdk.ToolApi | toolInterestCategory | GET /tool/interest_category/ | Get interest categories Tool Interest category |
| js_sdk.ToolApi | toolInterestKeywordGet | GET /tool/interest_keyword/get/ | Get additional interest categories by ID Tool Interest_keyword Get |
| js_sdk.ToolApi | toolInterestKeywordRecommend | GET /tool/interest_keyword/recommend/ | Get interest keywords Tool kyword recommend |
| js_sdk.ToolApi | toolLanguage | GET /tool/language/ | Get languages Tool Language |
| js_sdk.ToolApi | toolOpenUrl | GET /tool/open_url/ | Get a TikTok in-app link Tool Open_url |
| js_sdk.ToolApi | toolOsVersion | GET /tool/os_version/ | Get OS versions Tool Os_version |
| js_sdk.ToolApi | toolPhoneRegionCode | GET /tool/phone_region_code/ | Get region calling codes and region codes for phone numbers Tool Phone_region_code |
| js_sdk.ToolApi | toolRegion | GET /tool/region/ | Get available locations Tool Region |
| js_sdk.ToolApi | toolTargetingInfo | POST /tool/targeting/info/ | Obtain details about location targeting tags by ID Tool Targeting Info |
| js_sdk.ToolApi | toolTargetingList | GET /tool/targeting/list/ | Get internet service providers Tool Targeting List |
| js_sdk.ToolApi | toolTargetingSearch | POST /tool/targeting/search/ | Search for location targeting tags Tool Targeting Search |
| js_sdk.ToolApi | toolTimezone | GET /tool/timezone/ | Get time zones Tool Timezone |
| js_sdk.ToolApi | toolUrlValidate | GET /tool/url_validate/ | Get the verification results of a URL Tool Url_validate |
| js_sdk.ToolApi | toolVboStatus | GET /tool/vbo_status/ | Check Value-Based Optimization eligibility Tool Vbo_status |
All endpoints do not require authorization.
FAQs
Comprehensive_collection_of_client_libraries_that_enable_our_developers_to_build_software_to_integrate_with_Business_API_faster_and_in_a_more_standardized_way_
The npm package tiktok-business-api-sdk-official receives a total of 104 weekly downloads. As such, tiktok-business-api-sdk-official popularity was classified as not popular.
We found that tiktok-business-api-sdk-official demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.