Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

TikTok Ads — connector

Reads daily performance by campaign (spend, impressions, clicks, conversions) and the list of campaigns from the TikTok Marketing API and loads into the Bronze layer.

On this page (15)

Read before: ../conectores.md (state map) and fichas.md (index of sheets).


What it is#

Reads daily performance by campaign (spend, impressions, clicks, conversions) and the list of campaigns from the TikTok Marketing API and loads into the Bronze layer.

Supported ingestion modes:

  • We fetch — We fetch the data from your source.

Purpose#

Bring TikTok Ads data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation by workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plan and permissions#

  • Plan: core product (connectors are part of all plans; the limit is the number of sources allowed by the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or canceled, runs are blocked.
  • Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When that happens, the screen indicates the feature is currently unavailable.

Prerequisites#

  • A TikTok Ads account with access to the data you want to ingest.
  • In TikTok for Business, create an app in Business API → My Apps, authorize the advertiser account and generate the long-lived Access-Token. Provide the Advertiser ID (top corner of the Ads Manager) and the token; it is encrypted (AES-256-GCM) and never shown again.

Credentials#

Authentication method: API key generated in the provider panel, sent in header/parameter.

Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the connection config, pipeline definition, export or DAG. By default the encrypted value is stored in the database; moving this connection's credential to the external credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Access-Token (tokenAcesso) — Long-lived app token (Business API → My Apps → Authorization).

Secrets are never re-displayed and go through redaction in every error/log (raw token, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNotes
advertiserIdAdvertiser IDtextyesNumeric ID of the advertiser account (Ads Manager → account selector).
dataInicioStart datetextyesFormat yyyy-MM-dd. Used when the run does not specify a window.
dataFimEnd datetextyesFormat yyyy-MM-dd (the report accepts up to 30 days per call when there is a daily dimension).
tokenAcesso 🔒Access-Tokenpassword/secretyessecret (encrypted; external vault optional); Long-lived app token (Business API → My Apps → Authorization).

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose TikTok Ads from the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
  5. Use Salvar conexão. Saving DOES NOT start any ingestion.
  6. On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
  7. In review, Publicar (agenda desligada) creates version 1 without running anything. Then, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Sample configuration (all values are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
advertiserId = <advertiserId>
dataInicio = <dataInicio>
dataFim = <dataFim>
tokenAcesso = •••••• (cifrado — nunca exibido)

Expected result#

The Test connection returns the list of discovered tables/resources. After the first load, rows appear in your workspace's Bronze layer, ready for the pipeline.

Limits and costs#

  • Pagination: hard cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~0.3 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Scope per workspace: each customer reads and writes only to their own datalake (<prefix>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being written. The external credential vault is optional and enabled per connection; without it, the encrypted value remains in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: every error/log goes through secrets redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would fall into mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacking the required permission. Reconnect the source (the source and history are preserved; do not recreate the source).
  • Rate limit (429) — the provider asked to wait. The extraction respects Retry-After and retries; if it repeats, wait and reduce the schedule frequency.
  • Resource not found — check the resource identifier (account, object, report) and the granted permissions.
  • Pagination cursor stuck — the extraction stops when the API cursor doesn't advance (anti-loop guard). If it happens in consecutive runs, open a support ticket indicating the connector and the resource.
  • Empty records path — the response arrived without records in the expected place. Check the selected resource and filters (period, account, status) before assuming there is no data.

Troubleshooting#

  • Use Test connection to isolate credential/network problems before scheduling.
  • Monitor runs in the connector observability (error rate, p50/p95, freshness).
  • A schema change at the source is signaled by schema drift (new column = info; removed column/type changed = attention).

Related#


Last review: 2026-10-04. Sheet automatically generated from the product connectors catalog.

Related links