Integración con TikTok

En esta página, se describen las configuraciones necesarias para importar datos de TikTok como fuente de datos de la carga de trabajo de marketing de la Fundación de datos de Cortex Framework.

TikTok es una app de redes sociales popular conocida por sus videos de formato corto, en la que Cortex Framework puede proporcionar datos para analizar el rendimiento general del marketing. Si combinas datos de TikTok y de varias fuentes, puedes obtener una comprensión más integral de tu público objetivo y la eficacia de tus campañas en redes sociales en diferentes plataformas.

En el siguiente diagrama, se describe cómo los datos de TikTok están disponibles a través de la carga de trabajo de marketing de la base de datos de Cortex Framework:

Fuente de datos de TikTok

Figura 1. Fuente de datos de TikTok.

Archivo de configuración

El archivo config.json configura los parámetros necesarios para conectarse a las fuentes de datos y transferir datos de diversas cargas de trabajo. Este archivo contiene los siguientes parámetros para TikTok:

   "marketing": {
        "deployTikTok": true,
        },
        "TikTok": {
            "deployCDC": true,
            "datasets": {
                "cdc": "",
                "raw": "",
                "reporting": "REPORTING_TikTok"
            }
        }

En la siguiente tabla, se describe el valor de cada parámetro de marketing:

Parámetro Significado Valor predeterminado Descripción
marketing.deployTikTok Implementa TikTok true Ejecuta la implementación de la fuente de datos de TikTok.
marketing.TikTok.deployCDC Implementa secuencias de comandos de CDC para TikTok true Genera secuencias de comandos de procesamiento de CDC de TikTok para ejecutarlas como DAG en Managed Service para Apache Airflow.
marketing.TikTok.datasets.cdc Conjunto de datos de CDC para TikTok Es el conjunto de datos de CDC para TikTok.
marketing.TikTok.datasets.raw Conjunto de datos sin procesar para TikTok Es el conjunto de datos sin procesar de TikTok.
marketing.TikTok.datasets.reporting Conjunto de datos de informes para TikTok "REPORTING_TikTok" Es un conjunto de datos de informes para TikTok.

Modelo de datos

En esta sección, se describe el modelo de datos de TikTok con el diagrama de relación entre entidades (ERD).

Diagrama de relación entre entidades de TikTok

Figura 2: TikTok: Diagrama de relación entre entidades.

Vistas base

Estos son los objetos azules en el DER y son vistas de las tablas de CDC sin transformaciones, excepto algunos alias de nombres de columnas. Consulta las secuencias de comandos en src/marketing/src/TikTok/src/reporting/ddls.

Vistas de informes

Estos son los objetos verdes en el DER y son vistas de informes que contienen métricas agregadas. Consulta las secuencias de comandos en src/marketing/src/TikTok/src/reporting/ddls.

Conexión a la API

Cortex Framework utiliza las APIs de informes de TikTok, versión v1.3, como la fuente autorizada de los datos de TikTok. Cortex Framework usa el modo síncrono y llama a las APIs de Informes básicos para recuperar las métricas de rendimiento de los anuncios y los grupos de anuncios. Esto garantiza que Cortex Framework tenga acceso a información precisa y actualizada de TikTok, lo que permite un análisis de datos y una generación de informes eficaces.

Para obtener más información sobre la conexión de la API, consulta APIs de informes de TikTok.

Autenticación de cuenta

Para configurar una cuenta de TikTok y la autenticación de la cuenta, sigue estos pasos:

  1. Configura una cuenta de desarrollador de TikTok si aún no la tienes.
  2. Crea una app para la integración de Cortex Framework. Consulta la API de TikTok for Business para obtener más información. Asegúrate de seleccionar los siguientes dos permisos para la app:
    • Ad Account Management/Ad Account Information
    • Reporting/All
  3. Obtén el ID de la app, el secreto y el token de acceso a largo plazo como se describe en la guía de TikTok y almacénalos respectivamente en Secret Manager con los siguientes nombres:
    • ID de la app: cortex_tiktok_app_id
    • Secreto: cortex_tiktok_app_secret
    • Token de acceso a largo plazo: cortex_tiktok_access_token

Actualidad y demora de los datos

Como regla general, la actualización de los datos de las fuentes de datos de Cortex Framework está limitada por lo que permite la conexión upstream, así como por la frecuencia de ejecución de tu DAG. Ajusta la frecuencia de ejecución de tu DAG para que coincida con la frecuencia de los procesos ascendentes, las restricciones de recursos y las necesidades de tu empresa.

Con la API de marketing de TikTok, la mayoría de los datos (excepto las conversiones) están disponibles casi en tiempo real.

Conexiones de Managed Airflow

Crea las siguientes conexiones en Managed Airflow. Para obtener más detalles, consulta la documentación sobre cómo administrar conexiones de Airflow.

Nombre de la conexión Purpose
tiktok_raw_dataflow Para la API de TikTok > BigQuery Conjunto de datos sin procesar
tiktok_cdc_bq Para la transferencia de conjuntos de datos sin procesar a conjuntos de datos de CDC
tiktok_reporting_bq Para la transferencia del conjunto de datos de CDC al conjunto de datos de informes

Permisos de la cuenta de servicio de Managed Service para Apache Airflow

Otorga permisos de Dataflow a la cuenta de servicio que se usa en Managed Airflow (como se configuró en la conexión tiktok_raw_dataflow). Consulta las instrucciones en la documentación de Dataflow.

Además, la misma cuenta de servicio también debe tener acceso de descriptor de acceso a Secret Manager.

Configuración de transferencia

Controla las canalizaciones de datos Source to Raw y Raw to CDC a través de la configuración del archivo src/TikTok/config/ingestion_settings.yaml. En esta sección, se describen los parámetros de cada canalización de datos.

De tablas de origen a tablas sin procesar

En esta sección, se incluyen entradas que controlan cómo se recuperan los datos de TikTok y dónde terminan los datos en el conjunto de datos sin procesar. Cada entrada corresponde a una tabla sin procesar que tiene datos recuperados de la API de TikTok para esa entidad. Según estos parámetros de configuración, Cortex Framework crea DAG de Airflow que ejecutan canalizaciones de Dataflow para procesar datos de las APIs de TikTok.

Los siguientes parámetros controlan la configuración de Source to Raw para cada entrada:

Parámetro Descripción
base_table Tabla en el conjunto de datos sin procesar en la que se almacenan los datos de una entidad(por ejemplo, los datos de un "anuncio").
load_frequency Frecuencia con la que se ejecuta un DAG para que esta entidad procese datos. Consulta la documentación de Airflow para obtener detalles sobre los valores posibles.
schema_file Archivo de esquema en el directorio src/table_schema que asigna los campos de respuesta de la API a los nombres de las columnas de la tabla de destino.
partition_details Opcional: Si deseas que esta tabla se particione por motivos de rendimiento. Para obtener más información, consulta Partición de tablas.
cluster_details Opcional: Si deseas que esta tabla se agrupe para tener en cuenta el rendimiento. Para obtener más información, consulta Configuración del clúster.

Tablas sin procesar a CDC

En esta sección, se incluyen entradas que controlan cómo se transfieren los datos de las tablas sin procesar a las tablas de CDC. Cada entrada corresponde a una tabla de CDC (que, a su vez, corresponde a una entidad mencionada para Source to Raw table).

Los siguientes parámetros controlan la configuración de Raw to CDC para cada entrada:

Parámetro Descripción
base_table Tabla en el conjunto de datos de CDC en la que se almacenan los datos sin procesar después de la transformación de CDC (por ejemplo,auction_ad_performance)
load_frequency Frecuencia con la que se ejecuta un DAG para esta entidad con el objetivo de completar la tabla del CDC. Para obtener más información, consulta la documentación de Airflow para conocer los detalles sobre los valores posibles.
row_identifiers Lista de columnas (separadas por comas) que forman un registro único para esta tabla.
partition_details Opcional: Si deseas que esta tabla se particione por motivos de rendimiento. Para obtener más información, consulta Partición de tablas.
cluster_details Opcional: Si deseas que esta tabla se agrupe para tener en cuenta el rendimiento. Para obtener más información, consulta Configuración del clúster.

Configuración de informes

Configura y controla cómo Cortex Framework genera datos para la capa de informes final de TikTok con el archivo de configuración de informessrc/TikTok/config/reporting_settings.yaml. Este archivo controla cómo se generan los objetos de BigQuery de la capa de informes (tablas, vistas, funciones o procedimientos almacenados).

Para obtener más información, consulta Cómo personalizar el archivo de configuración de informes.

Próximos pasos