Create a connection to LinkedIn Marketing Solutions by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the LinkedIn Marketing Solutions icon is not available, click the Add More icon to download and install the LinkedIn Marketing Solutions connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Authenticating to LinkedIn Marketing Solutions (OAuth)

LinkedIn Marketing Solutions supports OAuth authentication only.

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with LinkedIn Marketing Solutions. You can then use the Sync App to get and manage the OAuth token values. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

This section details a selection of advanced features of the LinkedIn Marketing Solutions Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to LinkedIn Marketing Solutions and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models entities in the LinkedIn Marketing Solutions API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The CData Sync App models the data in Views so that it can be easily queried and updated.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

LinkedIn Marketing Solutions Connector for CData Sync Views

Name	Description
Accounts	The Account status finder returns all accounts in a specified status that the authenticated user has access to.
AdFormResponses	The response data for leads that filled out a form within the last 90 days. Older responses are not included.
Analytics	The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.
AudienceCount	The Audience Count API allows advertisers to forecast the reach of targeting criteria.
BudgetPricing	The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
CampaignGroups	The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
CampaignInsights	The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.
CampaignRecommendations	The Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.
Campaigns	The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
Conversions	Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.
Creatives	The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.
Degrees	Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
FieldsOfStudy	Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Forms	LinkedIn Lead Gen Forms make it easy for advertisers to collect leads through forms that LinkedIn members can submit.
Industries	Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
JobFunctions	Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Locations	Location taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Posts	Retrieve all posts for an organization.
Seniorities	Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Skills	Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
SocialActions	The socialActions API allows access to both personal and organization social actions.
ThirdPartyTracking	Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.
Titles	Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

The Account status finder returns all accounts in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Accounts view returns a list of the accounts that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Accounts

SELECT * FROM Accounts WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Id of the account
Name	String	A label for the account
Currency	String	The account's ISO-4217currency code.
Type	String	The type of account.
NotifiedOnCreativeRejection	Boolean	Indicates if creative contact is notified when a creative has been rejected due to content.
NotifiedOnEndOfCampaign	Boolean	Indicates if campaign contact is notified when an associated campaign has been completed.
Status	String	Status of the account
NotifiedOnCampaignOptimization	Boolean	Indicates if campaign contact is notified about campaign optimization opportunities.
Version	String	Version of the account
Reference	String	The entity on whose behalf the account advertises.
NotifiedOnCreativeApproval	Boolean	Indicates if creative contact is notified when a creative has been reviewed and approved.
AuditStampsCreator	String	The person who created audit stamps for the first time
AuditStampsCreatedAt	Datetime	The datetime in which the audit stamp was created first
AuditStampsLastModifier	String	Last modifier of the Audit stamps
AuditStampsLastModifiedAt	Datetime	Last modified datetime of the audit stamps

The response data for leads that filled out a form within the last 90 days. Older responses are not included.

Columns

Name	Type	Description
Id	String
Account	String	The URN which describes which account the response is generated under.
Campaign	String	URN identifying the campaign to which the form response is responding.
Creative	String	URN identifying the creative to which the form response is responding.
Form	String	URN identifying which form this response responds to.
SubmitedAt	Datetime	The time when the form response was submited
LeadType	String	Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED.
TestLead	Boolean	If the lead is a test lead
ConsentResponses	String	A Json object containing all the consent responses.
Answers	String	A Json object containing all the answers and the respective questions.

The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.

Table Specific Information

Select

The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT ReportStartTime, ReportEndTime, Clicks, Impressions, Follows, TotalEngagements From Analytics WHERE ReportStartTime='07/20/2016' AND Account='123456789' AND Granularity='MONTHLY'

Select Rules

Analytic reports:

Dimensions	Required	FinderMethod, ReportStartTime, Granularity
	Optional	ReportEndTime, CampaignType
If FinderMethod is Analytics	Use 0 or 1 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, MemberCompany
If FinderMethod is Statistics	Use 1 or 2 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex Note: The default value for FinderMethod will be Analytics. The default value for Granularity will be MONTHLY. The default time window will be the last year period.
Metrics	Use 1 or more	ActionClicks, AdUnitClicks, CardClicks, CardImpressions, Clicks, CommentLikes, Comments, CompanyPageClicks, ConversionValueInLocalCurrency, CostInLocalCurrency, CostInUsd, StartPeriod, EndPeriod, ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, Follows, FullScreenPlays, Impressions, LandingPageClicks, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, Likes, OneClickLeadFormOpens, OneClickLeads, Opens, OtherEngagements, Pivot, PivotValue, Shares, TextUrlClicks, TotalEngagements, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoStarts, VideoThirdQuartileCompletions, VideoViews, ViralCardClicks, ViralCardImpressions, ViralClicks, ViralComments, ViralCompanyPageClicks, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralFullScreenPlays, ViralImpressions, ViralLandingPageClicks, ViralLikes, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralOtherEngagements, ViralShares, ViralTotalEngagements, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoStarts, ViralVideoThirdQuartileCompletions, ViralVideoViews, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost, AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost
Filter	Use 1 or more	Account, Campaign, Creative Note: If there are no filters specified the default filter will be all the accounts that belong to the user.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Company	String	Pivot value which groups the result by advertiser's company.
Account	String	Pivot value which groups the result by account.
Share	String	Pivot value which groups the result by sponsored share.
Campaign	String	Pivot value which groups the result by campaign.
Creative	String	Pivot value which groups the result by creative.
CampaignGroup	String	Pivot value which groups the result by campaign group.
Conversion	String	Pivot value which groups the result by conversion.
ServingLocation	String	Pivot value which groups the result by serving location.
CardIndex	String	Pivot value which groups the result by card index.
MemberCompanySize	String	Pivot value which groups the result by member company size.
MemberIndustry	String	Pivot value which groups the result by member industry.
MemberSeniority	String	Pivot value which groups the result by member seniority.
MemberJobTitle	String	Pivot value which groups the result by member job title.
MemberJobFunction	String	Pivot value which groups the result by member job function.
MemberCountry	String	Pivot value which groups the result by member country.
MemberRegion	String	Pivot value which groups the result by member region.
MemberCounty	String	Pivot value which groups the result by member county.
MemberCompany	String	Pivot value which groups the result by member company.
CampaignType	String	Match result by campaign type.
Granularity	String	Time granularity of results. The default value is MONTHLY.
FinderMethod	String	Designates the query finder. The only allowed values are The default value is analytics.
ReportStartTime	String	The start time of the period.
ReportEndTime	String	The end time of the period.
ActionClicks	Long	The count of clicks on the action button of the Sponsored InMail.
AdUnitClicks	Long	The count of clicks on the ad unit displayed alongside the Sponsored InMail.
CardClicks	Long	The number of clicks for each card of a carousel ad.
CardImpressions	Long	The number of impressions shown for each card of a carousel ad.
Clicks	Long	The count of chargeable clicks.
CommentLikes	Long	The count of likes of a comment.
Comments	Long	The count of comments. Sponsored
CompanyPageClicks	Long	The count of clicks to view the company page.
ConversionValueInLocalCurrency	Decimal	Value of the conversions in the account's local currency based on rules defined by the advertiser.
CostInLocalCurrency	Decimal	Cost in the account's local currency based on the pivot and timeGranularity.
CostInUsd	Decimal	Cost in USD based on the pivot and timeGranularity.
UsageStartTime	String	Date start covered by the report data point.
UsageEndTime	String	Date end covered by the report data point.
ExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website.
Follows	Long	The count of follows. Sponsored
FullScreenPlays	Long	A user taps on the video, going into video view mode.
Impressions	Long	This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails.
LandingPageClicks	Long	The count of clicks which take the user to the creative landing page.
LeadGenerationMailContactInfoShares	Long	The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail.
LeadGenerationMailInterestedClicks	Long	The count of InMail recipients showing interest.
Likes	Long	The count of likes.
OneClickLeadFormOpens	Long	The count of times a user opened the lead form for a One Click Lead Gen campaign.
OneClickLeads	Long	The count of leads generated through One Click Lead Gen.
Opens	Long	The count of opens of Sponsored InMail.
OtherEngagements	Long	The count of user interactions with the ad unit that do not fit into any other more specific category.
Shares	Long	The count of shares.
TextUrlClicks	Long	The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.
TotalEngagements	Long	The count of all user interactions with the ad unit.
VideoCompletions	Long	The count of video ads that played 97-100% of the video.
VideoFirstQuartileCompletions	Long	The count of video ads that played through the first quartile of the video.
VideoMidpointCompletions	Long	The count of video ads that played through the midpoint of the video.
VideoStarts	Long	The count of video ads that were started by a user.
VideoThirdQuartileCompletions	Long	The count of video ads that played through the third quartile of the video.
VideoViews	Long	A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
ViralCardClicks	Long	The number of viralClicks for each card of a carousel ad.
ViralCardImpressions	Long	The number of viralImpressions shown for each card of a carousel ad.
ViralClicks	Long	The count of clicks on viral impressions.
ViralComments	Long	The count of comments from viral impressions for this activity.
ViralCompanyPageClicks	Long	The count of clicks to view the company page from viral impressions for this activity.
ViralExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.
ViralExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.
ViralExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.
ViralFollows	Long	The count of follows from viral impressions for this activity.
ViralFullScreenPlays	Long	A user taps on the video, going into video view mode.
ViralImpressions	Long	The count of viral impressions for this activity.
ViralLandingPageClicks	Long	The count of clicks on viral impressions to take the user to the creative landing page.
ViralLikes	Long	The count of likes from viral impressions for this activity.
ViralOneClickLeadFormOpens	Long	The count of times a user opened the lead form for viral impressions from a Lead Gen campaign.
ViralOneClickLeads	Long	The count of leads generated through One Click Lead Gen from viral impressions for this activity.
ViralOtherEngagements	Long	The count of user interactions with viral impressions that do not fit into any other more specific category.
ViralShares	Long	The count of shares from viral impressions for this activity.
ViralTotalEngagements	Long	The count of all user interactions with a viral ad unit.
ViralVideoCompletions	Long	The count of viral video ads that played 97-100% of the video.
ViralVideoFirstQuartileCompletions	Long	The count of viral video ads that played through the first quartile of the video.
ViralVideoMidpointCompletions	Long	The count of viral video ads that played through the midpoint of the video.
ViralVideoStarts	Long	The count of viral video ads that were started by a user.
ViralVideoThirdQuartileCompletions	Long	The count of viral video ads that played through the third quartile of the video.
ViralVideoViews	Long	A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
AverageDailyReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (daily).
AverageDailyReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (daily).
AverageDailyReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily).
AveragePreviousSevenDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days).
AveragePreviousThirtyDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days).
ApproximateUniqueImpressions	Long	The estimated number of unique member accounts with at least one impression.

The Audience Count API allows advertisers to forecast the reach of targeting criteria.

Table Specific Information

Select

The AudienceCount view allows advertisers to forecast the reach of targeting criteria.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM AudienceCount WHERE AgeRanges='(25,34)'

SELECT * FROM AudienceCount WHERE DegreesId='1234'

SELECT * FROM AudienceCount WHERE FieldsOfStudyId='1234'

SELECT * FROM AudienceCount WHERE Genders='MALE'

SELECT * FROM AudienceCount WHERE IndustriesId='1234'

SELECT * FROM AudienceCount WHERE JobFunctionsId='1234'

SELECT * FROM AudienceCount WHERE LocationsId='1234'

SELECT * FROM AudienceCount WHERE ProfileLocationsId='1234'

SELECT * FROM AudienceCount WHERE SenioritiesId='1234'

SELECT * FROM AudienceCount WHERE SkillsId='1234'

SELECT * FROM AudienceCount WHERE StaffCountRanges='(11,50)'

SELECT * FROM AudienceCount WHERE TitlesId='1234'

Select Rules

Audience count reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
ActiveAudience	Integer	Active audience count for the given targeting criteria.
TotalAudience	Integer	Total audience count for the given targeting criteria.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

Table Specific Information

Select

The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM BudgetPricing WHERE AgeRanges='(25,34)' AND Account='1234'

SELECT * FROM BudgetPricing WHERE DegreesId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE FieldsOfStudyId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE Genders='MALE' AND Account='1234'

SELECT * FROM BudgetPricing WHERE IndustriesId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE JobFunctionsId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE LocationsId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE ProfileLocationsId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE SenioritiesId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE SkillsId='1234' AND Account='1234'

SELECT * FROM BudgetPricing WHERE StaffCountRanges='(11,50)' AND Account='1234'

SELECT * FROM BudgetPricing WHERE TitlesId='1234' AND Account='1234'

Select Rules

Budget pricing reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.
Filter	Required	CampaignType, Account, BidType, MatchType Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. The default value for CampaignType will be TEXT_AD. The default value for BidType will be CPM. The default value for MatchType will be EXACT. If there is no Account specified there will be records for every account that belongs to the user.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
SuggestedBidDefault	String	The suggested bid
SuggestedBidMin	String	Low end of suggested bid range
SuggestedBidMax	String	High end of suggested bid range
DailyBudgetLimitsDefault	String	Default daily budget
DailyBudgetLimitsMin	String	Minimum daily budget
DailyBudgetLimitsMax	String	Maximum daily budget
BidLimitsMax	String	The maximum bid allowed
BidLimitsMin	String	The minimum bid allowed, also known as the floor price
Account	String	Sponsored account URN.
CampaignType	String	The campaign type. The default value is TEXT_AD.
BidType	String	The bidding type. The default value is CPM.
MatchType	String	The matching type. The default value is EXACT.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM CampaignGroups

SELECT * FROM CampaignGroups WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Numerical identifier for the campaign group
Account	String	URN identifying the advertising account associated with the Campaign Group. This value is immutable once set
Name	String	The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose
Status	String	Current Status of the campaign group
TotalBudgetAmount	Decimal	Maximum amount to spend over the life of the Campaign Group.
TotalBudgetCurrencyCode	String	ISO currency code. The currency code must match that of the parent account.
ScheduleStartTime	Datetime	Represents the inclusive (greater than or equal to) value in which to start the range.
ScheduleEndTime	Datetime	Scheduled date range to run associated objects.
Backfilled	Boolean	Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns.

The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

Table Specific Information

Select

The CampaignInsights view returns a list of the analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM CampaignInsights

SELECT * FROM CampaignInsights WHERE Campaign='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Campaign	String	The campaign to which this recommendation belongs.
AverageSpendAmount	String	The average spend of the entity.
AverageSpendCurrencyCode	String	The currency code of the average spend.
BidAmount	String	A prediction of how much additional impressions could be generated from a different bid.
BidCurrencyCode	String	The currency code of additional impressions.
RelativeImpressions	Decimal	A prediction of how much additional impressions could be generated from a different bid.
BudgetExhaustedAt	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.
CampaignRelevanceScore	Long	A score between 0 and 10 (inclusive) indicating how relevant this campaign is compared to its competitors.
DailyBudgetUtilization	Decimal	The average daily budget utilization.
TotalBudgetUtilization	Decimal	The fraction of the total budget this ad entity has spent so far.

The Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.

Table Specific Information

Select

The CampaignInsights view returns a list of the recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM CampaignRecommendations

SELECT * FROM CampaignRecommendations WHERE Campaign='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Campaign	String	The campaign to which this recommendation belongs.
CreatedAt	Timestamp	The epoch timestamp in milliseconds of when this recommendation was generated.
ExpandAudience	Boolean	If true, the recommendation is to expand the audience of this campaign.
ImproveCreativeQuality	Long	If true, the recommendation is to improve the quality of this campaign's creatives.
NumOfCreatives	Long	The recommended number of creatives in the campaign.
Priority	Long	The priority of the recommendation, 0 indexed, with 0 being the highest priority.
Type	String	The type of recommendation.

The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Campaigns

SELECT * FROM Campaigns WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Numerical identifier for the campaign
Account	String	URN identifying the advertising account associated with the Campaign.
CampaignGroup	String	Numerical identifier for the campaign group.
AssociatedEntity	String	An URN for a strongly associated object, with semantics varying based on the Campaign type.
AudienceExpansionEnabled	Boolean	Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria
CostType	String	CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link
CreativeSelection	String	ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance
DailyBudgetAmount	String	The amount of money as a real number string
DailyBudgetCurrency	String	ISO currency code
Country	String	An uppercase two-letter country code as defined by ISO-3166.
Language	String	A lowercase two-letter language code as defined by ISO-639.
Name	String	The name of the Campaign
OffsiteDeliveryEnabled	Boolean	Allow this campaign access to be served on the LinkedIn Advertising Network.
ScheduleStartTime	Datetime	Scheduled date range to run associated creatives.
ScheduleEndTime	Datetime	Scheduled date range to run associated creatives.
Status	String	Current Status of the campaign
Type	String	Type of campaign
UnitCostAmount	String	Amount to bid per click, impression, or other event depending on the pricing model.
UnitCostCurrency	String	Currency of the UnitCostAmount
ObjectiveType	String	The Campaign Objective type.

Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.

Table Specific Information

Select

The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Conversions

SELECT * FROM Conversions WHERE Account='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Numerical identifier for the Conversion.
Account	String	URN identifying the advertising account associated with the Conversion.
DomainId	String	The insightTagDomain key that this Conversion resides under.
Name	String	A short name for this rule, which will be shown in the UI and in reports.
Created	String	The timestamp when the Conversion was created.
LastModified	String	The timestamp when the Conversion was last modified.
LastCallbackAt	String	The timestamp of the last callback from the Conversion.
Amount	String	The amount of money as a real number string.
CurrencyCode	String	Identifying code for currency type. See currency codes for the valid codes.
Type	String	The type of the rule.
Enabled	String	Set to true or false to enable or disable this rule from matching on the advertiser's website.
ImagePixelTag	String	The HTML representation of the image pixel.
PostClickAttributionWindowSize	Integer	The HTML representation of the image pixel.
ViewThroughAttributionWindowSize	Integer	The HTML representation of the image pixel.

The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.

Table Specific Information

Select

The Creatives view returns a list of the creatives that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Creatives

SELECT * FROM Creatives WHERE Id='179345687'

SELECT * FROM Creatives WHERE Account='510013292'

SELECT * FROM Creatives WHERE Account IN ('510013292', '510013293')

SELECT * FROM Creatives WHERE Campaign='198952936'

SELECT * FROM Creatives WHERE IntendedStatus='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Numerical identifier for the creative.
Account	String	URN identifying the advertising account associated with the creative.
Campaign	String	URN identifying the campaign associated with the creative.
Content	String	Content sponsored in the creative.
CreatedAt	Datetime	Datetime when the creative was first created
CreatedBy	String	Entity that developed the creative.
IntendedStatus	String	Creative user intended status.
IsServing	Boolean	This indicates whether the creative is currently being served or not.
ServingHoldReasons	String	Array that contains all the reasons why the creative is not serving.
LastModifiedAt	Datetime	Datetime when the creative was last modified.
LastModifiedBy	String	Entity that modified the creative.
ReviewStatus	String	The current review status of the creative.
IsTest	Boolean	Flag showing whether this creative is a test creative, i.e., belongs to a test campaign.

Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Degrees

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Degree id
URN	String	Standardized degree URN
Name	String	Degree name in various locales. Represented as MultiLocaleString type.

Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The FieldsOfStudy view returns a list of the fields of study found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM FieldsOfStudy

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Field of study id
URN	String	Standardized field of study URN
Name	String	Field of study name in various locales. Represented as MultiLocaleString type.

LinkedIn Lead Gen Forms make it easy for advertisers to collect leads through forms that LinkedIn members can submit.

Table Specific Information

Select

The Forms view returns a list of the forms that LinkedIn members can submit. With Lead Gen Forms, advertisers can collect leads at much higher conversion rates.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Forms

SELECT * FROM Forms WHERE Account='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Numerical identifier for the AdForm.
Account	String	URN identifying the owner of the form. This is the advertiser account.
Created	Timestamp	Timestamp for creation of the form.
LastModified	Timestamp	Timestamp for last modification of the form.
Description	String	Description of the form, visible to both the owner and the viewer.
Headline	String	Headline of the form, visible to both the owner and the viewer.
LandingPage	String	The landing page URL after the viewer clicks on submit.
LegalDisclaimer	String	Advertiser's legal disclaimer to accompany this form.
Name	String	Name of the form, visible to the owner of the form but not visible to the viewer.
PrivacyPolicy	String	The URL of the privacy policy that covers any data passed to the owner of the form.
Country	String	Locale of the form.
Language	String	Locale of the form.
ReviewStatus	String	The status of the review of the form.
ReviewedAt	Timestamp	The timestamp of the review of the form.
Status	String	DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED.
VersionTag	String	The number of times the form has been modified.

Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Industries

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Industry id
URN	String	Standardized industry URN
Name	String	Industry name in various locales. Represented as MultiLocaleString type.
ChildrenIndustries	String	The URNs of the children industries associated with this node.
ParentIndustries	String	The URNs of the parent industry associated with this node.

Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM JobFunctions

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Job function id
URN	String	Standardized Job function URN
Name	String	Job function name in various locales. Represented as MultiLocaleString type.

Location taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Locations view returns a list of the locations and regions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Locations

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	The country code.
CountryGroup	String	The country group URN that this country belongs to.
URN	String	Standardized country URN
Name	String	Country name in various locales. Represented as LocaleString type.

Retrieve all posts for an organization.

Select

The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• OrganizationId supports the '=' comparisons.

OrganizationID

You can obtain OrganizationId information from the LinkedIn dashboard. The syntax is:

"com.linkedin.common.CompanyAttributedEntity": { "company": "urn:li:organization:12345" }

Code Samples

The following queries are processed server side:

SELECT * FROM UGCPosts WHERE OrganizationId='123456789'

Columns

Name	Type	Description
Id [KEY]	String	Id of the post.
Author	String	Author of the post.
Commentary	String	The user generated commentary for the post.
Content	String	The posted content.
CreatedAt	Datetime	Datetime when the post was created.
IsReshareDisabledByAuthor	Boolean	Indicates whether resharing of the post has been disabled by the author.
LastModifiedAt	Datetime	Datetime when the post was lastly modified.
LifecycleState	String	Lifecycle state of the post.
PublishedAt	Datetime	Datetime at which the content was published.
Visibility	String	Visibility restrictions on content.
OrganizationId	String	Id of the organization who created the post.

Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Seniorities

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Seniority id
URN	String	Standardized Seniority URN
Name	String	Seniority name in various locales. Represented as MultiLocaleString type.

Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Skills

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	skill id
Name	String	skill name in various locales. Represented as MultiLocaleString type.

The socialActions API allows access to both personal and organization social actions.

Select

The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• UGCPostId supports the '=, IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM SocialActions WHERE UGCPostId = 'urn:li:share:12345'

SELECT * FROM SocialActions WHERE UGCPostId IN ('urn:li:share:12345','urn:li:share:23456')

Columns

Name	Type	Description
TotalFirstLevelComments	Integer	Total number of first level comments.
AggregatedTotalComments	Integer	Total number of aggregated comments.
LikedByCurrentUser	Boolean	Indicator if the post is liked by current user.
TotalLikes	Integer	Total number of likes.
Target	String	Total number of likes.
UGCPostId	String	Id of UGC Post.

Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.

Table Specific Information

Select

The Forms view returns a list of the Third-party tracking tags through the ad creative they're associated with. The following request takes in an ad creative URN in the creative parameter to search for third-party tracking tags linked to that ad creative.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM ThirdPartyTracking

SELECT * FROM ThirdPartyTracking WHERE Creative='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	The campaign to which this recommendation belongs.
Creative	String	The campaign to which this recommendation belongs.
Account	String	The average spend of the entity.
Event	String	The currency code of the average spend.
Platform	String	A prediction of how much additional impressions could be generated from a different bid.
TrackingUrl	String	The currency code of additional impressions.
Created	Timestamp	A prediction of how much additional impressions could be generated from a different bid.
LastModified	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.

Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Titles view returns a list of the job titles found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Titles

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	Description
Id	String	Titles id
URN	String	Standardized Titles URN
Name	String	Titles name in various locales. Represented as MultiLocaleString type.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Connection

---

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	A specific scope that the user requires the access token.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from LinkedIn Marketing Solutions.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

The version of the LinkedIn Marketing API to be used.

Remarks

The API version used by default is 202210. To use a different API version set this to the format YYYYMM.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	A specific scope that the user requires the access token.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

A specific scope that the user requires the access token.

Remarks

This property must be set in the connection string to get a scoped token with specific privileges.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to LinkedIn Marketing Solutions and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\LinkedInAds Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from LinkedIn Marketing Solutions.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from LinkedIn Marketing Solutions.

Remarks

The Pagesize property affects the maximum number of results to return per page from LinkedIn Marketing Solutions. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Analytics WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"