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, 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_marketing_leadgen_automation

Required Scopes and Endpoint Domains for LinkedIn Marketing Solutions

When integrating with LinkedIn Marketing Solutions, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the LinkedIn Marketing Solutions Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for LinkedIn Marketing Solutions

Scope	Description
r_ads	Read-only access to ad accounts. Required for the following entities: Accounts AudienceCount BudgetPricing CampaignGroups CampaignRecommendations Campaigns Conversions Creatives Forms JobFunctions ThirdPartyTracking ConversationCreatives ConversationCreativeActions
rw_ads	Read and write access to ad accounts. Required for the following entities: Accounts AudienceCount BudgetPricing CampaignGroups CampaignRecommendations Campaigns Conversions Creatives Forms JobFunctions ThirdPartyTracking AccountUsers PublisherRestrictionFiles MessageCreatives BrandLiftTests
r_ads_reporting	Read access to ad reporting and analytics data. Required for the following entities: Analytics
r_marketing_leadgen_automation	Access to lead generation forms and marketing automation data. Required for the following entities: AdFormResponses
w_organization_social	Read and write access to organizational social media content. Required for the following entities: Posts SocialActions Videos Images Documents UploadVideo UploadImage UploadDocument DownloadAsset
r_organization_social	Read-only access to organizational social media content. Required for the following entities: Posts SocialActions
w_member_social	Write access to member social media content. Required for the following entities: Posts SocialActions
r_member_social	Provides read access to member social media content. Required for the following entities: Posts SocialActions
r_compliance	Required to retrieve activities for compliance monitoring and archiving. Required for the following entities: Industries SocialActions
w_compliance	Manage and delete data on behalf of an authenticated member for compliance requirements. This is a private permission and access is granted to select developers. Required for the following entities: Industries SocialActions
r_organization_admin	Read-only access to organization data. Required for the following entities: OrganizationRoleAssignments

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for LinkedIn Marketing Solutions

Domain	Always Required	Description
accounts.linkedin.com	TRUE	The subdomain used for OAuth.
api.linkedin.com	TRUE	The subdomain used for accessing various services.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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. The Cloud uses the LinkedIn Marketing Solutions API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Tables

The CData Cloud models the data in Tables 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.

The Cloud models the data in LinkedIn Marketing Solutions as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - LinkedIn Marketing Solutions Tables

Name	Description
Accounts	The Account status finder returns all accounts in a specified status that the authenticated user has access to.
AccountUsers	Read data on your ad-account users.
BrandLiftTests	Read data on brand lift tests in your LinkedIn ad-account.
CampaignGroups	The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
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.
Forms	Query form data for the forms that belong to a specified owner (account).
Images	Read the metadata of the image assets in your accounts.
MessageCreatives	Read data on message creatives in your LinkedIn ad-account.
Posts	Retrieve all posts for an organization.
PublisherRestrictionFiles	Read data on publisher restriction files used for restricting the sites which serve your ads off-network.
ThirdPartyTracking	Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.
Videos	Read the metadata of the video assets in your accounts.

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'

CUD Operations

Insert

To create a new account, use an INSERT statement. The Type column only accepts 'BUSINESS' value as you cannot create ENTERPRISE accounts through the API.

The following columns are required for insert operations: Name and Type. Currency, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval and IsTest are optional columns.

    INSERT INTO Accounts (Name, Currency, Type, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval, IsTest) VALUES ('Sample Business Account', 'USD', 'BUSINESS', TRUE, TRUE, 'ACTIVE', FALSE, 'urn:li:organization:12345', TRUE, FALSE);

Update

To modify an existing account, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are the ones that are mutable after creation: Name, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval.

    UPDATE Accounts SET Name = 'Updated Account Name',NotifiedOnCreativeRejection = FALSE,NotifiedOnEndOfCampaign = TRUE,Status = 'DRAFT',NotifiedOnCampaignOptimization = TRUE,Reference = 'urn:li:organization:67890',NotifiedOnCreativeApproval = FALSE WHERE Id = 123456;

Delete

To remove an account, use a DELETE statement. Note that the Id column is required in the WHERE clause.

DELETE FROM Accounts WHERE Id = '123456'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the account
Name	String	False		A label for the account
Currency	String	False		The account's ISO-4217currency code.
Type	String	False		The type of account. The allowed values are BUSINESS, ENTERPRISE.
NotifiedOnCreativeRejection	Boolean	False		Indicates if creative contact is notified when a creative has been rejected due to content.
NotifiedOnEndOfCampaign	Boolean	False		Indicates if campaign contact is notified when an associated campaign has been completed.
Status	String	False		Status of the account The allowed values are ACTIVE, PENDING_DELETION, CANCELED, DRAFT, REMOVED.
NotifiedOnCampaignOptimization	Boolean	False		Indicates if campaign contact is notified about campaign optimization opportunities.
Version	String	True		Version of the account
Reference	String	False		The entity on whose behalf the account advertises.
NotifiedOnCreativeApproval	Boolean	False		Indicates if creative contact is notified when a creative has been reviewed and approved.
AuditStampsCreator	String	True		The person who created audit stamps for the first time
AuditStampsCreatedAt	Datetime	True		The datetime in which the audit stamp was created first
AuditStampsLastModifier	String	True		Last modifier of the Audit stamps
AuditStampsLastModifiedAt	Datetime	True		Last modified datetime of the audit stamps
IsTest	Boolean	False		Flag showing whether this account is marked as a test account. An account can be marked as test only during creation. This is an immutable field.
URN	String	True		The URN of the account.

Read data on your ad-account users.

Table Specific Information

Select

For the AccountURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939'
SELECT * FROM AccountUsers WHERE AccountURN IN ('urn:li:sponsoredAccount:515215939', 'urn:li:sponsoredAccount:515221250')

The rest of the query is processed client-side.

Insert

To create a new account user, use an INSERT statement.

The following columns are required for this operation:

• AccountURN
• UserURN
• Role

INSERT INTO AccountUsers (AccountURN, UserURN, Role) VALUES ('urn:li:sponsoredAccount:515215939', 'urn:li:person:XXXXXXXXXX', 'CAMPAIGN_MANAGER')

Update

To modify an existing account user, use an UPDATE statement. Note that the AccountURN and UserURN columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Role

UPDATE AccountUsers SET Role = 'VIEWER' WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'

Delete

To remove an account user, use a DELETE statement. Note that the AccountURN and UserURN columns are required in the WHERE clause.

DELETE FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'

Columns

Name	Type	ReadOnly	References	Description
AccountURN [KEY]	String	False		The unique identifier of the account in which the user belongs.
UserURN [KEY]	String	False		The unique identifier of the user's LinkedIn profile.
Role	String	False		The user's role. The allowed values are VIEWER, CREATIVE_MANAGER, CAMPAIGN_MANAGER, ACCOUNT_MANAGER, ACCOUNT_BILLING_ADMIN.
CreatedAt	Datetime	True		The time when the user was created.
UpdatedAt	Datetime	True		The time when the user was last modified.

Read data on brand lift tests in your LinkedIn ad-account.

Table Specific Information

Select

For the AccountURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM BrandLiftTests WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM BrandLiftTests WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

For the ExecutionState column, the = operator is fully supported server-side. Refer to the query example below:

SELECT * FROM BrandLiftTests WHERE ExecutionState = 'CREATED';

When no criteria is specified as shown below:

SELECT * FROM BrandLiftTests;

, we internally post-process the query to the following before executing:

SELECT * FROM BrandLiftTests WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new brand lift test, use an INSERT statement.

The following columns are required for this operation:

• AccountURN
• Name
• BrandName
• BrandNameLocaleLanguage
• BrandNameLocaleCountry
• UserState
• StartTime
• EndTime

INSERT INTO BrandLiftTests(AccountURN, Name, BrandName, BrandNameLocaleLanguage, BrandNameLocaleCountry, UserState, StartTime, EndTime) VALUES('urn:li:sponsoredAccount:512859024', 'Lift Test 1', 'Test Brand 1', 'en', 'US', 'READY', '2025-08-01T00:00:00.000-04:00', '2025-10-01T00:00:00.000-04:00')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier of the brand lift test.
AccountURN	String	False		The URN of the ad-account to which this brand lift test belongs.
Name	String	False		The name of the brand lift test.
Description	String	False		The brand lift test's description.
CampaignGroupURN	String	False		The URN of the campaign group to include in the brand lift test. When specified, only campaigns within this group will be measured. Otherwise, the test will analyze all campaigns across the entire ad account.
BrandName	String	False		The brand name used when surveying LinkedIn users with this brand lift test.
BrandNameLocaleLanguage	String	False		The locale language of the brand name. A lowercase two-letter language code as defined by ISO-639.
BrandNameLocaleCountry	String	False		The locale country of the brand name. An uppercase two-letter country code as defined by ISO-3166.
UserState	String	False		The state used by the advertiser to control the brand lift test. The allowed values are DRAFT, READY, CANCELED.
ExecutionState	String	True		The execution state of the brand lift test derived from the 'UserState' column and internal state of the LinkedIn platform. The allowed values are CREATED, SCHEDULED, STARTED, ENDED_RESUMABLE, ENDED.
StartTime	Datetime	False		The scheduled start time of the brand lift test.
EndTime	Datetime	False		The scheduled end time of the brand lift test.
EndedAt	Datetime	True		The actual end time of the brand lift test. LinkedIn may terminate the brand lift test before the time specified in the 'EndTime' column.
EndReason	String	True		The reason why the brand lift test ended. The allowed values are USER_CANCELED, END_DATE_REACHED, CAMPAIGN_GROUP_NOT_RECOVERABLE, ACCOUNT_NOT_RECOVERABLE.
ContentReviewVersion	Long	True		A long value representing the content version that was reviewed in accordance to LinkedIn content policies.

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

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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'

SELECT * FROM CampaignGroups WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign group there are some fields that are required in initial creation which are: Account, Name, ScheduleStartTime, AdAccountId.

While the following parameters are optional: Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleEndTime

Note: When specifying the status of the campaign group in creation it can only be ACTIVE or DRAFT.

    INSERT INTO CampaignGroups (Account, Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime, AdAccountId ) VALUES ( 'urn:li:sponsoredAccount:12345', 'Sample Campaign Group', 'ACTIVE', 5000.00, 'USD', '2025-07-15 09:00:00', '2025-12-31 23:59:59', '123465798' );

Update

To modify an existing campaign group the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime.

    UPDATE CampaignGroups SET Name = 'Updated Campaign Group Name', Status = 'PAUSED', TotalBudgetAmount = 7500.00, TotalBudgetCurrencyCode = 'USD', ScheduleStartTime = '2025-08-01 00:00:00', ScheduleEndTime = '2025-12-31 23:59:59' WHERE Id = 789 AND AdAccountId = '123456789';

Delete

To remove a campaign group the Id and AdAccountId columns are required in the WHERE clause.

    DELETE FROM CampaignGroups WHERE Id = 789 AND AdAccountId = '123456789';

Columns

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

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

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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'

SELECT * FROM Campaigns WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign there are some fields that are required in initial creation which are: Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId.

While the following parameters are optional: AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, ScheduleEndTime, ObjectiveType, ConnectedTelevisionOnly, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles.

     "INSERT INTO Campaigns ( Id, Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId ) VALUES ( 'camp789', 'urn:li:sponsoredAccount:515218099', 'urn:li:sponsoredCampaignGroup:756063323', '150.00', 'USD', 'US', 'en', 'Spring Lead Generation 4', FALSE, '2025-07-01 09:00:00', '2025-07-31 23:59:59', 'DRAFT', 'TEXT_AD', '2.50', 'USD', '515218099' );"
 

Update

To modify an existing campaign group, use an UPDATE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: CampaignGroup, AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, UnitCostAmount, UnitCostCurrency, ObjectiveType, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles.

     "UPDATE Campaigns SET Account = 'urn:li:sponsoredAccount:515218099', CampaignGroup = 'urn:li:sponsoredCampaignGroup:756063323', AssociatedEntity = 'urn:li:organization:101877555', AudienceExpansionEnabled = TRUE, CostType = 'CPM', CreativeSelection = 'OPTIMIZED', DailyBudgetAmount = '250.00', DailyBudgetCurrency = 'USD', Country = 'GB', Language = 'en', Name = 'Updated Campaign Name', OffsiteDeliveryEnabled = FALSE, ScheduleStartTime = '2025-07-15 09:00:00', ScheduleEndTime = '2025-08-15 18:00:00', Status = 'PAUSED', Type = 'SPONSORED_UPDATES', UnitCostAmount = '2.75', UnitCostCurrency = 'USD', ConnectedTelevisionOnly = TRUE, TimeSpanDuration = 7, TimeSpanUnit = 'DAY', Frequency = 3, OptimizationType = 'MAX_FREQUENCY', BlockedIABCategories = 'urn:li:iabCategory:IAB4-2,urn:li:iabCategory:IAB17-31', AllowedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359990,urn:li:adPublisherFile:1360990', BlockedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359991,urn:li:adPublisherFile:1361990' WHERE Id = '403469283' and AdAccountId = '515218099'"
 

Delete

To remove a campaign, use a DELETE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

 DELETE FROM Campaigns WHERE Id = 123456789 AND AdAccountId = '123456789';
 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Numerical identifier for the campaign
Account	String	False		URN identifying the advertising account associated with the Campaign.
CampaignGroup	String	False		Numerical identifier for the campaign group.
AssociatedEntity	String	False		An URN for a strongly associated object, with semantics varying based on the Campaign type.
AudienceExpansionEnabled	Boolean	False		Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria
CostType	String	False		CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link The allowed values are CPM, CPC, CPV.
CreativeSelection	String	False		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	False		The amount of money as a real number string
DailyBudgetCurrency	String	False		ISO currency code
Country	String	False		An uppercase two-letter country code as defined by ISO-3166.
Language	String	False		A lowercase two-letter language code as defined by ISO-639.
Name	String	False		The name of the Campaign
OffsiteDeliveryEnabled	Boolean	False		Allow this campaign access to be served on the LinkedIn Advertising Network.
ScheduleStartTime	Datetime	False		Scheduled date range to run associated creatives.
ScheduleEndTime	Datetime	False		Scheduled date range to run associated creatives.
Status	String	False		Current Status of the campaign The allowed values are ACTIVE, ARCHIVED, COMPLETED, CANCELED, DRAFT, PAUSED, PENDING_DELETION, REMOVED.
Type	String	False		Type of campaign The allowed values are TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC.
UnitCostAmount	String	False		Amount to bid per click, impression, or other event depending on the pricing model.
UnitCostCurrency	String	False		Currency of the UnitCostAmount
ObjectiveType	String	False		The Campaign Objective type. The allowed values are BRAND_AWARENESS, ENGAGEMENT, JOB_APPLICANTS, LEAD_GENERATION, WEBSITE_CONVERSIONS, WEBSITE_VISITS, VIDEO_VIEWS.
AdAccountId	String	False		Id of the account
ConnectedTelevisionOnly	Boolean	False		Flag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false.
TimeSpanDuration	Integer	False		Represents the length of time.
TimeSpanUnit	String	False		Represents the unit of the duration of time
Frequency	Integer	False		The number of times the campaign is shown to a member.
OptimizationType	String	False		Type of the frequency optimization strategy.
OptimizationTargetType	String	False		Determines how this campaign is optimized for spending. If this is not set, there is no optimization. The allowed values are NONE, ENHANCED_CONVERSION, TARGET_COST_PER_CLICK, TARGET_COST_PER_IMPRESSION, TARGET_COST_PER_VIDEO_VIEW, CAP_COST_AND_MAXIMIZE_CLICKS, CAP_COST_AND_MAXIMIZE_IMPRESSIONS, CAP_COST_AND_MAXIMIZE_VIDEO_VIEWS, MAX_REACH, MAX_LEAD, MAX_VIDEO_VIEW, MAX_CONVERSION, MAX_CLICK, MAX_IMPRESSION.
BlockedIABCategories	String	False		The list of mobile application IAB (Interactive Advertising Bureau) categories that are prohibited from serving the campaign's advertisements off-network.
AllowedPublisherRestrictionFiles	String	False		The list of publisher restriction files containing the sites allowed to serve the campaign's advertisements off-network.
BlockedPublisherRestrictionFiles	String	False		The list of publisher restriction files containing the sites prohibited from serving the campaign's advertisements off-network.

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'

Insert

To create a new conversion tracking rule there are some fields that are required in initial creation which are: Account, Name, Type.

While the following parameters are optional: Amount, CurrencyCode, Enabled, PostClickAttributionWindowSize, ViewThroughAttributionWindowSize, AutoAssociationType.

    INSERT INTO Conversions ( Account, Name, Amount, CurrencyCode, Type, Enabled, PostClickAttributionWindowSize, ViewThroughAttributionWindowSize, AutoAssociationType ) VALUES ( 'urn:li:sponsoredAccount:12345', 'Lead Generation Form Submission', '50.00', 'USD', 'SUBMIT_APPLICATION', TRUE, 7, 7, 'OBJECTIVE_BASED' )

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Numerical identifier for the Conversion.
Account	String	False		URN identifying the advertising account associated with the Conversion.
Name	String	False		A short name for this rule, which will be shown in the UI and in reports.
Created	Datetime	True		The timestamp when the Conversion was created.
LastModified	Datetime	True		The timestamp when the Conversion was last modified.
LastCallbackAt	Datetime	True		The timestamp of the last callback from the Conversion.
Amount	String	False		The amount of money as a real number string.
CurrencyCode	String	False		Identifying code for currency type. See currency codes for the valid codes.
Type	String	False		The type of the rule. The allowed values are ADD_TO_CART, DOWNLOAD, INSTALL, KEY_PAGE_VIEW, LEAD, PURCHASE, SIGN_UP, OTHER, SAVE, START_CHECKOUT, SCHEDULE, VIEW_CONTENT, VIEW_VIDEO, ADD_BILLING_INFO, BOOK_APPOINTMENT, REQUEST_QUOTE, SEARCH, SUBSCRIBE, AD_CLICK, AD_VIEW, COMPLETE_SIGNUP, SUBMIT_APPLICATION, PHONE_CALL, INVITE, LOGIN, SHARE, DONATE, ADD_TO_LIST, START_TRIAL, OUTBOUND_CLICK, CONTACT, QUALIFIED_LEAD.
Enabled	Boolean	False		Set to true or false to enable or disable this rule from matching on the advertiser's website.
ImagePixelTag	String	True		The HTML representation of the image pixel.
PostClickAttributionWindowSize	Integer	False		The HTML representation of the image pixel.
ViewThroughAttributionWindowSize	Integer	False		The HTML representation of the image pixel.
AutoAssociationType	String	False		A type enum that defines how campaigns should be associated with the conversion rule. The allowed values are ALL_CAMPAIGNS, OBJECTIVE_BASED.

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

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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 AdAccountId = '510013292'

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

SELECT * FROM Creatives WHERE Campaign = '198952936'

SELECT * FROM Creatives WHERE IntendedStatus = 'ACTIVE'

CUD Operations

Insert

To create a new advertising creative there are some fields that are required in initial creation which are: Campaign, Content, IntendedStatus, AdAccountId.

While the following parameters are optional: CallToActionLabel, CallToActionFormId, Name.

    INSERT INTO Creatives ( Campaign, Content, IntendedStatus, Name, AdAccountId ) VALUES ( 'urn:li:sponsoredCampaign:403027733', ' { \"reference\": \"urn:li:share:7346473724906237952\" }', 'DRAFT', 'Summer Campaign Main Creative', '515218099' );

Update

To modify an existing creative, use an UPDATE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: Content, IntendedStatus, CallToActionLabel, CallToActionFormId, Name.

    UPDATE Creatives SET Campaign = 'urn:li:sponsoredCampaign:403027733', Name = 'Updated Summer Campaign Creative' WHERE Id = 'urn:li:sponsoredCreative:722532663' and AdAccountId = '515218099';

Delete

To remove a creative, use a DELETE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

    DELETE FROM Creatives WHERE Id = 'urn:li:sponsoredCreative:722492693' and AdAccountId = '515218099';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Numerical identifier for the creative.
Account	String	True		URN identifying the advertising account associated with the creative.
Campaign	String	False		URN identifying the campaign associated with the creative.
Content	String	False		Content sponsored in the creative.
CreatedAt	Datetime	True		Datetime when the creative was first created
CreatedBy	String	True		Entity that developed the creative.
IntendedStatus	String	False		Creative user intended status. The allowed values are ACTIVE, REMOVED, PENDING_DELETION, CANCELED, ARCHIVED, DRAFT, PAUSED.
IsServing	Boolean	True		This indicates whether the creative is currently being served or not.
ServingHoldReasons	String	True		Array that contains all the reasons why the creative is not serving.
LastModifiedAt	Datetime	True		Datetime when the creative was last modified.
LastModifiedBy	String	True		Entity that modified the creative.
ReviewStatus	String	True		The current review status of the creative.
IsTest	Boolean	True		Flag showing whether this creative is a test creative, i.e., belongs to a test campaign.
AdAccountId	String	False		Id of the account.
CallToActionLabel	String	False		Label for the CallToAction button. Present only if the campaign objective is LEAD_GENERATION. The allowed values are APPLY, DOWNLOAD, VIEW_QUOTE, LEARN_MORE, SIGN_UP, SUBSCRIBE, REGISTER, REQUEST_DEMO, JOIN, ATTEND, UNLOCK_FULL_DOCUMENT.
CallToActionFormId	String	False	Forms.Id	The Id of the corresponding form which the call to action redirects to. Present only if the campaign objective is LEAD_GENERATION.
RejectionReasons	String	True		A comma-seperated list of values with reasons explaining why the creative has been rejected.
Name	String	False		The name of the creative that can be set by advertiser; primarily used to make it easier to reference a Creative and to recall its purpose.

Query form data for the forms that belong to a specified owner (account).

Table Specific Information

To use this view, the Account column must be specified in the criteria.

Select

For the Account column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. For example:

SELECT * FROM Forms WHERE Account = '512859024';
SELECT * FROM Forms WHERE Account IN ('512859024', '513009855');

When no criteria is specified, such as in this example:

SELECT * FROM Forms;

... we internally post-process the query as follows:

SELECT * FROM Forms WHERE Account IN (SELECT Id FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new form, the following fields are required: Account, Headline, LandingPage, Message, Questions, Name, Country, Language, Status.

The following fields are optional: Description, PrivacyPolicy, LegalDisclaimer.

    INSERT INTO Forms (
       Account,
       Description,
       Headline,
       LandingPage,
       LegalDisclaimer,
       Name,
       PrivacyPolicy,
       Country,
       Language,
       Status,
       Message,
       Questions ) VALUES (
       'urn:li:sponsoredAccount:512859024',
       'This is a sample form used for collecting leads.',
       'Join our newsletter!',
       'https://example.com/thank-you',
       'You agree to our terms and conditions.',
       'Sample Form Name',
       'https://example.com/privacy-policy',
       'us',
       'EN',
       'ARCHIVED',
       'This is a sample message.',
       '[
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"First Name\"
                       }
                   },
                   \"name\": \"firstName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"FIRST_NAME\"
               },
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"Last Name\"
                       }
                   },
                   \"name\": \"lastName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"LAST_NAME\"
               }
           ]' );

Update

To modify an existing form, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are mutable after creation: Description, Headline, LandingPage, Message, LegalDisclaimer, Questions, Name, PrivacyPolicy, Country, Language, Status.

    UPDATE Forms
    SET
       Description = 'New campaign form description.',
       Headline = 'Try our newest product!',
       LandingPage = 'https://example.com/new-landing',
       Message = 'Thank you for your interest! We will contact you soon.',
       LegalDisclaimer = 'By submitting this form you agree to our updated policies.',
       Questions = '[
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"First Name\"
                       }
                   },
                   \"name\": \"firstName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"FIRST_NAME\"
               },
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"Last Name\"
                       }
                   },
                   \"name\": \"lastName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"LAST_NAME\"
               }
           ]',
       Name = 'June 2025 LeadGen Form',
       PrivacyPolicy = 'https://example.com/privacy',
       Country = 'us',
       Language = 'EN',
       Status = 'DRAFT'
    WHERE
       Id = '13420673';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Identifier for the form.
Account	String	False	Accounts.Id	Identifier for the owner of the form. This is the advertiser account.
Created	Timestamp	True		Timestamp for creation of the form.
LastModified	Timestamp	True		Timestamp for last modification of the form.
Description	String	False		Description of the form, visible to both the owner and the viewer.
Headline	String	False		Headline of the form, visible to both the owner and the viewer.
LandingPage	String	False		The landing page URL after the viewer clicks on submit.
Message	String	False		The message displayed to a member after the Lead Form is submitted.
LegalDisclaimer	String	False		Advertiser's legal disclaimer to accompany this form.
Questions	String	False		Questions to request information from the viewer. At least one question should be present.
Name	String	False		Name of the form, visible to the owner of the form but not visible to the viewer.
PrivacyPolicy	String	False		The URL of the privacy policy that covers any data passed to the owner of the form.
Country	String	False		A lowercase two-letter language code as defined by ISO-639-1
Language	String	False		An uppercase two-letter country code as defined by ISO-3166.
ReviewStatus	String	True		The status of the review of the form. The allowed values are AUTO_REJECTED, NEEDS_REVIEW, AUTO_APPROVED, PREAPPROVED, REJECTED, APPROVED, PENDING.
ReviewedAt	Timestamp	True		Timestamp for when the form's review status was initiated/last updated.
Status	String	False		Indicates the state of review for the Lead Form. Can be one of the following: DRAFT, PUBLISHED, or ARCHIVED.
VersionTag	String	True		The number of times the form has been modified.

Read the metadata of the image assets in your accounts.

Table Specific Information

Select

For the AccountURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Images WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM Images WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Images WHERE URN = 'urn:li:image:D4D10AQHqn3iVssgwvA';
SELECT * FROM Images WHERE URN IN ('urn:li:image:D4D10AQHqn3iVssgwvA', 'urn:li:image:D4D10AQGGB-vB21hq4g')

For the two queries above, the values for the AccountURN, MediaLibraryName, and MediaLibraryStatus columns are not returned (always null).

When no criteria is specified as shown below:

SELECT * FROM Images;

, we internally post-process the query to the following before executing:

SELECT * FROM Images WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Update

To modify an existing image, use an UPDATE statement. Note that the URN column and the AccountURN column are required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• MediaLibraryName
• MediaLibraryStatus

UPDATE Images SET MediaLibraryName = 'My Test Image', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:513009855' AND URN = 'urn:li:image:D4D10AQHqn3iVssgwvA'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		The URN of the image.
AccountURN	String	True		The URN of the ad-account to which this image belongs.
MediaLibraryName	String	False		The name of the image asset in the media library.
MediaLibraryStatus	String	False		The status of the image asset in the media library. The allowed values are ACTIVE, ARCHIVED.
OwnerURN	String	True		The URN of the entity who owns the image.
DownloadURL	String	True		The URL for downloading the image.
DownloadURLExpiresAt	Datetime	True		The time when the URL for downloading the image expires.
Status	String	True		The status of the image. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

Read data on message creatives in your LinkedIn ad-account.

Table Specific Information

The URN column is required and must be specified in the criteria to query data from this view.

Select

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM MessageCreatives WHERE URN = 'urn:li:adInMailContent:147611443';
SELECT * FROM MessageCreatives WHERE URN IN ('urn:li:adInMailContent:147611443', 'urn:li:adInMailContent:147551513', 'urn:li:adInMailContent:147581293');

The rest of the query is processed client-side.

Insert

To create a new message creative, use an INSERT statement.

The following columns are required for this operation:

• Name
• Subject
• BodyContent
• SubContent
• SenderURN
• AccountURN

INSERT INTO MessageCreatives (Name, Subject, BodyContent, FooterContent, SubContent, SenderURN, AccountURN) VALUES ('Message Ad 1', 'This is Message Ad 1', 'Message advertisement.', 'Terms and Conditions for Message Ad 1', '{"regular":{"rightRailAdPicture":"urn:li:image:D4D10AQGyoJMKvxNVFA","callToActionLandingPageUrl":"https://test.com","callToActionText":"Learn More"}}', 'urn:li:person:5a_yNKOQQe', 'urn:li:sponsoredAccount:512859024')

Update

To modify an existing message creative, use an UPDATE statement. Note that the URN column is required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Name
• Subject
• BodyContent
• FooterContent
• SubContent
• SenderURN

UPDATE MessageCreatives SET SenderURN = 'urn:li:person:0P8ph3huTC', Subject = 'My Message Ad 1', BodyContent = 'My Message Ad 1 body content.', SubContent = '{"regular":{"callToActionLandingPageUrl":"https://cloud.google.com/apigee?hl=en","callToActionText":"Learn More Here"}}', Name = 'My Message Ad 1', FooterContent = 'My Message Ad 1 footer content.' WHERE URN = 'urn:li:adInMailContent:148081693'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		The URN of the message creative.
Name	String	False		The name of the message creative.
Subject	String	False		The subject of the message creative.
BodyContent	String	False		The HTML content of the message creative.
FooterContent	String	False		The terms and conditions of the message creative, located at the bottom of the message.
SubContent	String	False		The sub-content of the message creative. This can vary depending on the advertiser's goal. Represented in JSON format.
SenderURN	String	False		The URN of the LinkedIn user which will be used to send the message creative to the targeted audience.
AccountURN	String	False		The URN of the ad-account to which this message creative belongs.
CreatedAt	Datetime	True		The time when the message creative was created.
UpdatedAt	Datetime	True		The time when the message creative was last modified.

Retrieve all posts for an organization.

Table Specific Information

Select

The OrganizationId column is required and must be specified in the criteria to use this table.

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.

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

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

The following queries are processed server side:

SELECT * FROM Posts WHERE OrganizationId = '123456789'

Insert

To create a new post, the following fields are required: Author, Commentary, LifecycleState, Visibility, FeedDistribution.

The following fields are optional: Content, IsReshareDisabledByAuthor, ContentLandingPage, DirectSponsoredContentName, DirectSponsoredContentStatus.

    INSERT INTO Posts ( Author, Commentary, Content, IsReshareDisabledByAuthor, LifecycleState, Visibility, ContentLandingPage, DirectSponsoredContentName, DirectSponsoredContentStatus, FeedDistribution ) VALUES ( 'urn:li:organization:12345', 'This is a sample post commentary with important updates.', 'Sample content for the post', FALSE, 'DRAFT', 'PUBLIC', 'https://example.com/landing-page', 'Sample DSC Name', 'ACTIVE', 'MAIN_FEED' );

Update

To modify an existing post, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Commentary
• LifecycleState
• DirectSponsoredContentName
• DirectSponsoredContentStatus

    UPDATE Posts SET Commentary = 'Updated post commentary with new information.' WHERE Id = 'post123456';

Delete

DELETE FROM Posts WHERE Id = 'post123456';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the post.
Author	String	False		Author of the post.
Commentary	String	False		The user generated commentary for the post.
Content	String	False		The posted content.
CreatedAt	Datetime	True		Datetime when the post was created.
IsReshareDisabledByAuthor	Boolean	False		Indicates whether resharing of the post has been disabled by the author.
LastModifiedAt	Datetime	True		Datetime when the post was lastly modified.
LifecycleState	String	False		Lifecycle state of the post. The allowed values are DRAFT, PUBLISHED, PUBLISH_REQUESTED, PUBLISH_FAILED.
PublishedAt	Datetime	True		Datetime at which the content was published.
Visibility	String	False		Visibility restrictions on content. The allowed values are CONNECTIONS, PUBLIC, LOGGED_IN, CONTAINER.
OrganizationId	String	True		Id of the organization who created the post.
ContentLandingPage	String	False		Web page that is opened when the member clicks on the associated content.
IsDirectSponsoredContent	Boolean	True		Whether or not this post is Direct Sponsored Content.
DirectSponsoredContentAdAccount	String	True		The Ad Account that created the Direct Sponsored Content.
DirectSponsoredContentAdType	String	True		The type of Direct Sponsored Content. The allowed values are VIDEO, STANDARD, CAROUSEL, JOB_POSTING, NATIVE_DOCUMENT, EVENT.
DirectSponsoredContentName	String	False		Plain text name of the Direct Sponsored Content post.
DirectSponsoredContentStatus	String	False		The status of the advertising company content. The allowed values are ACTIVE, ARCHIVED.
FeedDistribution	String	False		Distribution of the post both in LinkedIn and externally. The allowed values are MAIN_FEED, NONE.

Read data on publisher restriction files used for restricting the sites which serve your ads off-network.

Table Specific Information

Select

For the AccountURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM PublisherRestrictionFiles WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM PublisherRestrictionFiles WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

For the Id column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM PublisherRestrictionFiles WHERE Id = '1323992';
SELECT * FROM PublisherRestrictionFiles WHERE Id IN ('1323992', '1324991');

When no criteria is specified as shown below:

SELECT * FROM PublisherRestrictionFiles;

, we internally post-process the query to the following before executing:

SELECT * FROM PublisherRestrictionFiles WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new publisher restriction file, use an INSERT statement.

The following columns are required for this operation:

• Name
• RestrictionType
• MediaURN
• AccountURN

INSERT INTO PublisherRestrictionFiles (Name, RestrictionType, MediaURN, AccountURN) VALUES ('Test Blocklist 1', 'BLOCKLIST', 'urn:li:media:/AAYAAgDxAAQAAQAAAAAAAP1BmZKAq-knSwOe7fuAwqPpug.csv', 'urn:li:sponsoredAccount:512859024')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier of the restriction file.
URN	String	True		The URN of the restriction file.
Name	String	False		The name of the restriction file.
RestrictionType	String	False		The restriction type of the file. The allowed values are BLOCKLIST, ALLOWLIST.
MediaURN	String	False		The media URN with details on the uploaded file's location.
Status	String	True		The status of the restriction file.
AccountURN	String	False		The unique identifier of the ad-account in which the restriction file exists.
CreatedAt	Datetime	True		The time when the restriction file was created.
UpdatedAt	Datetime	True		The time when the restriction file was last modified.

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'

Insert

To create a new third-party tracking tag there are some fields that are required in initial creation which are: Creative, Event, Platform, TrackingUrl.

    INSERT INTO ThirdPartyTracking ( Creative, Event, Platform, TrackingUrl ) VALUES ( 'urn:li:sponsoredCreative:722479053', 'IMPRESSION', 'DOUBLECLICK', 'https://serverside.doubleclick.net/ddm/trackimp/N8480.281152LINKEDINUS/B20690748.213458830;dc_trk_aid=512607074;dc_trk_cid=107409144;ord=[timestamp];dc_lat=;dc_rdid=;tag_for_child_directed_treatment=?' );

Delete

To remove a third-party tracking tag from a creative, use a DELETE statement. Note that the Id column is required in the WHERE clause.

DELETE FROM ThirdPartyTracking WHERE Id = '722492693';

Columns

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

Read the metadata of the video assets in your accounts.

Table Specific Information

Select

For the AccountURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Videos WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM Videos WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Videos WHERE URN = 'urn:li:video:D4D10AQGLvWblHowYUw';
SELECT * FROM Videos WHERE URN IN ('urn:li:video:D4D10AQGLvWblHowYUw', 'urn:li:video:D4D10AQFLAKXbRnqwLQ')

For the two queries above, the values for the AccountURN, MediaLibraryName, and MediaLibraryStatus columns are not returned (always null).

When no criteria is specified as shown below:

SELECT * FROM Videos;

, we internally post-process the query to the following before executing:

SELECT * FROM Videos WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Update

To modify an existing image, use an UPDATE statement. Note that the URN column and the AccountURN column are required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• MediaLibraryName
• MediaLibraryStatus

UPDATE Videos SET MediaLibraryName = 'My Test Video', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:515278483' AND URN = 'urn:li:video:D4D10AQGLvWblHowYUw'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		The URN of the video.
AccountURN	String	True		The URN of the ad-account to which this video belongs.
MediaLibraryName	String	False		The name of the video asset in the media library.
MediaLibraryStatus	String	False		The status of the video asset in the media library. The allowed values are ACTIVE, ARCHIVED.
OwnerURN	String	True		The URN of the entity who owns the video.
DownloadURL	String	True		The URL for downloading the video.
DownloadURLExpiresAt	Datetime	True		The time when the URL for downloading the video expires.
Status	String	True		The status of the video. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.
AspectRatioHeight	Decimal	True		The aspect ratio height of the video.
AspectRatioWidth	Decimal	True		The aspect ratio width of the video.
Duration	Long	True		The duration of the video.
ThumbnailDownloadURL	String	True		The URL for downloading the video's thumbnail.
CaptionsDownloadURL	String	True		The URL for downloading the video's captions.

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
AdFormResponses	Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.
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.
ConversationCreativeActions	Read data on actions in the conversation creatives in your LinkedIn ad-account.
ConversationCreatives	Read data on conversation creatives in your LinkedIn ad-account.
Degrees	Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Documents	Read the metadata of the document assets in your accounts.
FieldsOfStudy	Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
GeoLocations	Provides the display name for a given geo Id, or a set of geo Ids.
IABCategories	Read data on Interactive Advertising Bureau (IAB) categories.
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.
OrganizationRoleAssignments	Read access control information for the organizations in which you are a member.
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.
TargetingEntities	Read data on LinkedIn ad-targeting entities.
TargetingFacets	Read data on LinkedIn ad-targeting facets.
Titles	Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.

Table Specific Information

Select

For the Account column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM AdFormResponses WHERE Account = '512859024';
SELECT * FROM AdFormResponses WHERE Account IN ('512859024', '513009855');

We internally post-process the queries above to the following before executing:

SELECT * FROM AdFormResponses WHERE Account = '512859024' AND LeadType = 'STANDARD';
SELECT * FROM AdFormResponses WHERE Account IN ('512859024', '513009855') AND LeadType = 'STANDARD';

For the LeadType column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM AdFormResponses WHERE LeadType = 'STANDARD';
SELECT * FROM AdFormResponses WHERE LeadType IN ('STANDARD', 'COMPANY');

We internally post-process the queries above to the following before executing:

SELECT * FROM AdFormResponses WHERE LeadType = 'STANDARD' AND Account IN (SELECT Id FROM Accounts);
SELECT * FROM AdFormResponses WHERE LeadType IN ('STANDARD', 'COMPANY') AND Account IN (SELECT Id FROM Accounts);

When no criteria is specified as shown below:

SELECT * FROM AdFormResponses;

, we internally post-process the query to the following before executing:

SELECT * FROM AdFormResponses WHERE Account IN (SELECT Id FROM Accounts) AND LeadType = 'STANDARD';

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
Id [KEY]	String		Identifier for the form response.
Account	String	Accounts.Id	Identifier for the owner of the form. This is the advertiser account.
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		Timestamp for 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

Dimensions

Analytics reports provide performance metrics that help evaluate and optimize campaigns. They also require certain mandatory dimensions to be defined. At a minimum, you must specify:

• ReportStartTime
• Granularity

Additionally, there are optional dimensions that can be included to refine the report. For example:

• ReportEndTime
• CampaignType

The dimensions available depend on the value of FinderMethod, which can be either Analytics or Statistics. This setting defines which dimensions are required, which optional dimensions are available, and how filters and metrics can be combined in the query.

• If FinderMethod = Analytics (default), then you may select up to 1 dimension (default: Campaign) from the following options: Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, or MemberCompany.
• If FinderMethod = Statistics, then you may select up to 2 dimensions (default: Campaign) from the following options: Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, or CardIndex.

Metrics

Analytics reports need at least one metric specified, such as Engagement or Conversions, to track campaign performance.

The metrics include:

Impression & Reach Metrics

• Impressions, CardImpressions, ApproximateMemberReach, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost,
  AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost

Click Metrics

• Clicks, ActionClicks, AdUnitClicks, LandingPageClicks, CardClicks, TextUrlClicks, DownloadClicks

Engagement Metrics

• Likes, Shares, Comments, CommentLikes, Follows, Opens, TotalEngagements, OtherEngagements, CompanyPageClicks

Video Metrics

• VideoStats, VideoViews, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoThirdQuartileCompletions, FullScreenPlays

Viral Metrics

• ViralClicks, ViralImpressions, ViralLikes, ViralShares, ViralComments, ViralTotalEngagements, ViralCompanyPageClicks, ViralLandingPageClicks, ViralOtherEngagements, ViralFullScreenPlays, ViralVideoStarts, ViralVideoViews, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoThirdQuartileCompletions, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralCardClicks, ViralCardImpressions

Conversion & Lead Metrics

• ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, PostClickRegistrations, PostViewRegistrations, OneClickLeadFormOpens, OneClickLeads, QualifiedLeads, ValidWorkEmailLeads, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, ConversionValueInLocalCurrency

Cost Metrics

• CostInLocalCurrency, CostInUsd, CostPerQualifiedLead

Other Metrics

• MessagingAdvertSendCount, MessagingAdvertOpenCount, DocumentCompletions, AudiencePenetration, AverageDwellTime

Filters

Filters refine which data is returned in the report and must be valid. If no explicit filters are specified, the report will filter on all the accounts that belong to the user.

The valid filters include:

• Account
• Campaign
• Creative

The Analytics table requires a query structure based on the FinderMethod and the selected Dimensions, Filters, and Metrics. For example:

If FinderMethod = Analytics (only required dimensions + 1 filter + 1 metric):

SELECT ReportStartTime, Granularity, Clicks
FROM Analytics
WHERE FinderMethod = 'Analytics'
  AND ReportStartTime = '2024-08-01'
  AND Granularity = 'MONTHLY'
  AND Account = '123456789';

If FinderMethod = Analytics (required + optional dimensions + multiple metrics and filters):

SELECT ReportStartTime, ReportEndTime, Granularity, CampaignType, Clicks, Impressions, TotalEngagements
FROM Analytics
WHERE FinderMethod = 'Analytics'
  AND ReportStartTime = '2024-08-01'
  AND ReportEndTime = '2024-08-31'
  AND Granularity = 'MONTHLY'
  AND CampaignType = 'SponsoredContent'
  AND Campaign = '987654321';

If FinderMethod = Statistics (required + 2 optional dimensions + multiple metrics):

SELECT ReportStartTime, Granularity, Campaign, Creative, Impressions, Follows
FROM Analytics
WHERE FinderMethod = 'Statistics'
  AND ReportStartTime = '2024-08-01'
  AND Granularity = 'MONTHLY'
  AND Campaign = '987654321'
  AND Creative = '555888999';

Columns

Name	Type	References	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. The allowed values are TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC.
Granularity	String		Time granularity of results. The allowed values are DAILY, MONTHLY, YEARLY, ALL. The default value is MONTHLY.
FinderMethod	String		Designates the query finder. The only allowed values are analytics or statistics. The allowed values are analytics, statistics. The default value is analytics.
ReportStartTime	String		The start time of the period.
ReportEndTime	String		The end time of the period.
EventStage	String		Organize results based on the stage of the live event.
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 Lead Gen 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).
ApproximateMemberReach	Long		The estimated number of unique member accounts with at least one impression. This metric is only available when the number of days in the date range is less than or equal to 92 days. It will be returned only if the following pivots/columns are specified in the query: Creative, Campaign, CampaignGroup, CampaignType and/or ServingLocation. Additionally, it will not be available for the current UTC day. The expected delay for current UTC day will be 24-48 hours. If the present day is specified in ReportEndTime, the date range will only return reach for days where data exists.
ValidWorkEmailLeads	Long		The count of leads with a valid work email that does not use an established free or personal email domain.
PostClickRegistrations	Decimal		The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page.
PostViewRegistrations	Decimal		The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page.
DownloadClicks	Long		The number of times users have indicated the intent to download the media in an ad by clicking the download icon.
QualifiedLeads	Long		The count of qualified leads shared by the advertiser. Qualified lead is a lead that has been deemed more likely to become a customer compared to other leads, based on their engagement and fit.
CostPerQualifiedLead	Decimal		How much money was spent per qualified lead. Ratio is costInLocalCurrency / qualifiedLeads.
MessagingAdvertSendCount	Long		The count of sends of Sponsored Messaging ads.
MessagingAdvertOpenCount	Long		The count of opens of Sponsored Messaging ads.
AudiencePenetration	Decimal		The approximate number of unique members reached by the advertiser divided by the approximate total target audience size. The field will be null if the date range has more than 92 days. This metric only supports the 'CAMPAIGN' pivot. This metric is not returned when using 'MONTHLY' granularity.
AverageDwellTime	Long		Average user dwell time (in seconds). It measures the duration for which more than 50% of the ad's pixels remain visible in the viewport.
DocumentCompletions	Long		The number of times users reached 100% of the document’s length, including those that skipped to this point.

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	References	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	References	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 allowed values are TEXT_AD, SPONSORED_UPDATES. The default value is TEXT_AD.
BidType	String		The bidding type. The allowed values are CPM, CPC, CPV. The default value is CPM.
MatchType	String		The matching type. The allowed values are EXACT, AUDIENCE_EXPANDED. 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.

Read data on actions in the conversation creatives in your LinkedIn ad-account.

Table Specific Information

The ConversationCreativeURN column is required and must be specified in the criteria to query data from this view.

Select

For the ConversationCreativeURN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM ConversationCreativeActions WHERE ConversationCreativeURN = 'urn:li:sponsoredConversation:7069897';
SELECT * FROM ConversationCreativeActions WHERE ConversationCreativeURN IN ('urn:li:sponsoredConversation:7069897', 'urn:li:sponsoredConversation:5833860');

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
URN [KEY]	String		The URN of the action.
ConversationCreativeURN	String	ConversationCreatives.URN	The URN of the conversation creative to which the action belongs.
BodyContent	String		The content of the conversation creative action. Represented in JSON format.
NextActions	String		The next actions that can be taken after the user chooses the current action. Represented in JSON format.

Read data on conversation creatives in your LinkedIn ad-account.

Table Specific Information

The URN column is required and must be specified in the criteria to query data from this view.

Select

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM ConversationCreatives WHERE URN = 'urn:li:sponsoredConversation:7069897';
SELECT * FROM ConversationCreatives WHERE URN IN ('urn:li:sponsoredConversation:5833860', 'urn:li:sponsoredConversation:7069897');

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
URN [KEY]	String		The URN of the conversation creative.
Headline	String		The headline of the conversation creative.
FirstActionURN	String	ConversationCreativeActions.URN	The URN of the first action in the conversation creative that can be taken by the target audience.
AccountURN	String		The URN of the ad-account to which this conversation creative belongs.

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	References	Description
Id	String		Degree id
URN	String		Standardized degree URN
Name	String		Degree name in various locales. Represented as MultiLocaleString type.

Read the metadata of the document assets in your accounts.

Table Specific Information

Select

The URN column is required and must be specified in the criteria to query data from this table.

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Documents WHERE URN = 'urn:li:document:D4D10AQGFjOtqZWBMww';
SELECT * FROM Documents WHERE URN IN ('urn:li:document:D4D10AQGFjOtqZWBMww', 'urn:li:document:D4D10AQFVYoDpcZs86Q')

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
URN [KEY]	String		The URN of the document.
OwnerURN	String		The URN of the entity who owns the document.
DownloadURL	String		The URL for downloading the document.
DownloadURLExpiresAt	Datetime		The time when the URL for downloading the document expires.
Status	String		The status of the document. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

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

Provides the display name for a given geo Id, or a set of geo Ids.

Table Specific Information

To use this view, the Id column must be specified in the criteria.

Select

For The Id column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. For example:

SELECT * FROM GeoLocations WHERE Id = '123456';
SELECT * FROM GeoLocations WHERE Id IN ('123456', '234567');

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
Id [KEY]	String		Identifier for the location.
Name	String		The name of the location.
LocaleCountry	String		An uppercase two-letter country code as defined by ISO-3166.
LocaleLanguage	String		A lowercase two-letter language code as defined by ISO-639.

Read data on Interactive Advertising Bureau (IAB) categories.

Table Specific Information

Select

For the Id column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM IABCategories WHERE Id = 'IAB9-30';
SELECT * FROM IABCategories WHERE Id IN ('IAB9-30', 'IAB17-21');

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the IAB category.
URN	String		The URN of the IAB category.
Name	String		The name of the IAB category in 'en_US' locale.
IABName	String		The original name of the IAB category, as described in the OpenRTB 2.3 specification.
ParentId	String	IABCategories.Id	The unique identifier of the parent IAB category.

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	References	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	References	Description
Id	String		Job function id
URN	String		Standardized Job function URN
Name	String		Job function name in various locales. Represented as MultiLocaleString type.

Read access control information for the organizations in which you are a member.

Columns

Name	Type	References	Description
OrganizationURN [KEY]	String		The unique identifier of the organization.
MemberURN [KEY]	String		The unique profile identifier of the member to which the role has been assigned to.
Role [KEY]	String		The role assigned to the member for managing the organization. The allowed values are ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR.
State	String		The state of the role assignment. The allowed values are APPROVED, REJECTED, REQUESTED, REVOKED.

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	References	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	References	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	References	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	Posts.Id	Id of UGC Post.

Read data on LinkedIn ad-targeting entities.

Table Specific Information

Select

To read data from this view, some conditions must be specified in the criteria of the statement, depending on your use case.

1. Read all ad-targeting entities in a specific ad-targeting facet by using the AD_TARGETING_FACET finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles';
SELECT * FROM TargetingEntities WHERE FacetURN IN ('urn:li:adTargetingFacet:titles', 'urn:li:adTargetingFacet:seniorities');

2. Read all ad-targeting entities which contain the specified characters in their name (and optionally specify the entity type), by using the the TYPEAHEAD finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:locations' AND TypeaheadCriteria = 'Denv';
SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:locations' AND TypeaheadEntityType = 'REGION' AND TypeaheadCriteria = 'Denv';

3. Read all ad-targeting entities which are similar to another ad-targeting entity, by using the SIMILAR_ENTITIES finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles' AND SimilarEntityURN = 'urn:li:title:25194';
SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles' AND SimilarEntityURN IN ('urn:li:title:25194', 'urn:li:title:21544');

NOTE: Some of the use cases above might not apply for specific facets. To learn which finders are applicable to each facet, query the TargetingFacets view.

4. Read all ad-targeting entities with the specified URN-s:

SELECT * FROM TargetingEntities WHERE URN = 'urn:li:title:10738';
SELECT * FROM TargetingEntities WHERE URN IN ('urn:li:title:10738', 'urn:li:title:19179');

Columns

Name	Type	References	Description
URN [KEY]	String		The ad-targeting entity URN.
Name	String		The name of the ad-targeting entity.
FacetURN	String	TargetingFacets.URN	The URN of the ad-targeting facet to use for searching entities.
TypeaheadEntityType	String		The entity type to search for with the 'TYPEAHEAD' finder.
TypeaheadCriteria	String		The name of the entity to search for with the 'TYPEAHEAD' finder.

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
SimilarEntityURN	String		The URN of an entity to use for finding other similar entities with the 'SIMILAR_ENTITIES' finder.

Read data on LinkedIn ad-targeting facets.

Columns

Name	Type	References	Description
URN [KEY]	String		The facet URN.
Name	String		The name of the facet.
EntityTypes	String		The entity types associated with this facet.
EntityFinders	String		The available targeting entity finders for this facet.

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	References	Description
Id	String		Titles id
URN	String		Standardized Titles URN
Name	String		Titles name in various locales. Represented as MultiLocaleString type.
Function	String		The function URN that this title belongs to.
SuperTitle	String		The superTitle URN that this title belongs to.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE 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.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

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.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric 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.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native LinkedIn Marketing Solutions procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

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.

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.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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.

OAuth

---

Property	Description
Scope	A specific scope that the user requires the access token.

SSL

---

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

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn Marketing Solutions.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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

"r_basicprofile,r_emailaddress,r_organization_social,w_organization_social,rw_ads,r_ads,r_ads_reporting,r_marketing_leadgen_automation,r_organization_admin"

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	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

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

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

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

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn Marketing Solutions.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn Marketing Solutions.

Data Type

int

Default Value

100

Remarks

When processing a query, instead of requesting all of the queried data at once from LinkedIn Marketing Solutions, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.