LinkedIn Ads

LinkedIn is a social networking site designed for the business community. You can use LinkedIn Ads to promote your brand, increase traffic, find new leads and more.

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

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

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

Make sure that the account you use has read access to the tables you want to fetch.

Creating the connection

For more information, see Connecting to SaaS applications.

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.
Tip noteYou 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	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Accounts	A comma separated list of accounts to sync.
Client ID	Client ID.
Client Secret	Client secret.

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 2.

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

account_users

The account_users table contains info about the users who have permissions to an ad account.

Replication Method	CDC
Primary Keys	account_id user_person_id
Replication Key	last_modified_time
Useful links	LinkedIn Ads API method

Join account_users with	on
accounts	account_users.account_id = accounts.id
campaigns	account_users.account_id = campaigns.account_id
campaign_groups	account_users.account_id = campaign_groups.account_id
video_ads	account_users.account_id = video_ads.account_id

account

STRING

account_id

INTEGER

campaign_contact

BOOLEAN

change_audit_stamps

OBJECT

This is a nested data structure:

created: OBJECT, which is also a nested data structure.
- time: DATE-TIME
last_modified: OBJECT, which is also a nested data structure.
- time: DATE-TIME

created_time

DATE-TIME

last_modified_time

DATE-TIME

role

STRING

user

STRING

user_person_id

STRING

accounts

The accounts table contains info about your LinkedIn Ads ad accounts.

Replication Method	CDC
Primary Key	id
Replication Key	last_modified_time
Useful links	LinkedIn Ads API method

Join accounts with	on
account_users	accounts.id = account_users.account_id
campaigns	accounts.id = campaigns.account_id
campaign_groups	accounts.id = campaign_groups.account_id
video_ads	accounts.id = video_ads.account_id

change_audit_stamps

OBJECT

This is a nested data structure:

created: OBJECT, which is also a nested data structure.
- time: DATE-TIME
last_modified: OBJECT, which is also a nested data structure.
- time: DATE-TIME

created_time

DATE-TIME

currency

STRING

INTEGER

last_modified_time

DATE-TIME

name

STRING

notified_on_campaign_optimization

BOOLEAN

notified_on_creative_approval

BOOLEAN

notified_on_creative_rejection

BOOLEAN

notified_on_end_of_campaign

BOOLEAN

notified_on_new_features_enabled

BOOLEAN

reference

STRING

reference_organization_id

INTEGER

reference_person_id

STRING

serving_statuses

ARRAY

This is a nested data structure.

status

STRING

test

BOOLEAN

total_budget

OBJECT

This is a nested data structure:

amount: NUMBER
currency_code: STRING

total_budget_ends_at

DATE-TIME

type

STRING

version

OBJECT

This is a nested data structure:

version_tag: STRING

ad_analytics_by_campaign

The ad_analytics_by_campaign table contains analytics data for ads, segmented by campaign.

Note: This table is replicated using an attribution window of 7 days. Refer to the Replication section for more info.

Replication Method	CDC
Primary Keys	campaign_id start_at
Replication Key	end_at
Useful links	LinkedIn Ads API method

Join ad_analytics_by_campaign with	on
campaigns	ad_analytics_by_campaign.campaign_id = campaigns.id
creatives	ad_analytics_by_campaign.campaign_id = creatives.campaign_id

action_clicks

INTEGER

ad_unit_clicks

INTEGER

approximate_unique_impressions

INTEGER

average_daily_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

average_previous_seven_day_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

average_previous_thirty_day_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

campaign

STRING

campaign_id

INTEGER

card_clicks

INTEGER

card_impressions

INTEGER

clicks

INTEGER

comment_likes

INTEGER

comments

INTEGER

company_page_clicks

INTEGER

conversion_value_in_local_currency

NUMBER

cost_in_local_currency

NUMBER

cost_in_usd

NUMBER

date_range

OBJECT

This is a nested data structure:

end: OBJECT, which is also a nested data structure.
- day: INTEGER
- month: INTEGER
- year: INTEGER
start: OBJECT, which is also a nested data structure.
- day: INTEGER
- month: INTEGER
- year: INTEGER

document_completions

INTEGER

document_first_quartile_completions

INTEGER

document_midpoint_completions

INTEGER

document_third_quartile_completions

INTEGER

download_clicks

INTEGER

end_at

DATE-TIME

external_website_conversions

INTEGER

external_website_post_click_conversions

INTEGER

external_website_post_view_conversions

INTEGER

follows

INTEGER

full_screen_plays

INTEGER

impressions

INTEGER

job_applications

NUMBER

job_apply_clicks

NUMBER

landing_page_clicks

INTEGER

lead_generation_mail_contact_info_shares

INTEGER

lead_generation_mail_interested_clicks

INTEGER

likes

INTEGER

one_click_lead_form_opens

INTEGER

one_click_leads

INTEGER

opens

INTEGER

other_engagements

INTEGER

pivot

STRING

pivot_value

STRING

pivot_values

ARRAY

This is a nested data structure.

post_click_job_applications

NUMBER

post_click_job_apply_clicks

NUMBER

post_click_registrations

NUMBER

post_view_job_applications

NUMBER

post_view_job_apply_clicks

NUMBER

post_view_registrations

NUMBER

reactions

INTEGER

registrations

NUMBER

sends

INTEGER

shares

INTEGER

start_at

DATE-TIME

talent_leads

INTEGER

text_url_clicks

INTEGER

total_engagements

INTEGER

video_completions

INTEGER

video_first_quartile_completions

INTEGER

video_midpoint_completions

INTEGER

video_starts

INTEGER

video_third_quartile_completions

INTEGER

video_views

INTEGER

viral_card_clicks

INTEGER

viral_card_impressions

INTEGER

viral_clicks

INTEGER

viral_comment_likes

INTEGER

viral_comments

INTEGER

viral_company_page_clicks

INTEGER

viral_document_completions

INTEGER

viral_document_first_quartile_completions

INTEGER

viral_document_midpoint_completions

INTEGER

viral_document_third_quartile_completions

INTEGER

viral_download_clicks

INTEGER

viral_external_website_conversions

INTEGER

viral_external_website_post_click_conversions

INTEGER

viral_external_website_post_view_conversions

INTEGER

viral_follows

INTEGER

viral_full_screen_plays

INTEGER

viral_impressions

INTEGER

viral_job_applications

NUMBER

viral_job_apply_clicks

NUMBER

viral_landing_page_clicks

INTEGER

viral_likes

INTEGER

viral_one_click_lead_form_opens

INTEGER

viral_one_click_leads

INTEGER

viral_other_engagements

INTEGER

viral_post_click_job_applications

NUMBER

viral_post_click_job_apply_clicks

NUMBER

viral_post_click_registrations

NUMBER

viral_post_view_job_applications

NUMBER

viral_post_view_job_apply_clicks

NUMBER

viral_post_view_registrations

NUMBER

viral_reactions

INTEGER

viral_registrations

NUMBER

viral_shares

INTEGER

viral_total_engagements

INTEGER

viral_video_completions

INTEGER

viral_video_first_quartile_completions

INTEGER

viral_video_midpoint_completions

INTEGER

viral_video_starts

INTEGER

viral_video_third_quartile_completions

INTEGER

viral_video_views

INTEGER

ad_analytics_by_creative

The ad_analytics_by_creative table contains info about ad analytics, segmented by creative.

Note: This table is replicated using an attribution window of 7 days. Refer to the Replication section for more info.

Replication Method	CDC
Primary Keys	creative_id start_at
Replication Key	end_at
Useful links	LinkedIn Ads API method

Join ad_analytics_by_creative with	on
creatives	ad_analytics_by_creative.creative_id = creatives.id

action_clicks

INTEGER

ad_unit_clicks

INTEGER

approximate_unique_impressions

INTEGER

average_daily_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

average_previous_seven_day_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

average_previous_thirty_day_reach_metrics

OBJECT

This is a nested data structure:

approximate_cost_in_currency_per_thousand_members_reached: NUMBER
approximate_frequency: NUMBER
approximate_reach: NUMBER

card_clicks

INTEGER

card_impressions

INTEGER

clicks

INTEGER

comment_likes

INTEGER

comments

INTEGER

company_page_clicks

INTEGER

conversion_value_in_local_currency

NUMBER

cost_in_local_currency

NUMBER

cost_in_usd

NUMBER

creative

STRING

creative_id

INTEGER

date_range

OBJECT

This is a nested data structure:

end: OBJECT, which is also a nested data structure.
- day: INTEGER
- month: INTEGER
- year: INTEGER
start: OBJECT, which is also a nested data structure.
- day: INTEGER
- month: INTEGER
- year: INTEGER

document_completions

INTEGER

document_first_quartile_completions

INTEGER

document_midpoint_completions

INTEGER

document_third_quartile_completions

INTEGER

download_clicks

INTEGER

end_at

DATE-TIME

external_website_conversions

INTEGER

external_website_post_click_conversions

INTEGER

external_website_post_view_conversions

INTEGER

follows

INTEGER

full_screen_plays

INTEGER

impressions

INTEGER

job_applications

NUMBER

job_apply_clicks

NUMBER

landing_page_clicks

INTEGER

lead_generation_mail_contact_info_shares

INTEGER

lead_generation_mail_interested_clicks

INTEGER

likes

INTEGER

one_click_lead_form_opens

INTEGER

one_click_leads

INTEGER

opens

INTEGER

other_engagements

INTEGER

pivot

STRING

pivot_value

STRING

pivot_values

ARRAY

This is a nested data structure.

post_click_job_applications

NUMBER

post_click_job_apply_clicks

NUMBER

post_click_registrations

NUMBER

post_view_job_applications

NUMBER

post_view_job_apply_clicks

NUMBER

post_view_registrations

NUMBER

reactions

INTEGER

registrations

NUMBER

sends

INTEGER

shares

INTEGER

start_at

DATE-TIME

talent_leads

INTEGER

text_url_clicks

INTEGER

total_engagements

INTEGER

video_completions

INTEGER

video_first_quartile_completions

INTEGER

video_midpoint_completions

INTEGER

video_starts

INTEGER

video_third_quartile_completions

INTEGER

video_views

INTEGER

viral_card_clicks

INTEGER

viral_card_impressions

INTEGER

viral_clicks

INTEGER

viral_comment_likes

INTEGER

viral_comments

INTEGER

viral_company_page_clicks

INTEGER

viral_document_completions

INTEGER

viral_document_first_quartile_completions

INTEGER

viral_document_midpoint_completions

INTEGER

viral_document_third_quartile_completions

INTEGER

viral_download_clicks

INTEGER

viral_external_website_conversions

INTEGER

viral_external_website_post_click_conversions

INTEGER

viral_external_website_post_view_conversions

INTEGER

viral_follows

INTEGER

viral_full_screen_plays

INTEGER

viral_impressions

INTEGER

viral_job_applications

NUMBER

viral_job_apply_clicks

NUMBER

viral_landing_page_clicks

INTEGER

viral_likes

INTEGER

viral_one_click_lead_form_opens

INTEGER

viral_one_click_leads

INTEGER

viral_other_engagements

INTEGER

viral_post_click_job_applications

NUMBER

viral_post_click_job_apply_clicks

NUMBER

viral_post_click_registrations

NUMBER

viral_post_view_job_applications

NUMBER

viral_post_view_job_apply_clicks

NUMBER

viral_post_view_registrations

NUMBER

viral_reactions

INTEGER

viral_registrations

INTEGER

viral_shares

INTEGER

viral_total_engagements

INTEGER

viral_video_completions

INTEGER

viral_video_first_quartile_completions

INTEGER

viral_video_midpoint_completions

INTEGER

viral_video_starts

INTEGER

viral_video_third_quartile_completions

INTEGER

viral_video_views

INTEGER

campaign_groups

The campaign_groups table contains info about the campaign groups in your LinkedIn Ads account.

Replication Method	CDC
Primary Key	id
Replication Key	last_modified_time
Useful links	LinkedIn Ads API method

Join campaign_groups with	on
account_users	campaign_groups.account_id = account_users.account_id
accounts	campaign_groups.account_id = accounts.id
campaigns	campaign_groups.account_id = campaigns.account_id campaign_groups.id = campaigns.campaign_group_id
video_ads	campaign_groups.account_id = video_ads.account_id

account

STRING

account_id

INTEGER

allowed_campaign_types

ARRAY

This is a nested data structure.

backfilled

BOOLEAN

change_audit_stamps

OBJECT

This is a nested data structure:

created: OBJECT, which is also a nested data structure.
- time: DATE-TIME
last_modified: OBJECT, which is also a nested data structure.
- time: DATE-TIME

created_time

DATE-TIME

INTEGER

last_modified_time

DATE-TIME

name

STRING

run_schedule

OBJECT

This is a nested data structure:

end: DATE-TIME
start: DATE-TIME

serving_statuses

ARRAY

This is a nested data structure.

status

STRING

test

BOOLEAN

total_budget

OBJECT

This is a nested data structure:

amount: NUMBER
currency_code: STRING

campaigns

The campaigns table contains info about the campaigns in your LinkedIn Ads account.

Replication Method	CDC
Primary Key	id
Replication Key	last_modified_time
Useful links	LinkedIn Ads API method

Join campaigns with	on
account_users	campaigns.account_id = account_users.account_id
accounts	campaigns.account_id = accounts.id
campaign_groups	campaigns.account_id = campaign_groups.account_id campaigns.campaign_group_id = campaign_groups.id
video_ads	campaigns.account_id = video_ads.account_id
creatives	campaigns.id = creatives.campaign_id
ad_analytics_by_campaign	campaigns.id = ad_analytics_by_campaign.campaign_id

account

STRING

account_id

INTEGER

associated_entity

STRING

associated_entity_organization_id

INTEGER

associated_entity_person_id

STRING

audience_expansion_enabled

BOOLEAN

campaign_group

STRING

campaign_group_id

INTEGER

change_audit_stamps

OBJECT

This is a nested data structure:

created: OBJECT, which is also a nested data structure.
- time: DATE-TIME
last_modified: OBJECT, which is also a nested data structure.
- time: DATE-TIME

cost_type

STRING

created_time

DATE-TIME

creative_selection

STRING

daily_budget

OBJECT

This is a nested data structure:

amount: NUMBER
currency_code: STRING

format

STRING

INTEGER

last_modified_time

DATE-TIME

locale

OBJECT

This is a nested data structure:

country: STRING
language: STRING

name

STRING

objective_type

STRING

offsite_delivery_enabled

BOOLEAN

offsite_preferences

OBJECT

This is a nested data structure:

iab_categories: OBJECT, which is also a nested data structure.
- exclude: ARRAY, which is also a nested data structure.
- include: ARRAY, which is also a nested data structure.
publisher_restriction_files: OBJECT, which is also a nested data structure.
- exclude: ARRAY, which is also a nested data structure.

optimization_target_type

STRING

pacing_strategy

STRING

run_schedule

OBJECT

This is a nested data structure:

end: DATE-TIME
start: DATE-TIME

serving_statuses

ARRAY

This is a nested data structure.

status

STRING

targeting

OBJECT

This is a nested data structure:

excluded_targeting_facets: ARRAY, which is also a nested data structure.
- type: STRING
- values: ARRAY, which is also a nested data structure.
included_targeting_facets: ARRAY, which is also a nested data structure.
- type: STRING
- values: ARRAY, which is also a nested data structure.

targeting_criteria

OBJECT

This is a nested data structure:

exclude: OBJECT, which is also a nested data structure.
- or: OBJECT, which is also a nested data structure.
  - urn:li:ad_targeting_facet:followed_companies: ARRAY, which is also a nested data structure.
  - urn:li:ad_targeting_facet:seniorities: ARRAY, which is also a nested data structure.
  - urn:li:ad_targeting_facet:staff_count_ranges: ARRAY, which is also a nested data structure.
  - urn:li:ad_targeting_facet:titles: ARRAY, which is also a nested data structure.
include: OBJECT, which is also a nested data structure.
- and: OBJECT, which is also a nested data structure.
  - type: STRING
  - values: ARRAY, which is also a nested data structure.

test

BOOLEAN

total_budget

OBJECT

This is a nested data structure:

amount: NUMBER
currency_code: STRING

type

STRING

unit_cost

OBJECT

This is a nested data structure:

amount: NUMBER
currency_code: STRING

version

OBJECT

This is a nested data structure:

version_tag: STRING

version_tag

STRING

creatives

The Creatives API contains all the data and information for visually rendering an ad.

Replication Method	CDC
Primary Key	id
Replication Key	last_modified_at
Useful links	LinkedIn Ads documentation

Join creatives with	on
campaigns	creatives.campaign_id = campaigns.id
ad_analytics_by_campaign	creatives.campaign_id = ad_analytics_by_campaign.campaign_id
ad_analytics_by_creative	creatives.id = ad_analytics_by_creative.creative_id

account

STRING

account_id

INTEGER

campaign

STRING

campaign_id

INTEGER

content

OBJECT

This is a nested data structure:

reference: STRING
text_ad: OBJECT, which is also a nested data structure.
- description: STRING
- headline: STRING
- landing_page: STRING

created_at

DATE-TIME

created_by

STRING

intended_status

STRING

is_serving

BOOLEAN

is_test

BOOLEAN

last_modified_at

DATE-TIME

last_modified_by

STRING

serving_hold_reasons

ARRAY

This is a nested data structure.

video_ads

The video_ads table contains info about the video ads in your LinkedIn Ads account.

Replication Method	CDC
Primary Key	content_reference
Replication Key	last_modified_time
Useful links	LinkedIn Ads API method

Join video_ads with	on
account_users	video_ads.account_id = account_users.account_id
accounts	video_ads.account_id = accounts.id
campaigns	video_ads.account_id = campaigns.account_id
campaign_groups	video_ads.account_id = campaign_groups.account_id

account

STRING

account_id

INTEGER

change_audit_stamps

OBJECT

This is a nested data structure:

created: OBJECT, which is also a nested data structure.
- time: DATE-TIME
last_modified: OBJECT, which is also a nested data structure.
- time: DATE-TIME

content_reference

STRING

content_reference_share_id

INTEGER

content_reference_ucg_post_id

INTEGER

created_time

DATE-TIME

last_modified_time

DATE-TIME

name

STRING

owner

STRING

owner_organization_id

INTEGER

type

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here