| Active |
|---|
| This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
TikTok allows you to watch, create, update, list, and retrieve the ads, and video posts in your TikTok account.
Prerequisites
-
A TikTok account – create an account at tiktok.com.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
1. Log in to your Boost.space Integrator account, add a module from the TikTok app into an Boost.space Integrator scenario.
2. Click Add next to the Connection field.
3. Authenticate your TikTok account.
The connection has been established.
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when an ad is created or updated.
|
Connection |
|
|
Watch Ads |
Select or map the option to watch the ads:
|
|
Advertiser IDs |
Select or map the Advertiser ID you want to watch. |
|
Filter |
Select or map the options to filter the ads based on the specified matches. |
|
Campaign ID |
Select or map the Campaign ID whose ads you want to watch. |
|
Ad Group IDs |
Select or map the Ad Group IDs whose ads you want to watch. |
|
Limit |
Set the maximum number of ads Boost.space Integrator should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. The default value is 2. |
Searches for Ads.
|
Connection |
|
|
Advertiser ID |
Select or map the Advertiser ID whose details you want to search. |
|
Filter |
Select or map the options to filter the ads based on the specified match. |
|
Campaign IDs |
Select or map the Campaign ID whose ads you want to search. |
|
Ad Group IDs |
Select or map the Ad Group IDs whose ads you want to search. |
|
Limit |
Set the maximum number of ads Boost.space Integrator should return during one execution cycle. The default value is 10. |
Retrieves a list of TikTok ad reports.
|
Connection |
|
|
Advertiser ID |
Select or map the Advertiser ID whose ad reports you want to list. |
|
Service Type |
Select or map the service type to list the specific service ad reports. |
|
Report Type |
Select or map the report type whose ad reports you want to list. For example, |
|
Data Level |
Select or map the data level for the reports you want to list. For example, |
|
Dimensions |
Select or map the dimensions to include in the report. For example, |
|
Metrics |
Select or map the attribute metrics to generate the report. For example, |
|
Lifetime |
Select whether you want to list the lifetime ad reports. |
|
Limit |
Set the maximum number of ad reports Boost.space Integrator should return during one execution cycle. The default value is 10. |
Gets a specified ad.
Updates an existing ad’s statusIn Boost.space, statuses are indicators assigned to records within modules to represent their current state or progress. They can be system-defined, such as "Active" or "Done," or custom-created to fit specific workflows. Statuses help track and manage tasks, projects, and processes efficiently..
|
Connection |
|
|
Advertiser ID |
Select or map the Advertiser ID whose ad status you want to update. |
|
Ad ID |
Select or map the Ad ID whose status you want to update. |
|
Opt Status |
Select or map the status of the ad:
|
Triggers when you upload a new TikTok video post.
Required Permissions: video.list
|
Connection |
|
|
Limit |
Set the maximum number of video posts Boost.space Integrator should return during one execution cycle. The default value is 5. |
Retrieves a list of your public TikTok video posts.
Required Permissions: video.list
|
Connection |
|
|
Limit |
Set the maximum number of video posts Boost.space Integrator should return during one execution cycle. The default value is 10. |
Returns the embed code and information about the video.
|
Video URL |
Enter (map) the video URL address you want to embed. |
Uploads an original sound into TikTok.
Required Permissions: share.sound.create
|
Connection |
|
|
Source File |
Add the sound details to upload to the video: File Name Enter (map) the audio file including the extension. For example, invoice.mp3. The supported file types are mp3, wav, flac. The size of the uploaded music file must be less than 50 MB and the duration of the music file must be greater than 10 seconds and less than 300 seconds. Data Enter (map) the data of the file. |
Performs an arbitrary authorized API call.
The following API call returns all the ads from your TikTok account:
URL:
/v1.2/ad/get
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > data > list. In our example, 2 ads were returned:
