CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるLinkedIn Marketing Solutions へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してLinkedIn Marketing Solutions に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、LinkedIn Marketing Solutions への接続を標準化し、構成することができます。
このページでは、CData Cloud でのLinkedIn Marketing Solutions への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのLinkedIn Marketing Solutions への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してLinkedIn Marketing Solutions からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、LinkedIn Marketing Solutions に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
CData はOAuth アプリケーション認証情報を製品に組み込んでおり、から接続する際に使用できます。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。
以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。
LinkedIn Marketing Solutions で使用するカスタムOAuth アプリケーションを作成するには:
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、LinkedIn Marketing Solutions プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。
スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。
例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。
| Scope | Description |
| r_ads | Read-only access to ad accounts. Required for the following entities:
|
| rw_ads | Read and write access to ad accounts. Required for the following entities:
|
| r_ads_reporting | Read access to ad reporting and analytics data.
Required for the following entities:
|
| r_marketing_leadgen_automation | Access to lead generation forms and marketing automation data.
Required for the following entities:
|
| w_organization_social | Read and write access to organizational social media content.
Required for the following entities:
|
| r_organization_social | Read-only access to organizational social media content. Required for the following entities:
|
| w_member_social | Write access to member social media content. Required for the following entities:
|
| r_member_social | Provides read access to member social media content. Required for the following entities:
|
| r_compliance | Required to retrieve activities for compliance monitoring and archiving. Required for the following entities:
|
| 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:
|
| r_organization_admin | Read-only access to organization data. Required for the following entities:
|
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note: ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| accounts.linkedin.com | TRUE | The subdomain used for OAuth. |
| api.linkedin.com | TRUE | The subdomain used for accessing various services. |
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
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.
The CData Cloud models the data in テーブル so that it can be easily queried and updated.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ストアドプロシージャ are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Cloud はLinkedIn Marketing Solutions のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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.
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'
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);
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;
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'
| 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. 使用できる値は次のとおりです。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 使用できる値は次のとおりです。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.
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.
The following columns are required for this operation:
INSERT INTO AccountUsers (AccountURN, UserURN, Role) VALUES ('urn:li:sponsoredAccount:515215939', 'urn:li:person:XXXXXXXXXX', 'CAMPAIGN_MANAGER')
The following columns are the ones that are mutable after creation:
UPDATE AccountUsers SET Role = 'VIEWER' WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'
DELETE FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'
| 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. 使用できる値は次のとおりです。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.
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.
The following columns are required for this operation:
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')
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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.
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'
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' );
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';
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';
| 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 使用できる値は次のとおりです。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.
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'
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' );"
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'"
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';
| 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 使用できる値は次のとおりです。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 使用できる値は次のとおりです。ACTIVE, ARCHIVED, COMPLETED, CANCELED, DRAFT, PAUSED, PENDING_DELETION, REMOVED | |
| Type | String | False |
Type of campaign 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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.
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'
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' )
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ALL_CAMPAIGNS, OBJECTIVE_BASED |
The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.
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'
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' );
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';
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';
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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).
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.
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\"
}
]' );
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';
| 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. 使用できる値は次のとおりです。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.
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.
The following columns are the ones that are mutable after creation:
UPDATE Images SET MediaLibraryName = 'My Test Image', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:513009855' AND URN = 'urn:li:image:D4D10AQHqn3iVssgwvA'
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD |
Read data on message creatives in your LinkedIn ad-account.
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.
The following columns are required for this operation:
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')
The following columns are the ones that are mutable after creation:
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'
| 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.
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.
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'
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' );
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:
UPDATE Posts SET Commentary = 'Updated post commentary with new information.' WHERE Id = 'post123456';
DELETE FROM Posts WHERE Id = 'post123456';
| 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. 使用できる値は次のとおりです。DRAFT, PUBLISHED, PUBLISH_REQUESTED, PUBLISH_FAILED | |
| PublishedAt | Datetime | True |
Datetime at which the content was published. | |
| Visibility | String | False |
Visibility restrictions on content. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。ACTIVE, ARCHIVED | |
| FeedDistribution | String | False |
Distribution of the post both in LinkedIn and externally. 使用できる値は次のとおりです。MAIN_FEED, NONE |
Read data on publisher restriction files used for restricting the sites which serve your ads off-network.
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.
The following columns are required for this operation:
INSERT INTO PublisherRestrictionFiles (Name, RestrictionType, MediaURN, AccountURN) VALUES ('Test Blocklist 1', 'BLOCKLIST', 'urn:li:media:/AAYAAgDxAAQAAQAAAAAAAP1BmZKAq-knSwOe7fuAwqPpug.csv', 'urn:li:sponsoredAccount:512859024')
| 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. 使用できる値は次のとおりです。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.
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'
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=?' );
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';
| 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. 使用できる値は次のとおりです。IMPRESSION, CLICK | |
| Platform | String | False |
A prediction of how much additional impressions could be generated from a different bid. 使用できる値は次のとおりです。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.
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.
The following columns are the ones that are mutable after creation:
UPDATE Videos SET MediaLibraryName = 'My Test Video', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:515278483' AND URN = 'urn:li:video:D4D10AQGLvWblHowYUw'
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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.
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.
| 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.
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'
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:
Additionally, there are optional dimensions that can be included to refine the report. For example:
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.
Analytics reports need at least one metric specified, such as Engagement or Conversions, to track campaign performance.
The metrics include:
Impression & Reach Metrics
Click Metrics
Engagement Metrics
Video Metrics
Viral Metrics
Conversion & Lead Metrics
Cost Metrics
Other Metrics
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:
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';
| 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.
使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC | |
| Granularity | String | Time granularity of results.
使用できる値は次のとおりです。DAILY, MONTHLY, YEARLY, ALL デフォルト値はMONTHLYです。 | |
| FinderMethod | String | Designates the query finder. The only allowed values are analytics or statistics.
使用できる値は次のとおりです。analytics, statistics デフォルト値は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.
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'
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. |
| Name | Type | References | Description |
| ActiveAudience | Integer | Active audience count for the given targeting criteria. | |
| TotalAudience | Integer | Total audience count for the given targeting criteria. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
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'
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. |
| 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.
使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES デフォルト値はTEXT_ADです。 | |
| BidType | String | The bidding type.
使用できる値は次のとおりです。CPM, CPC, CPV デフォルト値はCPMです。 | |
| MatchType | String | The matching type.
使用できる値は次のとおりです。EXACT, AUDIENCE_EXPANDED デフォルト値はEXACTです。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
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.
| Name | Type | References | Description |
| URN [KEY] | String | The URN of the action. | |
| ConversationCreativeURN | String | 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.
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.
| Name | Type | References | Description |
| URN [KEY] | String | The URN of the conversation creative. | |
| Headline | String | The headline of the conversation creative. | |
| FirstActionURN | String | 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.
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
| 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.
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.
| 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.
使用できる値は次のとおりです。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.
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
| 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.
SELECT * FROM GeoLocations WHERE Id = '123456';
SELECT * FROM GeoLocations WHERE Id IN ('123456', '234567');
The rest of the query is processed client-side.
| 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.
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.
| 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 | 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.
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
| 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.
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
| 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.
| 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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
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
| 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.
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
| 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.
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.
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')
| 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.
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');
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
| 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.
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
| 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. |
ストアドプロシージャはファンクションライクなインターフェースで、LinkedIn Marketing Solutions の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにLinkedIn Marketing Solutions から関連するレスポンスデータを返します。
| Name | Description |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、LinkedIn Marketing Solutions のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Analytics テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Analytics'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのLinkedIn Marketing Solutions プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Analytics テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Analytics'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 | サポートされている数値関数。 | 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 | サポートされている日付および時刻関数。 | 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 | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | 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 | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| Scope | A specific scope that the user requires the access token. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| Scope | A specific scope that the user requires the access token. |
A specific scope that the user requires the access token.
string
"r_basicprofile,r_emailaddress,r_organization_social,w_organization_social,rw_ads,r_ads,r_ads_reporting,r_marketing_leadgen_automation,r_organization_admin"
This property must be set in the connection string to get a scoped token with specific privileges.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
int
100
クエリを処理する際、LinkedIn Marketing Solutions でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。
Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
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.