TikTok Ads

TikTok Ads is used by brands and individual creators by paying to share sponsored content on TikTok’s platform to reach a bigger and/or more specific audience.

TikTok Ads integration replicates data using the TikTok Ads API (v1.3).

See the Schema section for a list of objects available for replication.

Uma visão de alto nível desse conector, incluindo links úteis e recursos compatíveis.

Recurso/Capacidade	Detalhes do suporte
Projetos do Qlik Talend Data Integration compatíveis	Apenas Projetos de replicação. Não há suporte para projetos de pipeline de dados.
Métodos de atualização de destino	Tarefas de replicação: Aplicar alterações Armazenar alterações Aterrisando dados em tarefas de data lake: Captura de dados de alterações (CDC)
Gerenciando metadados	A geração manual de metadados não é necessária.
Evolução do esquema	Somente a operação Alterar tipo de dados da coluna é compatível.
Replicação de colunas LOB (NCLOB, CLOB e BLOB)	Sem suporte.
CDC agendado	Obrigatório. É assim que o destino é mantido atualizado com as alterações na fonte. Para tarefas de replicação, consulte Programando tarefas Para tarefas de aterrisagem no lake, consulte Agendando uma CDC para tarefas de aterrisagem no lake
Notificações	Parcialmente compatível Configurando notificações sobre alterações na operação
Monitoramento	Somente CDC, pois o carregamento total não é relevante para esse conector. Monitorando uma tarefa de dados individual
Desencaixe automático de cargas úteis de colunas JSON	Sem suporte. As cargas úteis da coluna JSON nos conjuntos de dados de origem não são anuladas automaticamente no destino.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Certifique-se de que a conta que você usa tenha acesso de leitura às tabelas que deseja buscar.

To generate your App ID and Secret:

Log into your TikTok for Developers account.
Click your profile icon in the navigation bar.
Click Manage apps and select the relevant application.
Copy the App ID and Secret that are generated, to use in the connection settings.

Creating the connection

For more information, see Conectando-se a aplicativos SAP.

Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify.
Nota de dicaYou may need to scroll down to see this field.
When status is Verified, the authentication is verified.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings
Setting	Description
Data gateway	Selecione um Gateway Data Movement se for necessário para seu caso de uso. Nota informativa Esse campo não está disponível com a assinatura do Iniciante do Qlik Talend Cloud, pois esta não é compatível com o Gateway Data Movement. Se você tiver outro nível de assinatura e não quiser usar o Gateway Data Movement, selecione Nenhum. Para obter informações sobre os benefícios do Gateway Data Movement e casos de uso que exigem isso, consulte Qlik Data Gateway - Movimentação de dados.
Start Date	Digite a data, no formato `MM/DD/YYYY`, a partir da qual os dados devem ser replicados da fonte de dados para o destino.
Include data from deleted campaigns, ads, and adgroups	Select the checkbox if needed.
Accounts	Enter the account names separated by a comma.
App ID	ID of the app.
Secret	Secret of the app.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

ad_insights

Replication Method	CDC
Primary Keys	ad_id adgroup_id advertiser_id campaign_id stat_time_day
Replication Key	stat_time_day
Useful links	TikTok Ads documentation

ad_id

STRING

ad_name

STRING

ad_text

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

app_promotion_type

STRING

average_video_play

NUMBER

average_video_play_per_user

NUMBER

bid

STRING

bid_strategy

STRING

billing_event

STRING

budget

STRING

call_to_action

STRING

campaign_budget

STRING

campaign_dedicate_type

STRING

campaign_id

STRING

campaign_name

STRING

clicks

INTEGER

clicks_on_music_disc

INTEGER

comments

INTEGER

conversion

INTEGER

conversion_rate

NUMBER

conversion_rate_v2

NUMBER

cost_per_1000_reached

STRING

cost_per_100_reached

NUMBER

cost_per_conversion

NUMBER

cost_per_result

NUMBER

cost_per_secondary_goal_result

NUMBER

cpc

NUMBER

cpm

NUMBER

ctr

NUMBER

dpa_target_audience_type

STRING

follows

INTEGER

frequency

NUMBER

gross_impressions

STRING

image_mode

STRING

impressions

INTEGER

is_smart_creative

BOOLEAN

likes

INTEGER

mobile_app_id

STRING

objective_type

STRING

opt_status

STRING

placement_type

STRING

profile_visits

INTEGER

profile_visits_rate

NUMBER

promotion_type

STRING

reach

INTEGER

real_time_conversion

INTEGER

real_time_conversion_rate

NUMBER

real_time_conversion_rate_v2

NUMBER

real_time_cost_per_conversion

NUMBER

real_time_cost_per_result

NUMBER

real_time_result

INTEGER

real_time_result_rate

NUMBER

result

INTEGER

result_rate

NUMBER

secondary_goal_result

INTEGER

secondary_goal_result_rate

NUMBER

shares

INTEGER

smart_target

STRING

spend

NUMBER

split_test

STRING

stat_time_day

DATE-TIME

tt_app_id

STRING

tt_app_name

STRING

video_play_actions

INTEGER

video_views_p100

INTEGER

video_views_p25

INTEGER

video_views_p50

INTEGER

video_views_p75

INTEGER

video_watched_2s

INTEGER

video_watched_6s

INTEGER

ad_insights_by_age_and_gender

Replication Method	CDC
Primary Keys	ad_id adgroup_id advertiser_id age campaign_id gender stat_time_day
Replication Key	stat_time_day
Useful links	TikTok Ads documentation

ad_id

STRING

ad_name

STRING

ad_text

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

age

STRING

bid

STRING

bid_strategy

STRING

billing_event

STRING

budget

STRING

call_to_action

STRING

campaign_budget

STRING

campaign_dedicate_type

STRING

campaign_id

STRING

campaign_name

STRING

clicks

INTEGER

conversion

INTEGER

conversion_rate

NUMBER

conversion_rate_v2

NUMBER

cost_per_conversion

NUMBER

cost_per_result

NUMBER

cpc

NUMBER

cpm

NUMBER

ctr

NUMBER

dpa_target_audience_type

STRING

gender

STRING

gross_impressions

STRING

impressions

INTEGER

is_smart_creative

BOOLEAN

mobile_app_id

STRING

objective_type

STRING

opt_status

STRING

promotion_type

STRING

real_time_conversion

INTEGER

real_time_conversion_rate

NUMBER

real_time_conversion_rate_v2

NUMBER

real_time_cost_per_conversion

NUMBER

real_time_cost_per_result

NUMBER

real_time_result

INTEGER

real_time_result_rate

NUMBER

result

INTEGER

result_rate

NUMBER

rf_campaign_type

STRING

smart_target

STRING

spend

NUMBER

split_test

STRING

stat_time_day

DATE-TIME

tt_app_id

STRING

tt_app_name

STRING

user_action

STRING

ad_insights_by_country

Replication Method	CDC
Primary Keys	ad_id adgroup_id advertiser_id campaign_id country_code stat_time_day
Replication Key	stat_time_day
Useful links	TikTok Ads documentation

ad_id

STRING

ad_name

STRING

ad_text

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

bid

STRING

bid_strategy

STRING

billing_event

STRING

budget

STRING

call_to_action

STRING

campaign_budget

STRING

campaign_dedicate_type

STRING

campaign_id

STRING

campaign_name

STRING

clicks

INTEGER

conversion

INTEGER

conversion_rate

NUMBER

conversion_rate_v2

NUMBER

cost_per_conversion

NUMBER

cost_per_result

NUMBER

country_code

STRING

cpc

NUMBER

cpm

NUMBER

ctr

NUMBER

dpa_target_audience_type

STRING

gross_impressions

STRING

impressions

INTEGER

is_smart_creative

BOOLEAN

mobile_app_id

STRING

objective_type

STRING

opt_status

STRING

promotion_type

STRING

real_time_conversion

INTEGER

real_time_conversion_rate

NUMBER

real_time_conversion_rate_v2

NUMBER

real_time_cost_per_conversion

NUMBER

real_time_cost_per_result

NUMBER

real_time_result

INTEGER

real_time_result_rate

NUMBER

result

INTEGER

result_rate

NUMBER

rf_campaign_type

STRING

smart_target

STRING

spend

NUMBER

split_test

STRING

stat_time_day

DATE-TIME

tt_app_id

STRING

tt_app_name

STRING

user_action

STRING

ad_insights_by_platform

Replication Method	CDC
Primary Keys	ad_id adgroup_id campaign_id platform stat_time_day
Replication Key	stat_time_day
Useful links	TikTok Ads documentation

ad_id

STRING

ad_name

STRING

ad_text

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

bid

STRING

bid_strategy

STRING

billing_event

STRING

budget

STRING

call_to_action

STRING

campaign_budget

STRING

campaign_dedicate_type

STRING

campaign_id

STRING

campaign_name

STRING

clicks

INTEGER

conversion

INTEGER

conversion_rate

NUMBER

conversion_rate_v2

NUMBER

cost_per_conversion

NUMBER

cost_per_result

NUMBER

cpc

NUMBER

cpm

NUMBER

ctr

NUMBER

dpa_target_audience_type

STRING

gross_impressions

STRING

impressions

INTEGER

is_smart_creative

BOOLEAN

mobile_app_id

STRING

objective_type

STRING

opt_status

STRING

platform

STRING

promotion_type

STRING

real_time_conversion

INTEGER

real_time_conversion_rate

NUMBER

real_time_conversion_rate_v2

NUMBER

real_time_cost_per_conversion

NUMBER

real_time_cost_per_result

NUMBER

real_time_result

INTEGER

real_time_result_rate

NUMBER

result

INTEGER

result_rate

NUMBER

rf_campaign_type

STRING

smart_target

STRING

spend

NUMBER

split_test

STRING

stat_time_day

DATE-TIME

tt_app_id

STRING

tt_app_name

STRING

user_action

STRING

adgroups

Replication Method	CDC
Primary Keys	adgroup_id advertiser_id campaign_id modify_time
Replication Key	modify_time
Useful links	TikTok Ads documentation

actions

ARRAY

This is a nested data structure:

action_category_ids: ARRAY
action_period: NUMBER
action_scene: STRING
video_user_actions: ARRAY

adgroup_app_profile_page_state

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

age_groups

ARRAY

app_download_url

STRING

app_id

STRING

audience

ARRAY

audience_type

STRING

bid_price

NUMBER

bid_type

STRING

billing_event

STRING

brand_safety_partner

STRING

brand_safety_type

STRING

budget

NUMBER

budget_mode

STRING

campaign_id

STRING

carriers_v2

ARRAY

catalog_authorized_bc

INTEGER

catalog_id

STRING

conversion_bid_price

NUMBER

conversion_window

STRING

cpv_video_duration

STRING

create_time

DATE-TIME

creative_material_mode

STRING

current_status

STRING

dayparting

STRING

deep_bid_type

STRING

deep_cpa_bid

NUMBER

delivery_mode

STRING

device_models

ARRAY

device_price_ranges

ARRAY

excluded_audience

ARRAY

excluded_custom_actions

ARRAY

This is a nested data structure:

code: STRING
days: INTEGER

frequency

INTEGER

frequency_schedule

INTEGER

gender

STRING

included_custom_actions

ARRAY

This is a nested data structure:

code: STRING
days: INTEGER

interest_category_v2

ARRAY

interest_keywords

ARRAY

inventory_filter_enabled

BOOLEAN

ios14_targeting

STRING

ios_quota_type

STRING

is_comment_disable

BOOLEAN

is_hfss

BOOLEAN

is_new_structure

BOOLEAN

languages

ARRAY

location

ARRAY

min_android_version

STRING

min_ios_version

STRING

modify_time

DATE-TIME

network_types

ARRAY

next_day_retention

NUMBER

operating_systems

ARRAY

operation_status

STRING

optimization_event

STRING

optimization_goal

STRING

pacing

STRING

package

STRING

pangle_audience_package_exclude

ARRAY

pangle_audience_package_include

ARRAY

pangle_block_app_list_id

ARRAY

pixel_id

STRING

placement_type

STRING

placements

ARRAY

product_set_id

STRING

promotion_type

STRING

promotion_website_type

STRING

purchased_impression

NUMBER

purchased_reach

NUMBER

rf_estimated_cpr

NUMBER

rf_estimated_frequency

NUMBER

rf_purchased_type

STRING

roas_bid

NUMBER

schedule_end_time

DATE-TIME

schedule_start_time

DATE-TIME

schedule_type

STRING

secondary_optimization_event

STRING

secondary_status

STRING

share_disabled

BOOLEAN

shopping_ads_retargeting_type

STRING

skip_learning_phase

BOOLEAN

statistic_type

STRING

targeting_expansion

OBJECT

This is a nested data structure:

expansion_enabled: BOOLEAN
expansion_types: ARRAY

video_download

STRING

Replication Method	CDC
Primary Keys	ad_id adgroup_id advertiser_id campaign_id modify_time
Replication Key	modify_time
Useful links	TikTok Ads documentation

ad_format

STRING

ad_id

STRING

ad_name

STRING

ad_text

STRING

adgroup_id

STRING

adgroup_name

STRING

advertiser_id

STRING

app_name

STRING

brand_safety_vast_url

STRING

call_to_action

STRING

campaign_id

STRING

campaign_name

STRING

card_id

STRING

carousel_image_index

INTEGER

catalog_id

STRING

click_tracking_url

STRING

create_time

DATE-TIME

creative_authorized

BOOLEAN

current_status

STRING

deeplink

STRING

deeplink_type

STRING

display_name

STRING

dynamic_destination

STRING

dynamic_format

STRING

fallback_type

STRING

image_ids

ARRAY

image_mode

STRING

impression_tracking_url

STRING

is_aco

BOOLEAN

is_new_structure

BOOLEAN

item_duet_status

STRING

item_group_ids

ARRAY

item_stitch_status

STRING

landing_page_url

STRING

landing_page_urls

STRING

modify_time

DATE-TIME

music_id

STRING

operation_status

STRING

page_id

NUMBER

playable_url

STRING

product_set_id

STRING

product_specific_type

STRING

profile_image_url

STRING

promotional_music_disabled

BOOLEAN

secondary_status

STRING

shopping_ads_fallback_type

STRING

shopping_ads_video_package_id

STRING

shopping_deeplink_type

STRING

showcase_products

ARRAY

This is a nested data structure:

catalog_id: STRING
item_group_id: STRING
store_id: STRING

sku_ids

STRING

tiktok_item_id

STRING

tracking_app_id

STRING

tracking_offline_event_set_ids

ARRAY

utm_params

ARRAY

This is a nested data structure:

key: STRING
value: STRING

vast_moat_enabled

BOOLEAN

vertical_video_strategy

STRING

video_id

STRING

viewability_postbid_partner

STRING

viewability_vast_url

STRING

advertisers

Replication Method	CDC
Primary Keys	advertiser_id create_time
Replication Key	create_time
Useful links	TikTok Ads documentation

address

STRING

advertiser_account_type

STRING

advertiser_id

STRING

balance

NUMBER

cellphone_number

STRING

company

STRING

contacter

STRING

country

STRING

create_time

STRING

currency

STRING

description

STRING

email

STRING

industry

STRING

language

STRING

license_no

STRING

license_url

STRING

name

STRING

promotion_area

STRING

promotion_center_city

STRING

promotion_center_province

STRING

rejection_reason

STRING

role

STRING

status

STRING

telephone_number

STRING

timezone

STRING

campaign_insights_by_province

Replication Method	CDC
Primary Keys	advertiser_id campaign_id province_id stat_time_day
Replication Key	stat_time_day
Useful links	TikTok Ads documentation

advertiser_id

STRING

campaign_budget

STRING

campaign_dedicate_type

STRING

campaign_id

STRING

campaign_name

STRING

clicks

INTEGER

conversion

INTEGER

conversion_rate

NUMBER

conversion_rate_v2

NUMBER

cost_per_conversion

NUMBER

cost_per_result

NUMBER

cpc

NUMBER

cpm

NUMBER

ctr

NUMBER

gross_impressions

STRING

impressions

INTEGER

objective_type

STRING

province_id

STRING

real_time_conversion

INTEGER

real_time_conversion_rate

NUMBER

real_time_conversion_rate_v2

NUMBER

real_time_cost_per_conversion

NUMBER

real_time_cost_per_result

NUMBER

real_time_result

INTEGER

real_time_result_rate

NUMBER

result

INTEGER

result_rate

NUMBER

rf_campaign_type

STRING

spend

NUMBER

split_test

STRING

stat_time_day

DATE-TIME

campaigns

Replication Method	CDC
Primary Keys	advertiser_id campaign_id modify_time
Replication Key	modify_time
Useful links	TikTok Ads documentation

advertiser_id

STRING

app_id

STRING

app_promotion_type

STRING

bid_type

STRING

budget

NUMBER

budget_mode

STRING

budget_optimize_on

BOOLEAN

campaign_app_profile_page_state

STRING

campaign_id

STRING

campaign_name

STRING

campaign_product_source

STRING

campaign_type

STRING

create_time

DATE-TIME

current_status

STRING

deep_bid_type

STRING

is_new_structure

BOOLEAN

is_smart_performance_campaign

BOOLEAN

modify_time

DATE-TIME

objective

STRING

objective_type

STRING

operation_status

STRING

optimization_goal

STRING

rf_campaign_type

STRING

roas_bid

NUMBER

secondary_status

STRING

special_industries

ARRAY

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui