LinkedIn Ads feature snapshot

A high-level look at Stitch's LinkedIn Ads (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on February 19, 2020

Supported by

Stitch

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-linkedin-ads

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

Select all

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting LinkedIn Ads

LinkedIn Ads setup requirements

To set up LinkedIn Ads in Stitch, you need:

  • Access to a LinkedIn Ads account. This is necessary to login to the Campaign Manager account.

  • Access to a LinkedIn Ads Campaign Manager account. Verify that you have access to use the Ad accounts you want to replicate data from. This is necessary to connect to Stitch.


Step 1: Retrieve your LinkedIn Ads account IDs

  1. Login to your LinkedIn account.
  2. Click the Work menu, then Advertise:

    The LinkedIn Work and Advertise menus, highlighted

  3. In the Accounts table, locate the IDs for the accounts you want to replicate data from:

    LinkedIn Ads account IDs highlighted in the Accounts table of the Campaign Manager page.

Step 2: Add LinkedIn Ads as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the LinkedIn Ads icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch LinkedIn Ads” would create a schema called stitch_linkedin_ads in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Accounts field, enter a comma-separated list of the account IDs of the campaign accounts you want to replicate data from. These will be the account IDs you retrieved in Step 1. For example: 503123456,503234567, etc.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your LinkedIn Ads integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond LinkedIn Ads’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

LinkedIn Ads integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For LinkedIn Ads integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up LinkedIn Ads, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


LinkedIn Ads table reference

Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

account_id : user_person_id

API endpoint :

Find Ad Account Users by Accounts

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

account_id
INTEGER

The ID of the account associated with the user.

Reference:

user_person_id
STRING

The user’s person ID.

Reference:

last_modified_time
DATE-TIME

The time the user was last modified.

account
STRING

The advertising account’s URN.

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

account_users (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

account_users (table), last_modified (attribute)
account_users (table), change_audit_stamps (attribute)

created_time
DATE-TIME

The time the user was las modified.

role
STRING

The user’s role in the account. Possible values are:

  • VIEWER
  • CREATIVE_MANAGER
  • CAMPAIGN_MANAGER
  • ACCOUNT_MANAGER
  • ACCOUNT_BILLING_ADMIN

user
STRING

The associated user’s URN.


Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

id

API endpoint :

Search for Accounts

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

id
INTEGER

The internal account ID.

Reference:

last_modified_time
DATE-TIME

The time the account was last modified.

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

accounts (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

accounts (table), last_modified (attribute)
accounts (table), change_audit_stamps (attribute)

created_time
DATE-TIME

The time the account was created.

currency
STRING

The ISO 4217 currency code.

name
STRING

The account label.

notified_on_campaign_optimization
BOOLEAN

Indicates if the campaign contact has been notified about an opportunity.

notified_on_creative_approval
BOOLEAN

Indicates if the creative contact has been notified of approval.

notified_on_creative_rejection
BOOLEAN

Indicates if the creative contact has been rejected.

notified_on_end_of_campaign
BOOLEAN

Indicates if the campaign contact has been notified about the end of a campaign.

reference
STRING

The entity on whose behalf the account advertises.

reference_organization_id
INTEGER

reference_person_id
STRING

serving_statuses
ARRAY

Details about the account’s system serving statuses.

value
STRING

The account’s system serving status. If an account is eligible for serving, the value will be RUNNABLE.

Other possible values that indicate why the account isn’t servable:

  • STOPPED
  • BILLING_HOLD
  • ACCOUNT_TOTAL_BUDGET_HOLD
  • ACCOUNT_END_DATE_HOLD
  • RESTRICTED_HOLD
  • INTERNAL_HOLD
accounts (table), serving_statuses (attribute)

status
STRING

The account’s active status.

total_budget
OBJECT

Details about the account’s budget.

amount
NUMBER

currency_code
STRING

accounts (table), total_budget (attribute)

total_budget_ends_at
DATE-TIME

type
STRING

The account type - business or enterprise.

version
OBJECT

version_tag
STRING

accounts (table), version (attribute)

ad_analytics_by_campaign

Replication Method :

Key-based Incremental

Replication Key :

end_at

Primary Key :

campaign_id : start_at

API endpoint :

Analytics Finder; Creative

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

campaign_id
INTEGER

The campaign ID.

Reference:

start_at
DATE-TIME

The start of the time range for the analytics.

end_at
DATE-TIME

The end of the time range for the analytics.

action_clicks
INTEGER

The count of clicks on the action button in Sponsored InMail.

ad_unit_clicks
INTEGER

The count of clicks on the ad unit alongside the Sponsored InMail.

campaign
STRING

comments
INTEGER

The count of comments - Sponsored Updates only.

company_page_clicks
INTEGER

The count of clicks to view the company page.

conversion_value_in_local_currency
NUMBER

The value of the conversions in the account’s local currency.

cost_in_local_currency
NUMBER

The cost in the account’s local currency based on the pivot and timeGranularity.

cost_in_usd
NUMBER

The cost in USD based on the pivot and timeGranularity.

date_range
OBJECT

The date range of the report data point, specified in UTC. A start date is required.

end
OBJECT

day
INTEGER

month
INTEGER

year
INTEGER

ad_analytics_by_campaign (table), end (attribute)

start
OBJECT

day
INTEGER

month
INTEGER

year
INTEGER

ad_analytics_by_campaign (table), start (attribute)
ad_analytics_by_campaign (table), date_range (attribute)

external_website_conversions
INTEGER

The count of conversions indicated by pixel loads on an external advertiser website.

external_website_post_click_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website.

external_website_post_view_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website.

follows
INTEGER

The follow count - Sponsored Updates only.

full_screen_plays
INTEGER

The tap counts on a video going into video view mode.

impressions
INTEGER

This is the count of impressions for Direct Ads and Sponsored Updates and ‘sends’ for InMails.

lead_generation_mail_contact_info_shares
INTEGER

The number of times users shared contact info through the One Click Lead Gen for Sponsored InMail - Sponsored InMail only.

lead_generation_mail_interest_clicks
INTEGER

The count of InMail recipients who clicked to demonstrate interest - Sponsored InMail only.

likes
INTEGER

The count of likes - Sponsored Updates only.

one_click_lead_form_opens
INTEGER

The count of times users opened the lead form for a One Click Lead Gen campaign.

one_click_leads
INTEGER

The count of leads generated through One Click Lead Gen.

opens
INTEGER

The count of opens of Sponsored InMail.

other_engagements
INTEGER

The count of user interactions with the ad unit that do not fit into any other more specific category.

pivot
STRING

pivot_value
STRING

pivot_values
NULL

The value of the pivots for a specific record returned.

shares
INTEGER

The count of sends of Sponsored InMail.

text_url_clicks
INTEGER

The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.

total_engagements
INTEGER

The count of all user interactions with the ad unit.

video_completions
INTEGER

The count of video ads that played 97-100% of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

video_first_quartile_completions
INTEGER

The count of video ads that played through the first quartile of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

video_midpoint_completions
INTEGER

video_starts
INTEGER

video_third_quartile_completions
INTEGER

video_views
INTEGER

The count of video ads that played through the midpoint of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

viral_clicks
INTEGER

The count of clicks on viral impressions - Sponsored Updates only.

viral_comments
INTEGER

The count of comments from viral impressions for this activity - Sponsored Updates only.

viral_company_page_clicks
INTEGER

The count of clicks to view the company page from viral impressions for this activity - Sponsored Updates only.

viral_external_website_conversions
INTEGER

The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.

viral_external_website_post_click_conversions
INTEGER

The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.

viral_external_website_post_view_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.

viral_follows
INTEGER

The count of follows from viral impressions for this activity - Sponsored Updates only.

viral_full_screen_plays
INTEGER

The count of taps on the video, going into video view mode.

viral_impressions
INTEGER

The count of viral impressions for this activity. Viral impressions are those resulting from users sharing a sponsored update to their own network of connections - Sponsored Updates only.

viral_landing_page_clicks
INTEGER

The count of clicks on viral impressions to take the user to the creative landing page - Sponsored Updates only.

viral_likes
INTEGER

The count of likes from viral impressions for this activity - Sponsored Updates only.

viral_one_click_lead_form_opens
INTEGER

The count of times users opened the lead form for viral impressions from a Lead Gen campaign.

viral_one_click_leads
INTEGER

The count of leads generated through One Click Lead Gen from viral impressions for this activity.

viral_other_engagements
INTEGER

The count of user interactions with viral impressions that do not fit into any other more specific category - Sponsored Updates only.

viral_shares
INTEGER

The count of shares from viral impressions for this activity - Sponsored Updates only.

viral_total_engagements
INTEGER

The count of all user interactions with a viral ad unit - Sponsored Updates only.

viral_video_completions
INTEGER

The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point.

viral_video_first_quartile_completions
INTEGER

The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point.

viral_video_midpoint_completions
INTEGER

The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point.

viral_video_starts
INTEGER

The count of viral video ads that were started by users. Since viral videos are automatically played for ON_SITE, this will be the same as viralImpressions if the servingLocation is ON_SITE.

viral_video_third_quartile_completions
INTEGER

The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point.

viral_video_views
INTEGER

A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. An interaction with the video (like going to full screen mode) does not count as a view.


ad_analytics_by_creative

Replication Method :

Key-based Incremental

Replication Key :

end_at

Primary Key :

start_at

API endpoint :

Analytics Finder; Creative

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

creative_id
INTEGER

The creative ID.

Reference:

start_at
DATE-TIME

The start of the time range for the analytics.

end_at
DATE-TIME

The end of the time range for the analytics.

action_clicks
INTEGER

The count of clicks on the action button in Sponsored InMail.

ad_unit_clicks
INTEGER

The count of clicks on the ad unit alongside the Sponsored InMail.

comments
INTEGER

The count of comments - Sponsored Updates only.

company_page_clicks
INTEGER

The count of clicks to view the company page.

conversion_value_in_local_currency
NUMBER

The value of the conversions in the account’s local currency.

cost_in_local_currency
NUMBER

The cost in the account’s local currency based on the pivot and timeGranularity.

cost_in_usd
NUMBER

The cost in USD based on the pivot and timeGranularity.

creative
STRING

date_range
OBJECT

The date range of the report data point, specified in UTC.

end
OBJECT

day
INTEGER

month
INTEGER

year
INTEGER

ad_analytics_by_creative (table), end (attribute)

start
OBJECT

day
INTEGER

month
INTEGER

year
INTEGER

ad_analytics_by_creative (table), start (attribute)
ad_analytics_by_creative (table), date_range (attribute)

external_website_conversions
INTEGER

The count of conversions indicated by pixel loads on an external advertiser website.

external_website_post_click_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website.

external_website_post_view_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website.

follows
INTEGER

The follow count - Sponsored Updates only.

full_screen_plays
INTEGER

The tap counts on a video going into video view mode.

impressions
INTEGER

This is the count of ‘impressions’ for Direct Ads and Sponsored Updates and ‘sends’ for InMails.

lead_generation_mail_contact_info_shares
INTEGER

lead_generation_mail_interest_clicks
INTEGER

The number of times users shared contact info through the One Click Lead Gen for Sponsored InMail - Sponsored InMail only.

likes
INTEGER

The count of likes - Sponsored Updates only.

one_click_lead_form_opens
INTEGER

The count of times users opened the lead form for a One Click Lead Gen campaign.

one_click_leads
INTEGER

The count of leads generated through One Click Lead Gen.

opens
INTEGER

The count of opens of Sponsored InMail.

other_engagements
INTEGER

The count of user interactions with the ad unit that do not fit into any other more specific category.

pivot
STRING

pivot_value
STRING

pivot_values
NULL

The value of the pivots for a specific record returned.

shares
INTEGER

The count of sends of Sponsored InMail.

text_url_clicks
INTEGER

The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.

total_engagements
INTEGER

The count of all user interactions with the ad unit.

video_completions
INTEGER

The count of video ads that played 97-100% of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

video_first_quartile_completions
INTEGER

The count of video ads that played through the first quartile of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

video_midpoint_completions
INTEGER

video_starts
INTEGER

video_third_quartile_completions
INTEGER

video_views
INTEGER

The count of video ads that played through the midpoint of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

viral_clicks
INTEGER

The count of clicks on viral impressions - Sponsored Updates only.

viral_comments
INTEGER

The count of comments from viral impressions for this activity - Sponsored Updates only.

viral_company_page_clicks
INTEGER

The count of clicks to view the company page from viral impressions for this activity - Sponsored Updates only.

viral_external_website_conversions
INTEGER

The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.

viral_external_website_post_click_conversions
INTEGER

The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.

viral_external_website_post_view_conversions
INTEGER

The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.

viral_follows
INTEGER

The count of follows from viral impressions for this activity - Sponsored Updates only.

viral_full_screen_plays
INTEGER

The count of taps on the video, going into video view mode.

viral_impressions
INTEGER

The count of viral impressions for this activity. Viral impressions are those resulting from users sharing a sponsored update to their own network of connections - Sponsored Updates only.

viral_landing_page_clicks
INTEGER

The count of clicks on viral impressions to take the user to the creative landing page - Sponsored Updates only.

viral_likes
INTEGER

The count of likes from viral impressions for this activity - Sponsored Updates only.

viral_one_click_lead_form_opens
INTEGER

The count of times users opened the lead form for viral impressions from a Lead Gen campaign.

viral_one_click_leads
INTEGER

The count of leads generated through One Click Lead Gen from viral impressions for this activity.

viral_other_engagements
INTEGER

The count of user interactions with viral impressions that do not fit into any other more specific category - Sponsored Updates only.

viral_shares
INTEGER

The count of shares from viral impressions for this activity - Sponsored Updates only.

viral_total_engagements
INTEGER

The count of all user interactions with a viral ad unit - Sponsored Updates only.

viral_video_completions
INTEGER

The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point.

viral_video_first_quartile_completions
INTEGER

The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point.

viral_video_midpoint_completions
INTEGER

The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point.

viral_video_starts
INTEGER

The count of viral video ads that were started by users. Since viral videos are automatically played for ON_SITE, this will be the same as viralImpressions if the servingLocation is ON_SITE.

viral_video_third_quartile_completions
INTEGER

The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point.

viral_video_views
INTEGER

A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. An interaction with the video (like going to full screen mode) does not count as a view.


Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

id

API endpoint :

Search For Campaign Groups

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

id
INTEGER

The campaign group ID.

Reference:

last_modified_time
DATE-TIME

The time the campaign group was last modified.

account
STRING

URN identifying the advertising account associated with the campaign.

account_id
INTEGER

The ID of the account associated with the campaign group.

Reference:

backfilled
BOOLEAN

Indicates whether the campaign group was created organically or to backfill existing campaigns.

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

campaign_groups (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

campaign_groups (table), last_modified (attribute)
campaign_groups (table), change_audit_stamps (attribute)

created_time
DATE-TIME

The time the campaign group was created.

name
STRING

The name of the campaign group used to make it easier to reference a campaign group and recall its purpose.

run_schedule
OBJECT

Details about the campaign group’s run schedule.

end
DATE-TIME

Represents the exclusive (strictly less than) date when to stop running the associated campaigns under this campaign group. If this field is unset, it indicates an open range with no end date.

start
DATE-TIME

Represents the inclusive (greater than or equal to) date when to start running the associated campaigns under this campaign group.

campaign_groups (table), run_schedule (attribute)

serving_statuses
ARRAY

Array of enums that determine whether or not campaigns within the campaign group may be served.

value
STRING

The serving status.

campaign_groups (table), serving_statuses (attribute)

status
STRING

The status of campaign group. Possible values are:

  • ACTIVE - Denotes that the campaign group is capable of serving ads, subject to run date and budget limitations (as well as any other limitations at the account or campaign level).
  • ARCHIVED - Denotes that the campaign group is presently inactive, and should mostly be hidden in the UI until un-archived.
  • CANCELED - Denotes that the campaign group has been permanently canceled and cannot be reactivated.
  • DRAFT - Denotes that the campaign group is in a preliminary state and should temporarily not be served.
  • PAUSED - Denotes that the campaign group meets all requirements to be served, but temporarily should not be.

Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

id

API endpoint :

Search For Campaigns

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

id
INTEGER

The campaign ID.

Reference:

last_modified_time
DATE-TIME

The time the campaign was last modified.

account
STRING

URN identifying the advertising account associated with the campaign.

account_id
INTEGER

The ID of the account associated with the campaign.

Reference:

associated_entity
STRING

An URN identifying the intended beneficiary of the advertising campaign such as a specific company or member.

associated_entity_organization_id
INTEGER

associated_entity_person_id
STRING

audience_expansion_enabled
BOOLEAN

Indicates if Audience Expansion is enabled for the campaign provides query expansion for certain targeting criteria.

campaign_group
STRING

URN identifying the campaign group associated with the campaign. If the campaign group is not specified, the campaign is assigned to account’s default campaign group.

campaign_group_id
INTEGER

The ID of the campaign group associated with the campaign.

Reference:

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

campaigns (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

campaigns (table), last_modified (attribute)
campaigns (table), change_audit_stamps (attribute)

cost_type
STRING

The cost type - CPM, CPC, or CPV.

created_time
DATE-TIME

creative_selection
STRING

The creative selection - ROUND_ROBIN or OPTIMIZED.

daily_budget
OBJECT

Details about the budget for the campaign.

amount
NUMBER

Maximum amount to spend per day UTC. The amount of money as a real number string.

currency_code
STRING

The ISO currency code. The currency must match that of the parent account.

campaigns (table), daily_budget (attribute)

locale
OBJECT

Details about the campaign’s locale.

country
STRING

Locale of the campaign. An uppercase two-letter country code as defined by ISO-3166.

language
STRING

Locale of the campaign. A lowercase two-letter language code as defined by ISO-639.

campaigns (table), locale (attribute)

name
STRING

The name of the campaign.

offsite_delivery_enabled
BOOLEAN

Indicates if offsite delivery is enabled for the campaign.

optimization_target_type
STRING

Determines how this campaign is optimized for spending. If this is not set, there is no optimization. Refer to LinkedIn Ads’ documentation for more info.

run_schedule
OBJECT

Details about the campaign’s run schedule.

end
DATE-TIME

Scheduled date range to stop associated creatives. Represents the exclusive (strictly less than) value in which to end the range.

start
DATE-TIME

Scheduled date range to run associated creatives.

campaigns (table), run_schedule (attribute)

serving_statuses
NULL

The serving status of the campaign.

status
STRING

The status of the campaign. Possible values are:

  • ACTIVE - Denotes that the campaign is fully servable.
  • PAUSED - Denotes that the campaign meets all requirements to be served, but temporarily should not be.
  • ARCHIVED - Denotes that the campaign is presently inactive, and should mostly be hidden in the UI until un-archived.
  • COMPLETED - Denotes that the campaign has reached a specified budgetary or chronological limit.
  • CANCELED - Denotes that the campaign has been permanently canceled, such as when an advertising account is permanently closed.
  • DRAFT - Denotes that the campaign is still being edited and not eligible for serving. Some validation will be postponed until the campaign is activated.

targeting
OBJECT

Deprecated by LinkedIn Ads. Use targeting_criteria instead.

excluded_targeting_facets
NULL

Deprecated by LinkedIn Ads. Use targeting_criteria instead.

included_targeting_facets
NULL

Deprecated by LinkedIn Ads. Use targeting_criteria instead.

campaigns (table), targeting (attribute)

targeting_criteria
OBJECT

Specifies targeting criteria that the member should match. Refer to LinkedIn Ads’ documentation for more info.

exclude
NULL

include
OBJECT

and
NULL

campaigns (table), include (attribute)
campaigns (table), targeting_criteria (attribute)

type
STRING

The type of the campaign. Possible values are:

  • TEXT_AD - Text-based ads that show up in the right column or top of the page on LinkedIn.
  • SPONSORED_UPDATES - Native ads that promote a company’s content updates in the LinkedIn feed.
  • SPONSORED_INMAILS - Personalized messages with a call-to-action button delivered to a LinkedIn’s member inbox.
  • DYNAMIC - Ads that are dynamically personalized.

unit_cost
OBJECT

Amount to bid per click, impression, or other event depending on the pricing model.

amount
NUMBER

The amount to bid to the associated account.

currency_code
STRING

The ISO currency code to the associated account.

campaigns (table), unit_cost (attribute)

version
OBJECT

Details about the campaign’s version.

version_tag
STRING

Each entity has a version tag associated with it. The version tag is initiated to 1 when the entity is created. Each single update to the entity increases its version tag by 1.

campaigns (table), version (attribute)

Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

id

API endpoint :

Search For Creatives

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

id
INTEGER

The creative ID.

Reference:

last_modified_time
DATE-TIME

The time the creative was last modified.

campaign
STRING

The URN identifying the campaign associated with the creative.

campaign_id
INTEGER

The ID of the campaign associated with the creative.

Reference:

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

creatives (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

creatives (table), last_modified (attribute)
creatives (table), change_audit_stamps (attribute)

created_time
DATE-TIME

The time the campaign was created.

reference
STRING

A reference URN for this object to an external system, with semantics varying based on the creative type.

reference_share_id
INTEGER

review
OBJECT

Details about the review status of the creative.

review_status
STRING

The review status of the Ad entity. Possible values are:

  • PENDING - Ad entity is pending review and not serving.
  • APPROVED - Ad entity is approved for serving.
  • REJECTED - Ad entity is rejected.
  • PREAPPROVED - Ad entity has been preapproved; it’s ready for serving but still needs further review.
  • AUTO_APPROVED - Ad entity has been auto approved by content model.
  • NEEDS_REVIEW - Ad entity has been rejected by content model or policy checker or returned by fallback case that auto approval didn’t make any decision.
  • AUTO_REJECTED - Ad entity has been auto rejected by content model.
creatives (table), review (attribute)

status
STRING

The status of the creative. Possible values are:

  • ACTIVE - Creative creation is complete and creative is available for review and serve.
  • PAUSED - Creative creation is complete and creative is current, but should temporarily not be served.
  • DRAFT - Creative creation is incomplete and may still be edited.
  • ARCHIVED - Creative creation is complete, but creative should not be served and should be separated from non-archived creatives in any UI.
  • CANCELED - Creative is permanently canceled.

Creative status is set independently from parent entity status, but parent entity status overrides creative status in effect. For example: Parent entity status may be PAUSED while creative status is ACTIVE, in which case creative is in effect PAUSED, and not served.

type
STRING

The type of creative. Possible values are:

  • TEXT_AD - Text with Sponsored Link to landing page on your site.
  • SPONSORED_STATUS_UPDATE - Sponsored status update from a profile page.
  • SPONSORED_INMAILS - Sponsored InMails.
  • SPONSORED_VIDEO - Sponsored videos.
  • SPONSORED_UPDATE_CAROUSEL - Sponsored Carousels
  • FOLLOW_COMPANY_V2 - Dynamic Follow Ad
  • SPOTLIGHT_V2 - Dynamic Spotlight Ad
  • JOBS_V2 - Dynamic Job Ad

variables
OBJECT

Variables for rendering the creative.

click_uri
STRING

Required when creative type is TEXT_AD.

type
STRING

values
NULL

creatives (table), variables (attribute)

version
OBJECT

version_tag
STRING

creatives (table), version (attribute)

Replication Method :

Key-based Incremental

Replication Key :

last_modified_time

Primary Key :

content_reference

API endpoint :

Account Finder; Sponsored Contents

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

content_reference
STRING

The content URN.

last_modified_time
DATE-TIME

The time the video ad was last modified.

account
STRING

The ad account associated with the video ad.

account_id
INTEGER

The ID of the account associated with the video ad.

Reference:

change_audit_stamps
OBJECT

created
OBJECT

time
DATE-TIME

video_ads (table), created (attribute)

last_modified
OBJECT

time
DATE-TIME

video_ads (table), last_modified (attribute)
video_ads (table), change_audit_stamps (attribute)

content_reference_share_id
INTEGER

content_reference_ucg_post_id
INTEGER

created_time
DATE-TIME

The time the video ad was created.

name
STRING

Name of the adDirectSponsoredContents.

owner
STRING

The owner of the organization.

owner_organization_id
INTEGER

type
STRING

This will be video.



Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.