Pular para o conteúdo principal

Ingerir dados de anúncios do TikTok

info

Beta

Esse recurso está em Beta.

Esta página mostra como criar um pipeline de ingestão de anúncios do TikTok usando LakeFlow Connect.

Requisitos​

  • Para criar um pipeline de ingestão, você deve primeiro atender aos seguintes requisitos:

    • Seu workspace deve estar habilitado para o Unity Catalog.

    • compute sem servidor (serverless compute) deve estar habilitado para seu workspace. Consulte os requisitos compute sem servidor.

    • Para criar uma nova conexão, você deve ter privilégios CREATE CONNECTION no metastore. Consulte Gerenciar privilégios no Unity Catalog.

      Se o conector suportar a criação pipeline baseada em interface de usuário, um administrador poderá criar a conexão e o pipeline simultaneamente, concluindo os passos desta página. No entanto, se os usuários que criam pipelines utilizarem a criação pipeline baseada em API ou não forem administradores, um administrador deverá primeiro criar a conexão no Catalog Explorer. Consulte Conectar para gerenciar fontes de ingestão.

    • Para usar uma conexão existente, você deve ter os privilégios USE CONNECTION ou ALL PRIVILEGES no objeto de conexão.

    • Você deve ter privilégios USE CATALOG no catálogo de destino.

    • Você deve ter privilégios USE SCHEMA e CREATE TABLE em um esquema existente ou privilégios CREATE SCHEMA no catálogo de destino.

  • Para importar dados de anúncios do TikTok, primeiro você precisa configurar a autenticação no Databricks. Consulte Configurar anúncios do TikTok para gerenciar a ingestão.

Crie um pipeline de ingestão.​

Use pacotes de automação declarativa para gerenciar o pipeline de anúncios do TikTok como código. Os pacotes podem conter definições YAML de Job e tarefa, são gerenciados usando a CLI Databricks e podem ser compartilhados e executados em diferentes espaços de trabalho de destino (como desenvolvimento, teste e produção). Para mais informações, consulte O que são pacotes de automação declarativa?.

  1. Crie um pacote usando a CLI do Databricks:

    Bash
    databricks bundle init
  2. Adicione dois novos arquivos de recursos ao pacote:

    • Um arquivo de definição de pipeline (por exemplo, resources/tiktok_ads_pipeline.yml). Consulte pipeline.ingestion_definition e exemplos.
    • Um arquivo de definição de trabalho que controla a frequência de ingestão de dados (por exemplo, resources/tiktok_ads_job.yml).
  3. Implante o pipeline usando a CLI Databricks :

    Bash
    databricks bundle deploy

Exemplos​

Para implantações de pacotes de automação declarativa, use o seguinte padrão para seu arquivo de definição pipeline e arquivo de definição de tarefa.

Arquivo de definição de pipeline​

YAML
resources:
pipelines:
tiktok_ads_pipeline:
name: tiktok_ads_pipeline
catalog: 'main'
target: 'tiktok_ads_data'
ingestion_definition:
connection_name: tiktok_ads_connection
objects:
- table:
source_schema: '<your_advertiser_id>'
source_table: 'campaign_report_daily'
destination_catalog: 'main'
destination_schema: 'tiktok_ads_data'
destination_table: 'campaign_report_daily'

Arquivo de definição de tarefas do Declarative Automation Bundles​

YAML
resources:
jobs:
tiktok_ads_job:
name: tiktok_ads_job
schedule:
quartz_cron_expression: '0 0 0 * * ?'
timezone_id: 'UTC'
tasks:
- task_key: tiktok_ads_ingestion
pipeline_task:
pipeline_id: ${resources.pipelines.tiktok_ads_pipeline.id}

Relatórios pré-criados e personalizados​

Além dos objetos padrão do TikTok Ads, é possível ingerir relatórios predefinidos e definir relatórios personalizados.

Ingerir um relatório pré-construído​

Defina source_table como o nome do relatório. O conector usa um esquema fixo para cada relatório pré-construído.

JSON
{
"ingestion_definition": {
"connection_name": "<connection-name>",
"objects": [
{
"table": {
"source_schema": "<your-ad-account-id>",
"source_table": "ad_report_daily",
"destination_catalog": "<destination-catalog>",
"destination_schema": "<destination-schema>"
}
}
]
}
}

Para a lista completa de relatórios predefinidos e seus esquemas, consulte Relatórios predefinidos.

Ingerir um relatório personalizado​

Defina source_table como custom_report e forneça custom_report_options em connector_options.tiktok_ads_options. destination_table é obrigatório para relatórios personalizados.

JSON
{
"ingestion_definition": {
"connection_name": "<connection-name>",
"objects": [
{
"table": {
"source_schema": "<your-ad-account-id>",
"source_table": "custom_report",
"destination_catalog": "<destination-catalog>",
"destination_schema": "<destination-schema>",
"destination_table": "my_custom_report",
"connector_options": {
"tiktok_ads_options": {
"lookback_window_days": 7,
"sync_start_date": "2024-01-01",
"custom_report_options": {
"dimensions": ["stat_time_day", "ad_id"],
"metrics": ["spend", "impressions", "clicks"],
"report_type": "BASIC",
"data_level": "AUCTION_AD",
"query_lifetime": false
}
}
}
}
}
]
}
}

Para detalhes de custom_report_options, consulte Relatórios personalizados.

Padrões comuns​

Para configurações avançadas pipeline , consulte Padrões comuns para gerenciar pipeline de ingestão.

Próximos passos​

começar, programar e definir alerta em seu pipeline. Consulte Tarefa comum de manutenção pipeline.

Recursos adicionais​