LinkedIn Ads connector reference

info

Beta

Esse recurso está em Beta. Os administradores do workspace podem controlar o acesso a esse recurso na página Pré-visualizações . Consulte Gerenciar prévias do Databricks.

This page provides reference information for the managed LinkedIn Ads connector in Lakeflow Connect, including supported tables, column definitions, and data types.

Tabelas suportadas

O conector LinkedIn Ads suporta doze tabelas em duas categorias:

Tabelas de entidades: dados de configuração sobre suas contas de anúncio, como campanhas e criativos. Essas tabelas são totalmente atualizadas a cada atualização do pipeline.
Tabelas de relatório pré-criadas: métricas de desempenho e demográficas do endpoint adAnalytics do LinkedIn. Estas tabelas oferecem suporte à ingestão incremental.

Cada tabela reside no espaço de nomes default ou em um espaço de nomes por account nomeado de acordo com o ID da account de anúncio patrocinada. Consulte Espaços de nomes de origem.

Tabelas de entidades

Nome da tabela	Namespace	Chave primária	Descrição
`account_history`	`default`	`id`	Contas de anúncio patrocinado que o token de autorização pode alcançar.
`campaign_group_history`	Per-account	`id`	Grupos de campanha, incluindo configurações de orçamento e objetivo.
`campaign_history`	Per-account	`id`	Campanhas, incluindo critérios de segmentação, orçamentos e programação de execução.
`creative_history`	Per-account	`id`	Criativos, incluindo conteúdo e status de revisão.
`account_user_history`	Per-account	`account`, `user`	Per-user roles on the ad account.

Nome da tabela	Namespace	Chave primária	Descrição
`account_history`	`default`	`id`	Contas de anúncio patrocinado que o token de autorização pode alcançar.
`campaign_group_history`	Per-account	`id`	Grupos de campanha, incluindo configurações de orçamento e objetivo.
`campaign_history`	Per-account	`id`	Campanhas, incluindo critérios de segmentação, orçamentos e programação de execução.
`creative_history`	Per-account	`id`	Criativos, incluindo conteúdo e status de revisão.
`account_user_history`	Per-account	`account`, `user`	Per-user roles on the ad account.

Tabelas de relatório pré-criadas

Todos os sete relatórios são por account e oferecem suporte à ingestão incremental.

Nome da tabela	Granularidade	Chave primária	Pivot
`ad_analytics_by_campaign_report`	Diário	`campaign_id`, `day`	`CAMPAIGN`
`ad_analytics_by_creative_report`	Diário	`creative_id`, `day`	`CREATIVE`
`monthly_ad_analytics_by_member_company_size_report`	Mensal	`campaign_id`, `member_company_size`, `month`	`MEMBER_COMPANY_SIZE`
`monthly_ad_analytics_by_member_country_report`	Mensal	`campaign_id`, `member_country`, `month`	`MEMBER_COUNTRY_V2`
`monthly_ad_analytics_by_member_industry_report`	Mensal	`campaign_id`, `member_industry`, `month`	`MEMBER_INDUSTRY`
`monthly_ad_analytics_by_member_job_function_report`	Mensal	`campaign_id`, `member_job_function`, `month`	`MEMBER_JOB_FUNCTION`
`monthly_ad_analytics_by_member_seniority_report`	Mensal	`campaign_id`, `member_seniority`, `month`	`MEMBER_SENIORITY`

Nome da tabela	Granularidade	Chave primária	Pivot
`ad_analytics_by_campaign_report`	Diário	`campaign_id`, `day`	`CAMPAIGN`
`ad_analytics_by_creative_report`	Diário	`creative_id`, `day`	`CREATIVE`
`monthly_ad_analytics_by_member_company_size_report`	Mensal	`campaign_id`, `member_company_size`, `month`	`MEMBER_COMPANY_SIZE`
`monthly_ad_analytics_by_member_country_report`	Mensal	`campaign_id`, `member_country`, `month`	`MEMBER_COUNTRY_V2`
`monthly_ad_analytics_by_member_industry_report`	Mensal	`campaign_id`, `member_industry`, `month`	`MEMBER_INDUSTRY`
`monthly_ad_analytics_by_member_job_function_report`	Mensal	`campaign_id`, `member_job_function`, `month`	`MEMBER_JOB_FUNCTION`
`monthly_ad_analytics_by_member_seniority_report`	Mensal	`campaign_id`, `member_seniority`, `month`	`MEMBER_SENIORITY`

Convenções de tipo de dados

The following conventions apply across all destination tables:

Todas as colunas permitem valores nulos, exceto as colunas de chave primária.
createdAt e lastModifiedAt são os Timestamp de auditoria do LinkedIn, ingeridos como valores de long em milissegundos de época em vez de como Timestamp.
targetingCriteria, content, and inlineContent are ingested as variant columns. The connector enables Delta's Variant table feature on the tables that carry them.
Money columns are decimal and are denominated in the currency named by the column. For example, cost_in_usd is in US dollars and cost_in_local_currency is in the ad account's currency.

Entity table schemas

`account_history`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`name`	`string`
`currency`	`string`
`type`	`string`
`status`	`string`
`reference`	`string`
`servingStatuses`	`array<string>`
`notifiedOnCampaignOptimization`	`boolean`
`notifiedOnCreativeApproval`	`boolean`
`notifiedOnCreativeRejection`	`boolean`
`notifiedOnEndOfCampaign`	`boolean`
`notifiedOnNewFeaturesEnabled`	`boolean`
`test`	`boolean`
`version`	`struct<versionTag: string>`
`createdAt`	`long`
`lastModifiedAt`	`long`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`name`	`string`
`currency`	`string`
`type`	`string`
`status`	`string`
`reference`	`string`
`servingStatuses`	`array<string>`
`notifiedOnCampaignOptimization`	`boolean`
`notifiedOnCreativeApproval`	`boolean`
`notifiedOnCreativeRejection`	`boolean`
`notifiedOnEndOfCampaign`	`boolean`
`notifiedOnNewFeaturesEnabled`	`boolean`
`test`	`boolean`
`version`	`struct<versionTag: string>`
`createdAt`	`long`
`lastModifiedAt`	`long`

`campaign_group_history`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`account`	`string`
`name`	`string`
`status`	`string`
`objectiveType`	`string`
`allowedCampaignTypes`	`array<string>`
`servingStatuses`	`array<string>`
`runSchedule`	`struct<start: long, end: long>`
`totalBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`dailyBudget`	`decimal(19,2)`
`budgetOptimization`	`struct<bidStrategy: string, budgetOptimizationStrategy: string>`
`backfilled`	`boolean`
`test`	`boolean`
`createdAt`	`long`
`lastModifiedAt`	`long`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`account`	`string`
`name`	`string`
`status`	`string`
`objectiveType`	`string`
`allowedCampaignTypes`	`array<string>`
`servingStatuses`	`array<string>`
`runSchedule`	`struct<start: long, end: long>`
`totalBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`dailyBudget`	`decimal(19,2)`
`budgetOptimization`	`struct<bidStrategy: string, budgetOptimizationStrategy: string>`
`backfilled`	`boolean`
`test`	`boolean`
`createdAt`	`long`
`lastModifiedAt`	`long`

nota

On this table, dailyBudget is a bare decimal(19,2) rather than a money struct. On campaign_history, the same column name is a struct<amount, currencyCode>. This asymmetry reflects the shape LinkedIn's API returns for each resource.

`campaign_history`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`account`	`string`
`campaignGroup`	`string`
`associatedEntity`	`string`
`name`	`string`
`type`	`string`
`status`	`string`
`costType`	`string`
`format`	`string`
`objectiveType`	`string`
`optimizationTargetType`	`string`
`creativeSelection`	`string`
`pacingStrategy`	`string`
`politicalIntent`	`string`
`audienceExpansionEnabled`	`boolean`
`offsiteDeliveryEnabled`	`boolean`
`connectedTelevisionOnly`	`boolean`
`test`	`boolean`
`servingStatuses`	`array<string>`
`locale`	`struct<country: string, language: string>`
`offsitePreferences`	`struct<iabCategories: array<string>, publisherRestrictionFiles: array<string>>`
`runSchedule`	`struct<start: long, end: long>`
`dailyBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`totalBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`unitCost`	`struct<amount: decimal(19,2), currencyCode: string>`
`targetingCriteria`	`variant`
`version`	`struct<versionTag: string>`
`createdAt`	`long`
`lastModifiedAt`	`long`

Coluna	Tipo Spark
`id`	`long` (chave primária)
`account`	`string`
`campaignGroup`	`string`
`associatedEntity`	`string`
`name`	`string`
`type`	`string`
`status`	`string`
`costType`	`string`
`format`	`string`
`objectiveType`	`string`
`optimizationTargetType`	`string`
`creativeSelection`	`string`
`pacingStrategy`	`string`
`politicalIntent`	`string`
`audienceExpansionEnabled`	`boolean`
`offsiteDeliveryEnabled`	`boolean`
`connectedTelevisionOnly`	`boolean`
`test`	`boolean`
`servingStatuses`	`array<string>`
`locale`	`struct<country: string, language: string>`
`offsitePreferences`	`struct<iabCategories: array<string>, publisherRestrictionFiles: array<string>>`
`runSchedule`	`struct<start: long, end: long>`
`dailyBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`totalBudget`	`struct<amount: decimal(19,2), currencyCode: string>`
`unitCost`	`struct<amount: decimal(19,2), currencyCode: string>`
`targetingCriteria`	`variant`
`version`	`struct<versionTag: string>`
`createdAt`	`long`
`lastModifiedAt`	`long`

`creative_history`

Coluna	Tipo Spark
`id`	`string` (chave primária)
`account`	`string`
`campaign`	`string`
`name`	`string`
`intendedStatus`	`string`
`isServing`	`boolean`
`isTest`	`boolean`
`servingHoldReasons`	`array<string>`
`content`	`variant`
`inlineContent`	`variant`
`review`	`struct<status: string, rejectionReasons: array<string>>`
`leadgenCallToAction`	`struct<destination: string, label: string>`
`createdBy`	`string`
`lastModifiedBy`	`string`
`createdAt`	`long`
`lastModifiedAt`	`long`

Coluna	Tipo Spark
`id`	`string` (chave primária)
`account`	`string`
`campaign`	`string`
`name`	`string`
`intendedStatus`	`string`
`isServing`	`boolean`
`isTest`	`boolean`
`servingHoldReasons`	`array<string>`
`content`	`variant`
`inlineContent`	`variant`
`review`	`struct<status: string, rejectionReasons: array<string>>`
`leadgenCallToAction`	`struct<destination: string, label: string>`
`createdBy`	`string`
`lastModifiedBy`	`string`
`createdAt`	`long`
`lastModifiedAt`	`long`

`account_user_history`

Coluna	Tipo Spark
`account`	`string` (chave primária)
`user`	`string` (chave primária)
`role`	`string`
`createdAt`	`long`
`lastModifiedAt`	`long`

Report table schemas

Cada relatório contém as mesmas 114 colunas de métricas, além de suas próprias colunas de key principais. As colunas de métricas são todas anuláveis, porque o LinkedIn omite linhas com todos os zeros e deixa as métricas ausentes como nulas.

All seven reports carry a _sync_timestamp column, which is part of each report's cursor. LinkedIn revises a period's metrics in place as late conversions arrive, so a re-fetched row keeps the same day or month. Without a strictly increasing companion value, the destination MERGE would treat the revision as unchanged and drop it. The timestamp advances on every update, so the newer version always wins.

Relatórios diários

Cada relatório diário contém exatamente uma coluna de entidade, nomeada de acordo com a dimensão na qual ela é dinamizada.

Coluna	Tipo Spark	Notas
Coluna de entidade	`long` (chave primária)	O valor de pivot. Consulte a tabela a seguir.
`day`	`string` (chave primária)	ISO date, `yyyy-MM-dd`.
`_sync_timestamp`	`timestamp`	Gerado pelo conector em cada atualização.
114 colunas de métricas	`long`, `decimal`, or `double`

Coluna	Tipo Spark	Notas
Coluna de entidade	`long` (chave primária)	O valor de pivot. Consulte a tabela a seguir.
`day`	`string` (chave primária)	ISO date, `yyyy-MM-dd`.
`_sync_timestamp`	`timestamp`	Gerado pelo conector em cada atualização.
114 colunas de métricas	`long`, `decimal`, or `double`

Relatório	Coluna de entidade	Tipo Spark	Value form
`ad_analytics_by_campaign_report`	`campaign_id`	`long`	ID simples do URN de pivot.
`ad_analytics_by_creative_report`	`creative_id`	`long`	ID simples do URN de pivot.

Relatório	Coluna de entidade	Tipo Spark	Value form
`ad_analytics_by_campaign_report`	`campaign_id`	`long`	ID simples do URN de pivot.
`ad_analytics_by_creative_report`	`creative_id`	`long`	ID simples do URN de pivot.

Relatórios mensais de dados demográficos de membros

Each demographic report carries exactly one member column, named after the dimension it pivots on.

Coluna	Tipo Spark	Notas
`campaign_id`	`long` (chave primária)	Atribuído a partir da campanha que o conector consultou.
Coluna de dimensão de membro	`long` ou `string` (chave primária)	O valor de pivot. Consulte a tabela a seguir.
`month`	`string` (chave primária)	Zero-padded year and month, `yyyy-MM`.
`_sync_timestamp`	`timestamp`	Gerado pelo conector em cada atualização.
114 colunas de métricas	`long`, `decimal`, or `double`

Coluna	Tipo Spark	Notas
`campaign_id`	`long` (chave primária)	Atribuído a partir da campanha que o conector consultou.
Coluna de dimensão de membro	`long` ou `string` (chave primária)	O valor de pivot. Consulte a tabela a seguir.
`month`	`string` (chave primária)	Zero-padded year and month, `yyyy-MM`.
`_sync_timestamp`	`timestamp`	Gerado pelo conector em cada atualização.
114 colunas de métricas	`long`, `decimal`, or `double`

Relatório	Coluna de membro	Tipo Spark	Value form
`monthly_ad_analytics_by_member_company_size_report`	`member_company_size`	`string`	Enum literal, como `SIZE_11_TO_50`.
`monthly_ad_analytics_by_member_country_report`	`member_country`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_industry_report`	`member_industry`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_job_function_report`	`member_job_function`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_seniority_report`	`member_seniority`	`long`	ID simples do URN de pivot.

Relatório	Coluna de membro	Tipo Spark	Value form
`monthly_ad_analytics_by_member_company_size_report`	`member_company_size`	`string`	Enum literal, como `SIZE_11_TO_50`.
`monthly_ad_analytics_by_member_country_report`	`member_country`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_industry_report`	`member_industry`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_job_function_report`	`member_job_function`	`long`	ID simples do URN de pivot.
`monthly_ad_analytics_by_member_seniority_report`	`member_seniority`	`long`	ID simples do URN de pivot.

Colunas de métricas

Todos os sete relatórios retornam o mesmo conjunto de métricas. Os nomes das colunas são renomeações em snake_case dos nomes de métricas em camelCase do LinkedIn. Por exemplo, costInLocalCurrency torna-se cost_in_local_currency. A tabela a seguir agrupa as métricas por tema:

Grupo	Colunas de exemplo
Desempenho essencial	`impressions`, `clicks`, `cost_in_local_currency`, `cost_in_usd`, `approximate_member_reach`, `audience_penetration`
Engajamento	`likes`, `comments`, `shares`, `reactions`, `follows`, `total_engagements`, `other_engagements`, `comment_likes`
Cliques por superfície	`landing_page_clicks`, `company_page_clicks`, `text_url_clicks`, `headline_clicks`, `card_clicks`, `ad_unit_clicks`, `action_clicks`, `download_clicks`, `subscription_clicks`
Vídeo	`video_views`, `video_starts`, `video_completions`, `video_first_quartile_completions`, `video_midpoint_completions`, `video_third_quartile_completions`, `video_watch_time`, `average_video_watch_time`
Eventos	`event_views`, `event_views_over_15_seconds`, `event_views_over_30_seconds`, `event_views_over_2_minutes`, `event_watch_time`, `cost_per_event_view`
Documentos	`document_completions`, `document_first_quartile_completions`, `document_midpoint_completions`, `document_third_quartile_completions`
Leads, registrations, and jobs	`one_click_leads`, `one_click_lead_form_opens`, `qualified_leads`, `cost_per_qualified_lead`, `valid_work_email_leads`, `talent_leads`, `registrations`, `post_click_registrations`, `post_view_registrations`, `post_click_job_applications`, `post_view_job_apply_clicks`
Conversions	`external_website_conversions`, `conversion_value_in_local_currency`
Viral	Cada contraparte com prefixo `viral_`das métricas acima, como `viral_impressions`, `viral_clicks`, `viral_likes`, `viral_video_views` e `viral_one_click_leads`

Grupo	Colunas de exemplo
Desempenho essencial	`impressions`, `clicks`, `cost_in_local_currency`, `cost_in_usd`, `approximate_member_reach`, `audience_penetration`
Engajamento	`likes`, `comments`, `shares`, `reactions`, `follows`, `total_engagements`, `other_engagements`, `comment_likes`
Cliques por superfície	`landing_page_clicks`, `company_page_clicks`, `text_url_clicks`, `headline_clicks`, `card_clicks`, `ad_unit_clicks`, `action_clicks`, `download_clicks`, `subscription_clicks`
Vídeo	`video_views`, `video_starts`, `video_completions`, `video_first_quartile_completions`, `video_midpoint_completions`, `video_third_quartile_completions`, `video_watch_time`, `average_video_watch_time`
Eventos	`event_views`, `event_views_over_15_seconds`, `event_views_over_30_seconds`, `event_views_over_2_minutes`, `event_watch_time`, `cost_per_event_view`
Documentos	`document_completions`, `document_first_quartile_completions`, `document_midpoint_completions`, `document_third_quartile_completions`
Leads, registrations, and jobs	`one_click_leads`, `one_click_lead_form_opens`, `qualified_leads`, `cost_per_qualified_lead`, `valid_work_email_leads`, `talent_leads`, `registrations`, `post_click_registrations`, `post_view_registrations`, `post_click_job_applications`, `post_view_job_apply_clicks`
Conversions	`external_website_conversions`, `conversion_value_in_local_currency`
Viral	Cada contraparte com prefixo `viral_`das métricas acima, como `viral_impressions`, `viral_clicks`, `viral_likes`, `viral_video_views` e `viral_one_click_leads`

Rates and durations are double and counts are long. For the authoritative meaning of each metric, see LinkedIn's Ads Reporting schema.

Opções de configuração de relatório

Configure relatórios por tabela por meio de connector_options.linkedin_ads_options:

Opção	Padrão	Bounds	Propósito
`sync_start_date`	Dois anos antes de hoje	Must not be in the future, and must not be older than the report's retention horizon	The first date the initial update fetches
`lookback_window_days`	`7`	`0` to `365`	Até onde cada atualização incremental retrocede na leitura para capturar revisões

Opção	Padrão	Bounds	Propósito
`sync_start_date`	Dois anos antes de hoje	Must not be in the future, and must not be older than the report's retention horizon	The first date the initial update fetches
`lookback_window_days`	`7`	`0` to `365`	Até onde cada atualização incremental retrocede na leitura para capturar revisões

Os horizontes de retenção diferem por família de relatório. Estes são os limites do LinkedIn, não os do conector:

Família	Retenção	Effect
Relatórios diários de desempenho	10 years	Uma `sync_start_date` anterior a 10 anos antes de hoje é rejeitada.
Relatórios mensais de dados demográficos dos membros	2 anos	Um `sync_start_date` anterior a 2 anos atrás de hoje é rejeitado.

Família	Retenção	Effect
Relatórios diários de desempenho	10 years	Uma `sync_start_date` anterior a 10 anos antes de hoje é rejeitada.
Relatórios mensais de dados demográficos dos membros	2 anos	Um `sync_start_date` anterior a 2 anos atrás de hoje é rejeitado.

Tabelas suportadas​

Tabelas de entidades​

Tabelas de relatório pré-criadas​

Convenções de tipo de dados​

Entity table schemas​

account_history​

campaign_group_history​

campaign_history​

creative_history​

account_user_history​

Report table schemas​

Relatórios diários​

Relatórios mensais de dados demográficos de membros​

Colunas de métricas​

Opções de configuração de relatório​

Outros recursos​