This page provides a guide to Establishing a Connection to LinkedIn Marketing Solutions in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to LinkedIn Marketing Solutions

Establishing a Connection shows how to authenticate to LinkedIn Marketing Solutions and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from LinkedIn Marketing Solutions through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to LinkedIn Marketing Solutions by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Authenticating to LinkedIn Marketing Solutions (OAuth)

LinkedIn Marketing Solutions supports OAuth authentication only.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via a . Web applications require that you create a custom OAuth application.

You may choose to use your own OAuth Application Credentials when you want to:

• control branding of the Authentication Dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

To create a custom OAuth application for use with LinkedIn Marketing Solutions:

1. Log in to your LinkedIn developers dashboard and click Create New App.
2. Enter the page URL you want to associate with the app, alongside information to be displayed to users when they are prompted to grant permissions to your application.
3. Select your application.
4. In the Products tab, select Sign in with LinkedIn.
5. Wait for the owner of the LinkedIn page to approve your application. After that is done, your application will have the OAuth 2.0 permissions it needs. These permissions will be visible in the Auth tab.
6. Set the redirect URI:
   • For desktop applications, in the Auth tab set the Redirect URI to http://localhost:33333 or a port number of your choice. When you connect you must set the CallbackURL connection property to this exact URL.
     The OAuthClientId and OAuthClientSecret are also displayed in the same page.
7. Set the application's Scope property to include all of the following scopes:
   • r_emailaddress
   • r_ads,
   • w_organization_social
   • rw_ads,r_basicprofile
   • r_liteprofile
   • r_ads_reporting
   • r_organization_social
   • r_member_social
   • rw_organization_admin
   • w_member_social
   • r_1st_connections_size
   • r_ads_leadgen_automation

Customizing the SSL Configuration

By default, the Cloud 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 Cloud 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 Cloud 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 similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - LinkedIn Marketing Solutions 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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Accounts WHERE Status = 'ACTIVE'

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.

Note: This view is unavailable when authenticating with the embedded OAuth app. Create a custom app with the required r_ads_leadgen_automation scope (see Creating a Custom OAuth Application) to access it.

Columns

Name	Type	Description
Id	String	URN identifying the ad form response.
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 submitted.
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	Whether 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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. 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.

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.
PlacementName	String	Pivot value which groups the result by member company.
ImpressionDeviceType	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.
ValidWorkEmailLeads	Long	The count of leads with a valid work email that does not use an established free or personal email domain.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. 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.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. 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.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignGroups WHERE Status = 'ACTIVE'

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.
AdAccountId	String	Id of the account

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignInsights WHERE Campaign = '123456'

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignRecommendations WHERE Campaign = '123456'

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Campaigns WHERE Status = 'ACTIVE'

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.
AdAccountId	String	Id of the account

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Conversions WHERE Account = '123456'

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

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'

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.
AdAccountId	String	Id of the account

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Degrees

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FieldsOfStudy

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Forms WHERE Account = '123456'

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Industries

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM JobFunctions

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Locations

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 OrganizationId column is required and must be specified in the criteria to use this view.

The Cloud 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 Cloud.

• 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 Posts 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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Seniorities

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Skills

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

• 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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM ThirdPartyTracking WHERE Creative = '123456'

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Titles

Columns

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

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with LinkedIn Marketing Solutions.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from LinkedIn Marketing Solutions, along with an indication of whether the procedure succeeded or failed.

CData Cloud - LinkedIn Marketing Solutions Stored Procedures

Name	Description

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for LinkedIn Marketing Solutions:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Analytics table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Analytics' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Analytics table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Analytics' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:linkedinads:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.

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.

Data Type

string

Default Value

"202308"

Remarks

The API version used by default is 202308. 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
Scope	A specific scope that the user requires the access token.

A specific scope that the user requires the access token.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

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

Data Type

int

Default Value

100

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.

Data Type

string

Default Value

""

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.

Data Type

int

Default Value

60

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 Cloud throws an exception.