tiktok-business-api-sdk-official

v1.1.3

Published

2 months ago

Comprehensive_collection_of_client_libraries_that_enable_our_developers_to_build_software_to_integrate_with_Business_API_faster_and_in_a_more_standardized_way_

0High
0Medium
0Low

qchen42

TikTok Business API SDK - Javascript

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:

API version: 1.2.1

Installation

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",
  ...
 }

Getting Started

Please follow the installation instruction and execute the following JS code:

var js_sdk = require('business_api_client');

var api = new js_sdk.APPManagementApi()
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.AppCreateBody() // {AppCreateBody} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appCreate(Access_Token, opts, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- js_sdk.APPManagementApi | appCreate | POST /app/create/ | Create an app. APP Create js_sdk.APPManagementApi | appInfo | GET /app/info/ | Get info of an app. APP Info js_sdk.APPManagementApi | appList | GET /app/list/ | Get the app list. APP List js_sdk.APPManagementApi | appOptimizationEvent | GET /app/optimization_event/ | Get App Conversion Events. App Optimization Event js_sdk.APPManagementApi | appOptimizationEventRetargeting | GET /app/optimization_event/retargeting/ | Get App Retargeting Events. App Optimization Event Retargeting js_sdk.APPManagementApi | appUpdate | POST /app/update/ | Update an app. APP Update js_sdk.AccountManagementApi | advertiserInfo | GET /advertiser/info/ | Get ad account details. Advertiser Info js_sdk.AccountManagementApi | advertiserUpdate | POST /advertiser/update/ | Update an ad account. Advertiser Update js_sdk.AccountManagementApi | pangleAudiencePackageGet | GET /pangle_audience_package/get/ | Get the Pangle audience packages. Pangle Audience Package Get js_sdk.AccountManagementApi | pangleBlockListGet | GET /pangle_block_list/get/ | Get the Pangle block list. Pangle Block List Get js_sdk.AccountManagementApi | pangleBlockListUpdate | POST /pangle_block_list/update/ | Update the Pangle block list. Pangle Block List Update js_sdk.AccountManagementApi | termCheck | GET /term/check/ | Check the status of Terms. Term Check js_sdk.AccountManagementApi | termConfirm | POST /term/confirm/ | Sign Terms. Term Confirm js_sdk.AccountManagementApi | termGet | GET /term/get/ | Get Terms. Term Get js_sdk.AdApi | adCreate | POST /ad/create/ | Create ad. Ad Create js_sdk.AdApi | adGet | GET /ad/get/ | Get ads. Ad Get js_sdk.AdApi | adStatusUpdate | POST /ad/status/update/ | Update ad status. Ad Status Update js_sdk.AdApi | adUpdate | POST /ad/update/ | Update ad. Ad Update js_sdk.AdApi | smartPlusAdAppeal | POST /smart_plus/ad/appeal/ | Submit ad appeal [Smart Plus Ad Appeal] js_sdk.AdApi | smartPlusAdCreate | POST /smart_plus/ad/create/ | Create a new ad [Smart Plus Ad Create] js_sdk.AdApi | smartPlusAdGet | GET /smart_plus/ad/get/ | Retrieve ad details [Smart Plus Ad Get] js_sdk.AdApi | smartPlusAdMaterialStatusUpdate | POST /smart_plus/ad/material_status/update/ | Update ad material status [Smart Plus Ad Material Status Update] js_sdk.AdApi | smartPlusAdReviewInfo | GET /smart_plus/ad/review_info/ | Get ad review info [Smart Plus Ad Review Info] js_sdk.AdApi | smartPlusAdStatusUpdate | POST /smart_plus/ad/status/update/ | Update ad status [Smart Plus Ad Status Update] js_sdk.AdApi | smartPlusAdUpdate | POST /smart_plus/ad/update/ | Update an ad [Smart Plus Ad Update] js_sdk.AdApi | smartPlusMaterialReviewInfo | GET /smart_plus/material/review_info/ | Get material review info [Smart Plus Material Review Info] 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 adgroup. Adgroup Create js_sdk.AdgroupApi | adgroupGet | GET /adgroup/get/ | Get adgroups. Adgroup Get js_sdk.AdgroupApi | adgroupQuota | GET /adgroup/quota/ | Get the dynamic quota Adgroup Quota js_sdk.AdgroupApi | adgroupStatusUpdate | POST /adgroup/status/update/ | Update adgroup status. Adgroup Status Update js_sdk.AdgroupApi | adgroupUpdate | POST /adgroup/update/ | Update adgroup. Adgroup Update js_sdk.AdgroupApi | smartPlusAdgroupCreate | POST /smart_plus/adgroup/create/ | Create a new ad group [Smart Plus AdGroup Create] js_sdk.AdgroupApi | smartPlusAdgroupGet | GET /smart_plus/adgroup/get/ | Retrieve ad group details [Smart Plus AdGroup Get] js_sdk.AdgroupApi | smartPlusAdgroupStatusUpdate | POST /smart_plus/adgroup/status/update/ | Update ad group status [Smart Plus AdGroup Status Update] js_sdk.AdgroupApi | smartPlusAdgroupUpdate | POST /smart_plus/adgroup/update/ | Update an ad group [Smart Plus AdGroup Update] js_sdk.AudienceApi | audienceInsightOverlap | GET /audience/insight/overlap/ | Get details of audience overlap. Audience Insight Overlap 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.AutomatedRulesApi | optimizerRuleBatchBind | POST /optimizer/rule/batch_bind/ | Bind objects to rules. Optimizer Rule Batch Bind js_sdk.AutomatedRulesApi | optimizerRuleCreate | POST /optimizer/rule/create/ | Create an automated rule. Optimizer Rule Create js_sdk.AutomatedRulesApi | optimizerRuleGet | GET /optimizer/rule/get/ | Get rules by rule IDs. Optimizer Rule Get js_sdk.AutomatedRulesApi | optimizerRuleList | GET /optimizer/rule/list/ | Get rules based on the values of certain filters. Optimizer Rule List js_sdk.AutomatedRulesApi | optimizerRuleResultGet | GET /optimizer/rule/result/get/ | Get result details. Optimizer Rule Result Get js_sdk.AutomatedRulesApi | optimizerRuleResultList | GET /optimizer/rule/result/list/ | Get rule results. Optimizer Rule Result List js_sdk.AutomatedRulesApi | optimizerRuleUpdate | POST /optimizer/rule/update/ | Update an automated rule. Optimizer Rule Update 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 | bcInvoiceUnpaidGet | GET /bc/invoice/unpaid/get/ | Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. BC Invoice Unpaid Get 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/ | Create campaign. Campaign Create js_sdk.CampaignCreationApi | campaignGet | GET /campaign/get/ | Get campaigns. Campaign Get js_sdk.CampaignCreationApi | campaignGmvMaxCreate | POST /campaign/gmv_max/create/ | Create GMV Max campaign Smart Plus GMV Max Campaign Create js_sdk.CampaignCreationApi | campaignGmvMaxInfo | GET /campaign/gmv_max/info/ | Get GMV Max campaign info Smart Plus GMV Max Campaign Info js_sdk.CampaignCreationApi | campaignGmvMaxSessionCreate | POST /campaign/gmv_max/session/create/ | Create GMV Max session Smart Plus GMV Max Session Create js_sdk.CampaignCreationApi | campaignGmvMaxSessionDelete | POST /campaign/gmv_max/session/delete/ | Delete GMV Max session Smart Plus GMV Max Session Delete js_sdk.CampaignCreationApi | campaignGmvMaxSessionGet | GET /campaign/gmv_max/session/get/ | Get GMV Max session info Smart Plus GMV Max Session Get js_sdk.CampaignCreationApi | campaignGmvMaxSessionList | GET /campaign/gmv_max/session/list/ | Get GMV Max session list Smart Plus GMV Max Session List js_sdk.CampaignCreationApi | campaignGmvMaxSessionUpdate | POST /campaign/gmv_max/session/update/ | Update GMV Max session Smart Plus GMV Max Session Update js_sdk.CampaignCreationApi | campaignGmvMaxUpdate | POST /campaign/gmv_max/update/ | Update GMV Max campaign Smart Plus GMV Max Campaign Update js_sdk.CampaignCreationApi | campaignStatusUpdate | POST /campaign/status/update/ | Update campaign status. Campaign Status Update js_sdk.CampaignCreationApi | campaignUpdate | POST /campaign/update/ | Update campaign. Campaign Update js_sdk.CampaignCreationApi | gmvMaxBidRecommend | GET /gmv_max/bid/recommend/ | Get GMV Max bid recommendation Smart Plus GMV Max Bid Recommend js_sdk.CampaignCreationApi | gmvMaxCustomAnchorVideoListGet | GET /gmv_max/custom_anchor_video_list/get/ | Get GMV Max custom anchor video list Smart Plus GMV Max Custom Anchor Video List Get js_sdk.CampaignCreationApi | gmvMaxOccupiedCustomShopAdsList | GET /gmv_max/occupied_custom_shop_ads/list/ | Get GMV Max occupied custom shop ads Smart Plus GMV Max Occupied Custom Shop Ads List js_sdk.CampaignCreationApi | smartPlusCampaignCreate | POST /smart_plus/campaign/create/ | Create a new campaign [Smart Plus Campaign Create] js_sdk.CampaignCreationApi | smartPlusCampaignGet | GET /smart_plus/campaign/get/ | Retrieve campaign details [Smart Plus Campaign Get] js_sdk.CampaignCreationApi | smartPlusCampaignStatusUpdate | POST /smart_plus/campaign/status/update/ | Update campaign status [Smart Plus Campaign Status Update] js_sdk.CampaignCreationApi | smartPlusCampaignUpdate | POST /smart_plus/campaign/update/ | Update an existing campaign [Smart Plus 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 | catalogFeedCreate | POST /catalog/feed/create/ | Create a feed. Catalog Feed Create 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 | catalogFeedLog | GET /catalog/feed/log/ | Get the last 10 operations of a feed. Catalog Feed Log js_sdk.CatalogApi | catalogFeedUpdate | POST /catalog/feed/update/ | Update a feed. Catalog Feed Update 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 | catalogProductLog | GET /catalog/product/log/ | Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. Catalog Product Get js_sdk.CatalogApi | catalogSetDelete | POST /catalog/set/delete/ | Delete product sets. Catalog Set Delete js_sdk.CatalogApi | catalogSetGet | GET /catalog/set/get/ | Get product sets. Catalog Set Get js_sdk.CatalogApi | catalogSetProductGet | GET /catalog/set/product/get/ | Get products in a product set. Catalog Set Product Get js_sdk.CatalogApi | catalogSetUpdate | POST /catalog/set/update/ | Use this endpoint to update the filter conditions or name of a product set. Catalog Set 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.CatalogApi | catalogVideoDelete | POST /catalog/video/delete/ | Delete uploaded catalog videos. Catalog Video Delete js_sdk.CatalogApi | catalogVideoGet | GET /catalog/video/get/ | js_sdk.CommentsApi | blockedwordCheck | GET /blockedword/check/ | Check if a list of words is blocked. Blockedword Check js_sdk.CommentsApi | blockedwordCreate | POST /blockedword/create/ | Add words to the block list. Blockedword Create js_sdk.CommentsApi | blockedwordDelete | POST /blockedword/delete/ | Delete one or more blocked words. Blockedword Delete js_sdk.CommentsApi | blockedwordList | GET /blockedword/list/ | Get the list of blocked words for an ad account. Blockedword List js_sdk.CommentsApi | blockedwordTaskCheck | GET /blockedword/task/check/ | Check the status of the export task. Blockedword Task Check js_sdk.CommentsApi | blockedwordTaskCreate | POST /blockedword/task/create/ | Create a task to export blocked words. Blockedword Task Create js_sdk.CommentsApi | blockedwordUpdate | POST /blockedword/update/ | Replace a blocked word with another word. Blockedword Task Update js_sdk.CommentsApi | commentDelete | POST /comment/delete/ | Delete comments. Comment Delete js_sdk.CommentsApi | commentList | GET /comment/list/ | Get comments for your ads. Comment List js_sdk.CommentsApi | commentPost | POST /comment/post/ | Reply to comments. Comment Post js_sdk.CommentsApi | commentReference | GET /comment/reference/ | Get related comments. Comment Reference js_sdk.CommentsApi | commentStatusUpdate | POST /comment/status/update/ | Use this endpoint to change the status of a list of comments from public to hidden, or vice versa. Comment Status Update js_sdk.CommentsApi | commentTaskCheck | GET /comment/task/check/ | Get comment export status. Comment Task Check js_sdk.CommentsApi | commentTaskCreate | POST /comment/task/create/ | Create comment export task. Comment Task Create js_sdk.CreativeManagementApi | creativeAssetDelete | POST /creative/asset/delete/ | Delete creative assets. Asset Delete js_sdk.CreativeManagementApi | creativeAssetShare | POST /creative/asset/share/ | SShare creative assets with other advertiser accounts. Asset Share js_sdk.CreativeManagementApi | creativeImageEdit | POST /creative/image/edit/ | Edit an image according to the size you want as well as apply creative trimmings. Image Edit js_sdk.CreativeManagementApi | creativePortfolioCreate | POST /creative/portfolio/create/ | Create a portfolio. Creative Portfolie Create js_sdk.CreativeManagementApi | creativePortfolioGet | GET /creative/portfolio/get/ | Get a portfolio by ID. Portfolio Get js_sdk.CreativeManagementApi | creativePortfolioList | GET /creative/portfolio/list/ | Get portfolios within an ad account. Portfolio List js_sdk.CreativeManagementApi | creativeShareableLinkCreate | POST /creative/shareable_link/create/ | js_sdk.CreativeManagementApi | creativeSmartTextGenerate | POST /creative/smart_text/generate/ | Use smart text. Smart Text Generate js_sdk.CreativeManagementApi | discoveryDetail | GET /discovery/detail/ | Get details of a popular hashtag. Discovery Detail js_sdk.CreativeManagementApi | discoveryTrendingList | GET /discovery/trending_list/ | Get popular hashtags. Trending List js_sdk.CreativeManagementApi | playableDelete | POST /playable/delete/ | Delete a playable ad. Playable Delete js_sdk.CreativeManagementApi | playableGet | GET /playable/get/ | Use this endpoint to get a list of playables. Playable Get js_sdk.CreativeManagementApi | playableSave | POST /playable/save/ | Use this endpoint to save a playable. Playable Save js_sdk.CreativeManagementApi | playableUpload | POST /playable/upload/ | You can use this endpoint to upload Playable Ad contents. Playable Upload js_sdk.CreativeManagementApi | playableValidate | GET /playable/validate/ | Check the status of the playable. Playable Validate 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 | gmvMaxIdentityGet | GET /gmv_max/identity/get/ | Get GMV Max identity info Smart Plus GMV Max Identity Get 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 | offlineCreate | POST /offline/create/ | Create a new Offline Event set. Offline Create js_sdk.MeasurementApi | offlineDelete | POST /offline/delete/ | Delete an Offline Event set. Offline Delete js_sdk.MeasurementApi | offlineGet | GET /offline/get/ | Get Offline Event sets. Offline Get js_sdk.MeasurementApi | offlineUpdate | POST /offline/update/ | Update an Offline Event set. Offline Update js_sdk.MeasurementApi | pixelCreate | POST /pixel/create/ | Create a Pixel. Pixel Create js_sdk.MeasurementApi | pixelEventCreate | POST /pixel/event/create/ | Choose either an industry or custom template to define your events. Pixel Event Create js_sdk.MeasurementApi | pixelEventDelete | POST /pixel/event/delete/ | Delete Pixel events. Pixel Event Delete js_sdk.MeasurementApi | pixelEventStats | GET /pixel/event/stats/ | View statistics of an event data over a period of time. Pixel Event Stats js_sdk.MeasurementApi | pixelEventUpdate | POST /pixel/event/update/ | Update the name of a Pixel event and the conversion value. Pixel Event Update js_sdk.MeasurementApi | pixelList | GET /pixel/list/ | Obtain a list of Pixel information. Pixel List js_sdk.MeasurementApi | pixelUpdate | POST /pixel/update/ | Update a Pixel. Pixel Update js_sdk.RecommendToolApi | toolTargetingCategoryRecommend | POST /tool/targeting_category/recommend/ | Get recommended interest and action categories Tool targeting category js_sdk.ReportingApi | gmvMaxReportGet | GET /gmv_max/report/get/ | Get GMV Max report Smart Plus GMV Max Report Get js_sdk.ReportingApi | reportIntegratedGet | GET /report/integrated/get/ | Run a synchronous report. Report Integrated Get js_sdk.ReportingApi | reportTaskCancel | POST /report/task/cancel/ | Cancel an asynchronous report task. Report Task Cancel js_sdk.ReportingApi | reportTaskCheck | GET /report/task/check/ | Get the status of an async report task. Report Task Check js_sdk.ReportingApi | reportTaskCreate | POST /report/task/create/ | js_sdk.ReportingApi | smartPlusMaterialReportBreakdown | GET /smart_plus/material_report/breakdown/ | Get breakdown of material reports [Smart Plus Material Report Breakdown] js_sdk.ReportingApi | smartPlusMaterialReportOverview | GET /smart_plus/material_report/overview/ | Get overview of material reports [Smart Plus Material Report Overview] js_sdk.StoreApi | gmvMaxExclusiveAuthorizationCreate | POST /gmv_max/exclusive_authorization/create/ | Create GMV Max exclusive authorization Smart Plus GMV Max Exclusive Authorization Create js_sdk.StoreApi | gmvMaxExclusiveAuthorizationGet | GET /gmv_max/exclusive_authorization/get/ | Get GMV Max exclusive authorization Smart Plus GMV Max Exclusive Authorization Get js_sdk.StoreApi | gmvMaxStoreList | GET /gmv_max/store/list/ | Get GMV Max store list Smart Plus GMV Max Store List js_sdk.StoreApi | gmvMaxStoreShopAdUsageCheck | GET /gmv_max/store/shop_ad_usage_check/ | Check GMV Max shop ad usage Smart Plus GMV Max Shop Ad Usage Check 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 | toolDiagnosisSearchHealth | GET /tool/diagnosis/search/health/ | Get Search Ads Campaign Health diagnoses Tool Diagnosis Search Health 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 js_sdk.VideoApi | gmvMaxVideoGet | GET /gmv_max/video/get/ | Get GMV Max video info Smart Plus GMV Max Video Get

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

TikTok Business API SDK - Javascript

Installation

Getting Started

Documentation for API Endpoints

Documentation for Models