CData Sync App は、LinkedIn Marketing Solutions データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
LinkedIn Marketing Solutions コネクタはCData Sync アプリケーションから使用可能で、LinkedIn Marketing Solutions からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、主にLinkedIn のバージョン管理されたAPI（現在は202510）を活用しますが、まれに読み書き操作を行うためにLinkedIn のバージョン管理されていないAPI（/v2）を使用することがあります。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、LinkedIn Marketing Solutions プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。
スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。
例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。
To see what scopes are granted by each API product, refer to LinkedIn's documentation.
| Entity | Statement Types | Minimal Required Scopes |
| Accounts | SELECT | r_ads |
| Accounts | INSERT UPDATE DELETE | rw_ads |
| AccountUsers | SELECT | r_ads |
| AccountUsers | INSERT UPDATE DELETE | rw_ads |
| BrandLiftTests | SELECT | r_ads |
| BrandLiftTests | INSERT | rw_ads |
| CampaignGroups | SELECT | r_ads |
| CampaignGroups | INSERT UPDATE DELETE | rw_ads |
| Campaigns | SELECT | r_ads |
| Campaigns | INSERT UPDATE DELETE | rw_ads |
| Conversions | SELECT | r_ads |
| Conversions | INSERT | rw_ads |
| Creatives | SELECT | r_ads |
| Creatives | INSERT UPDATE DELETE | rw_ads |
| DMPSegments | SELECT INSERT UPDATE DELETE | rw_dmp_segments |
| EngagementRules | SELECT | r_ads |
| Forms | SELECT | r_ads |
| Forms | INSERT UPDATE | rw_ads |
| Images | SELECT | r_organization_social |
| Images | UPDATE | w_organization_social |
| MessageCreatives | SELECT | r_ads |
| MessageCreatives | INSERT UPDATE | rw_ads |
| Posts | SELECT | r_ads |
| Posts | INSERT UPDATE DELETE | rw_ads |
| PublisherRestrictionFiles | SELECT | r_ads |
| PublisherRestrictionFiles | INSERT | rw_ads |
| ThirdPartyTracking | SELECT | r_ads |
| ThirdPartyTracking | INSERT DELETE | rw_ads |
| Videos | SELECT | r_organization_social |
| Videos | UPDATE | w_organization_social |
| AdFormResponses | SELECT | r_marketing_leadgen_automation |
| Analytics | SELECT | r_ads_reporting |
| AudienceCount | SELECT | - |
| BudgetPricing | SELECT | r_ads |
| ConversationCreativeActions | SELECT | r_ads |
| ConversationCreativeActions | INSERT UPDATE | rw_ads |
| ConversationCreatives | SELECT | r_ads |
| ConversationCreatives | INSERT | rw_ads |
| Degrees | SELECT | - |
| Documents | SELECT | r_organization_social |
| FieldsOfStudy | SELECT | - |
| GeoLocations | SELECT | - |
| IABCategories | SELECT | - |
| Industries | SELECT | - |
| JobFunctions | SELECT | - |
| OrganizationRoleAssignments | SELECT | r_organization_admin |
| SavedAudienceTemplates | SELECT | r_ads |
| SavedAudienceTemplates | INSERT UPDATE DELETE | rw_ads |
| Seniorities | SELECT | - |
| Skills | SELECT | - |
| SocialActions | SELECT | r_organization_social |
| TargetingEntities | SELECT | - |
| TargetingFacets | SELECT | - |
| Titles | SELECT | - |
| DownloadAsset | EXECUTE | r_organization_social |
| UploadDocument | EXECUTE | w_organization_social |
| UploadImage | EXECUTE | w_organization_social |
| UploadVideo | EXECUTE | w_organization_social |
| UploadVideoCaptions | EXECUTE | - |
| UploadVideoThumbnail | EXECUTE | - |
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note： ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| linkedin.com | True | The main domain used for accessing the main LinkedIn API-s that the Sync App uses. |
| licdn.com | False | The domain used for downloading LinkedIn assets through its CDN such as Images or Videos (see DownloadAsset as well). |
このセクションでは、LinkedIn Marketing Solutions Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
The CData Sync App models entities in the LinkedIn Marketing Solutions API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files. The Sync App uses the LinkedIn Marketing Solutions API to process supported filters. The Sync App processes other filters client-side within the Sync App.
The CData Sync App 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.
Sync App はLinkedIn Marketing Solutions のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Accounts | Retrieves all advertising accounts the authenticated user has access to, filtered by a specified status to help manage and monitor active or inactive accounts. |
| AccountUsers | Provides details about users associated with a specific LinkedIn Ads account, including their roles and permissions. |
| BrandLiftTests | Retrieves information on brand lift tests that measure how advertising impacts brand perception within your LinkedIn Ads account. |
| CampaignGroups | Lists all campaign groups available to the authenticated user, filtered by status, to help organize and manage related campaigns. |
| Campaigns | Retrieves campaigns in your LinkedIn Ads account by specified status, allowing performance tracking and campaign management. |
| ConversationCreativeActions | Provides data on user interactions with conversation ad creatives, including clicks and message-level engagement metrics. |
| ConversationCreatives | Returns details of conversation ad creatives used in your LinkedIn Ads account, including creative content and configuration. |
| Conversions | Lists conversion events that represent valuable actions taken by users, such as form submissions or purchases, linked to your ads. |
| Creatives | Retrieves ad creative details, including identifiers, campaign references, and statuses, to support creative management and optimization. |
| DMPSegments | Retrieve and manage LinkedIn Data Management Platform (DMP) segments for B2B audience targeting and custom audience creation across ad exchanges. |
| Forms | Retrieves forms owned by a specific account, including metadata and configuration details for LinkedIn Lead Gen Forms. |
| Images | Retrieves metadata for image assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information. |
| MessageCreatives | Provides details about message ad creatives in your LinkedIn Ads account, including content, delivery, and performance attributes. |
| Posts | Retrieves posts created for a LinkedIn organization, enabling content analysis and engagement tracking. |
| PublisherRestrictionFiles | Retrieves data about publisher restriction files that define which off-network sites are allowed or blocked for ad serving. |
| SavedAudienceTemplates | Read and write saved audience targeting templates in your ad-accounts. |
| ThirdPartyTracking | Retrieves existing third-party tracking tags used to monitor conversions and engagement across external platforms. |
| Videos | Retrieves metadata for video assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information. |
Retrieves all advertising accounts the authenticated user has access to, filtered by a specified status to help manage and monitor active or inactive accounts.
The Accounts view returns a list of the accounts that belong to the authenticated user so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Accounts 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 |
Unique identifier of the advertising account within LinkedIn Ads. | |
| Name | String | False |
Display name assigned to the account, typically used to identify it in reports and the Campaign Manager interface. | |
| Currency | String | False |
Currency code defined by ISO 4217 representing the currency used for billing and reporting in this account. | |
| Type | String | False |
Specifies the type of advertising account, such as a business or enterprise account. 使用できる値は次のとおりです。BUSINESS, ENTERPRISE | |
| NotifiedOnCreativeRejection | Boolean | False |
Indicates whether the creative contact receives notifications when a creative is rejected due to policy or content issues. | |
| NotifiedOnEndOfCampaign | Boolean | False |
Indicates whether the campaign contact receives a notification when a campaign associated with the account has finished running. | |
| Status | String | False |
Current operational status of the account. 使用できる値は次のとおりです。ACTIVE, PENDING_DELETION, CANCELED, DRAFT, REMOVED | |
| NotifiedOnCampaignOptimization | Boolean | False |
Indicates whether the campaign contact is notified about optimization recommendations or performance improvement opportunities. | |
| Version | String | True |
Represents the version or revision identifier for the account record, used to manage updates and concurrency. | |
| Reference | String | False |
Identifies the entity or organization on whose behalf the account runs advertisements. | |
| NotifiedOnCreativeApproval | Boolean | False |
Indicates whether the creative contact receives a notification when a creative has been reviewed and approved for use. | |
| AuditStampsCreator | String | True |
Name or identifier of the user who initially created the audit record for this account. | |
| AuditStampsCreatedAt | Datetime | True |
Date and time when the account's audit record was first created. | |
| AuditStampsLastModifier | String | True |
Name or identifier of the user who last modified the audit record for this account. | |
| AuditStampsLastModifiedAt | Datetime | True |
Date and time when the account's audit record was most recently updated. | |
| IsTest | Boolean | False |
If the value is 'true', the account is designated as a test account, which can only be set during account creation and cannot be changed later. | |
| URN | String | True |
Uniform Resource Name (URN) that uniquely identifies the account within LinkedIn's system. |
Provides details about users associated with a specific LinkedIn Ads account, including their roles and permissions.
SELECT * FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939'
SELECT * FROM AccountUsers WHERE AccountURN IN ('urn:li:sponsoredAccount:515215939', 'urn:li:sponsoredAccount:515221250')
SELECT * FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:tOc1bFjxgJ'
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 |
Uniform Resource Name (URN) that uniquely identifies the advertising account to which the user is assigned. | |
| UserURN [KEY] | String | False |
URN that uniquely identifies the LinkedIn member associated with this account. | |
| Role | String | False |
Specifies the user's assigned role within the advertising account. 使用できる値は次のとおりです。VIEWER, CREATIVE_MANAGER, CAMPAIGN_MANAGER, ACCOUNT_MANAGER, ACCOUNT_BILLING_ADMIN | |
| CreatedAt | Datetime | True |
Date and time when the user record was first added to the account. | |
| UpdatedAt | Datetime | True |
Date and time when the user record was last updated, reflecting any changes to role or access. |
Retrieves information on brand lift tests that measure how advertising impacts brand perception within your LinkedIn Ads 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 |
Unique identifier assigned to the brand lift test within LinkedIn Ads. | |
| AccountURN | String | False |
Uniform Resource Name (URN) that identifies the advertising account associated with the brand lift test. | |
| Name | String | False |
Name assigned to the brand lift test for tracking and reporting purposes. | |
| Description | String | False |
Detailed description of the brand lift test, outlining its purpose or scope. | |
| CampaignGroupURN | String | False |
URN that identifies the campaign group included in the brand lift test. When specified, only campaigns within this group are measured; otherwise, all campaigns under the ad account are analyzed. | |
| BrandName | String | False |
Name of the brand used when surveying LinkedIn members as part of the brand lift study. | |
| BrandNameLocaleLanguage | String | False |
Specifies the locale language of the brand name using a lowercase two-letter code as defined by ISO 639. | |
| BrandNameLocaleCountry | String | False |
Specifies the locale country of the brand name using an uppercase two-letter code as defined by ISO 3166. | |
| UserState | String | False |
Represents the advertiser-defined state used to manage or control the brand lift test. 使用できる値は次のとおりです。DRAFT, READY, CANCELED | |
| ExecutionState | String | True |
Indicates the current execution state of the brand lift test, derived from both the UserState value and LinkedIn's internal test status. 使用できる値は次のとおりです。CREATED, SCHEDULED, STARTED, ENDED_RESUMABLE, ENDED | |
| StartTime | Datetime | False |
Planned start date and time for the brand lift test. | |
| EndTime | Datetime | False |
Planned end date and time for the brand lift test. | |
| EndedAt | Datetime | True |
Actual date and time when the brand lift test concluded. LinkedIn may end the test earlier than the scheduled 'EndTime'. | |
| EndReason | String | True |
Describes the reason why the brand lift test ended. 使用できる値は次のとおりです。USER_CANCELED, END_DATE_REACHED, CAMPAIGN_GROUP_NOT_RECOVERABLE, ACCOUNT_NOT_RECOVERABLE | |
| ContentReviewVersion | Long | True |
Version number indicating the specific content iteration reviewed for compliance with LinkedIn's advertising content policies. |
Lists all campaign groups available to the authenticated user, filtered by status, to help organize and manage related campaigns.
The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM CampaignGroups 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 |
Unique numerical identifier assigned to the campaign group. | |
| Account | String | False |
Uniform Resource Name (URN) that identifies the advertising account associated with the campaign group. This value cannot be changed after creation. | |
| Name | String | False |
Descriptive name of the campaign group, used to identify and manage related campaigns within the account. | |
| Status | String | False |
Indicates the current operational status of the campaign group. 使用できる値は次のとおりです。ACTIVE, PENDING_DELETION, REMOVED, PAUSED, ARCHIVED, DRAFT, CANCELED | |
| TotalBudgetAmount | Decimal | False |
Specifies the maximum total budget allocated for all campaigns within the campaign group. | |
| TotalBudgetCurrencyCode | String | False |
Currency code defined by the ISO that specifies the currency for the total budget. It must match the parent account's currency. | |
| ScheduleStartTime | Datetime | False |
Start date and time for when the campaign group becomes active and eligible to run associated campaigns. | |
| ScheduleEndTime | Datetime | False |
End date and time defining when the campaign group stops running associated campaigns. | |
| Backfilled | Boolean | True |
If the value is 'true', the campaign group was created to backfill pre-existing campaigns rather than being created organically. | |
| AdAccountId | String | False |
Unique identifier of the advertising account linked to the campaign group. | |
| URN | String | True |
URN that uniquely identifies the campaign group within LinkedIn Ads. |
Retrieves campaigns in your LinkedIn Ads account by specified status, allowing performance tracking and campaign management.
The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Campaigns 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, PoliticalIntent.
"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, PoliticalIntent.
"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 |
Unique numerical identifier assigned to the campaign. | |
| Account | String | False |
Uniform Resource Name (URN) that identifies the advertising account associated with the campaign. | |
| CampaignGroup | String | False |
Numerical identifier of the campaign group that the campaign belongs to. | |
| AssociatedEntity | String | False |
URN that identifies a related object, with the specific meaning depending on the campaign type (for example, a creative or targeting entity). | |
| AudienceExpansionEnabled | Boolean | False |
Identifies whether or not Audience Expansion is enabled, allowing LinkedIn to broaden targeting by including members with similar attributes to the defined audience. | |
| CostType | String | False |
Specifies the campaign's pricing model: cost-per-click (CPC) or cost-per-impression (CPM). 使用できる値は次のとおりです。CPM, CPC, CPV | |
| CreativeSelection | String | False |
Determines how creatives are rotated or prioritized. ROUND_ROBIN evenly rotates creatives, while OPTIMIZED favors those expected to perform better. | |
| DailyBudgetAmount | String | False |
Specifies the campaign's daily spending limit as a real number string. | |
| DailyBudgetCurrency | String | False |
Currency code defined by the ISO that specifies the currency for the daily budget. | |
| Country | String | False |
Specifies the country where the campaign is served, using an uppercase two-letter code defined by ISO 3166. | |
| Language | String | False |
Specifies the campaign language using a lowercase two-letter code defined by '. | |
| Name | String | False |
Name assigned to the campaign, used to identify it in reports and within the account. | |
| OffsiteDeliveryEnabled | Boolean | False |
Identifies whether or not the campaign is allowed to serve ads on the LinkedIn Audience Network beyond the LinkedIn platform. | |
| ScheduleStartTime | Datetime | False |
Start date and time when the campaign becomes active and eligible to serve ads. | |
| ScheduleEndTime | Datetime | False |
End date and time when the campaign is scheduled to stop serving ads. | |
| Status | String | False |
Indicates the current operational status of the campaign. 使用できる値は次のとおりです。ACTIVE, ARCHIVED, COMPLETED, CANCELED, DRAFT, PAUSED, PENDING_DELETION, REMOVED | |
| Type | String | False |
Specifies the campaign type. 使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC | |
| UnitCostAmount | String | False |
Specifies the bid amount per click, impression, or other event, depending on the campaign's pricing model. | |
| UnitCostCurrency | String | False |
Specifies the currency used for the bid amount, matching the account's currency settings. | |
| ObjectiveType | String | False |
Defines the primary objective of the campaign. 使用できる値は次のとおりです。BRAND_AWARENESS, ENGAGEMENT, JOB_APPLICANTS, LEAD_GENERATION, WEBSITE_CONVERSIONS, WEBSITE_VISITS, VIDEO_VIEWS | |
| AdAccountId | String | False |
Unique identifier of the advertising account linked to the campaign. | |
| ConnectedTelevisionOnly | Boolean | False |
Identifies whether or not the campaign is designated as a Connected Television (CTV)–only campaign, meaning ads are shown exclusively on connected TV devices. | |
| TimeSpanDuration | Integer | False |
Specifies the numerical duration value for the campaign's time span. | |
| TimeSpanUnit | String | False |
Specifies the time unit associated with the campaign's duration, such as days or weeks. | |
| Frequency | Integer | False |
Defines how many times a campaign's ad is shown to the same member within a given period. | |
| OptimizationType | String | False |
Specifies the optimization strategy applied to control ad frequency and performance. | |
| OptimizationTargetType | String | False |
Defines how the campaign is optimized for spending or outcomes. If not set, no optimization strategy is applied. 使用できる値は次のとおりです。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 |
Lists Interactive Advertising Bureau (IAB) mobile application categories that are blocked from serving this campaign's ads off-network. | |
| AllowedPublisherRestrictionFiles | String | False |
Lists publisher restriction files that define which off-network sites are approved to serve the campaign's ads. | |
| BlockedPublisherRestrictionFiles | String | False |
Lists publisher restriction files that define which off-network sites are prohibited from serving the campaign's ads. | |
| PoliticalIntent | String | False |
The political intent of the campaign. 使用できる値は次のとおりです。NOT_DECLARED, NOT_POLITICAL, POLITICAL デフォルト値はNOT_DECLAREDです。 |
Provides data on user interactions with conversation ad creatives, including clicks and message-level engagement metrics.
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.
To insert a new conversation creative action, specify the ConversationCreativeURN along with the BodyContent and NextActions columns.
INSERT INTO ConversationCreativeActions (ConversationCreativeURN, BodyContent, NextActions)
VALUES ('urn:li:sponsoredConversation:7932433', '{
"text": "test conversation message"
}', '{
"options":[
{
"replyType": "SIMPLE_REPLY",
"optionText": "Simple reply"
}
]
}');
To modify an existing conversation creative action, use an UPDATE statement. Note that both the ConversationCreativeURN and URN columns are required in the WHERE clause.
UPDATE ConversationCreativeActions SET BodyContent = '{
"text": "Updated text"
}'
WHERE ConversationCreativeURN = 'urn:li:sponsoredConversation:8584906' AND URN = 'urn:li:sponsoredMessageContent:(urn:li:sponsoredConversation:8584906,12219786)';
| Name | Type | ReadOnly | References | Description |
| URN [KEY] | String | True |
Uniform Resource Name (URN) that uniquely identifies the conversation creative action. | |
| ConversationCreativeURN | String | False |
URN that identifies the conversation creative associated with this action. | |
| BodyContent | String | False |
Contains the message content or body text of the conversation creative action, represented in JSON format. | |
| NextActions | String | False |
Specifies the next possible user actions that follow the current interaction, represented in JSON format. |
Returns details of conversation ad creatives used in your LinkedIn Ads account, including creative content and configuration.
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.
INSERT INTO ConversationCreatives (AccountURN, Headline) VALUES ('urn:li:sponsoredAccount:515215939', 'Test conversation')
| Name | Type | ReadOnly | References | Description |
| URN [KEY] | String | True |
Uniform Resource Name (URN) that uniquely identifies the conversation creative. | |
| Headline | String | False |
Headline text displayed in the conversation creative, typically introducing the message or offer. | |
| FirstActionURN | String | True |
URN that identifies the first action available to the target audience within the conversation creative. | |
| AccountURN | String | False |
URN that identifies the advertising account associated with this conversation creative. |
Lists conversion events that represent valuable actions taken by users, such as form submissions or purchases, linked to your ads.
The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Conversions 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 |
Unique numerical identifier assigned to the conversion. | |
| Account | String | False |
Uniform Resource Name (URN) that identifies the advertising account associated with the conversion. | |
| Name | String | False |
Short, descriptive name for the conversion rule, displayed in the user interface and in reports. | |
| Created | Datetime | True |
Date and time when the conversion rule was originally created. | |
| LastModified | Datetime | True |
Date and time when the conversion rule was most recently updated. | |
| LastCallbackAt | Datetime | True |
Date and time when the most recent conversion callback event was received. | |
| Amount | String | False |
Specifies the monetary value associated with the conversion as a real number string. | |
| CurrencyCode | String | False |
Currency code representing the currency type used for the conversion value. | |
| Type | String | False |
Defines the type of conversion 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 |
If the value is 'true', the conversion rule is active and tracks conversions on the advertiser's website. If 'false', it is disabled. | |
| ImagePixelTag | String | True |
HTML code snippet representing the image pixel used to track conversion activity on the advertiser's website. | |
| PostClickAttributionWindowSize | Integer | False |
Specifies the time window, in days, during which a conversion is attributed to a user who clicked the ad. | |
| ViewThroughAttributionWindowSize | Integer | False |
Specifies the time window, in days, during which a conversion is attributed to a user who viewed (but did not click) the ad. | |
| AutoAssociationType | String | False |
Defines how campaigns are automatically associated with the conversion rule based on configuration settings. 使用できる値は次のとおりです。ALL_CAMPAIGNS, OBJECTIVE_BASED |
Retrieves ad creative details, including identifiers, campaign references, and statuses, to support creative management and optimization.
The Creatives view returns a list of the creatives that belong to the authenticated user so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Creatives 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 |
Unique numerical identifier assigned to the creative. | |
| Account | String | True |
Uniform Resource Name (URN) that identifies the advertising account associated with the creative. | |
| Campaign | String | False |
URN that identifies the campaign under which the creative is managed. | |
| Content | String | False |
Specifies the content promoted in the creative, such as text, image, or video assets. | |
| CreatedAt | Datetime | True |
Date and time when the creative was first created. | |
| CreatedBy | String | True |
Entity or user who originally developed and uploaded the creative. | |
| IntendedStatus | String | False |
Represents the user-defined intended status of the creative. 使用できる値は次のとおりです。ACTIVE, REMOVED, PENDING_DELETION, CANCELED, ARCHIVED, DRAFT, PAUSED | |
| IsServing | Boolean | True |
If the value is 'true', the creative is currently being served in active campaigns; if 'false', it is not being delivered. | |
| ServingHoldReasons | String | True |
Lists all reasons why the creative is currently on hold and not serving, such as policy violations or budget constraints. | |
| LastModifiedAt | Datetime | True |
Date and time when the creative was last modified. | |
| LastModifiedBy | String | True |
Entity or user who last updated the creative. | |
| ReviewStatus | String | True |
Indicates the current moderation status of the creative, such as approved, rejected, or pending review. | |
| IsTest | Boolean | True |
If the value is 'true', the creative is designated as a test creative that belongs to a test campaign. | |
| AdAccountId | String | False |
Unique identifier of the advertising account linked to the creative. | |
| CallToActionLabel | String | False |
Text label displayed on the call-to-action (CTA) button, available only when 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 |
Identifier of the lead generation form associated with the CTA button, available only for lead generation campaigns. |
| RejectionReasons | String | True |
Comma-separated list of reasons explaining why the creative was rejected during the review process. | |
| Name | String | False |
Name assigned to the creative by the advertiser, used for easy identification and organization. |
Retrieve and manage LinkedIn Data Management Platform (DMP) segments for B2B audience targeting and custom audience creation across ad exchanges.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id and AccountURN columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM DMPSegments WHERE Id = '43318048';
SELECT * FROM DMPSegments WHERE AccountURN = 'urn:li:sponsoredAccount:518270328';
To insert a new DMP segment, specify the Name, SourcePlatform, AccountURN, Type, and Destinations columns.
INSERT INTO DMPSegments (Name, SourcePlatform, AccountURN, Type, Destinations)
VALUES ('DMP Segment Name', 'VIDEO_ADS', 'urn:li:sponsoredAccount:518270328', 'USER', '[
{
"destination":"LINKEDIN"
}
]');
To modify an existing DMP segment, use an UPDATE statement. Note that the Id column is required in the WHERE clause.
The following columns can be updated: Name, Description, and SourceSegmentId.
UPDATE DMPSegments SET Name = 'DMPSegment Update', Description = 'Desc', SourceSegmentId = '159753' WHERE Id = '43318048';
To remove a DMP segment, use a DELETE statement. Note that the Id column is required in the WHERE clause.
DELETE FROM DMPSegments WHERE Id = 43333010;
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The DMP segment id. | |
| AccountURN | String | False |
Accounts.URN |
The AccountURN of the DMP segment. |
| Name | String | False |
The name of the DMP segment. | |
| Description | String | False |
The description of the DMP segment. | |
| Type | String | False |
The type of the DMP segment. | |
| Destinations | Object | False |
The destinations of the DMP segment. | |
| SourcePlatform | String | False |
The source platform of the DMP segment. | |
| SourceSegmentId | String | False |
The foreign key on the source platform. This is an optional field that will be indexed and can be used by the source platform to find their segments. |
Retrieves forms owned by a specific account, including metadata and configuration details for LinkedIn Lead Gen Forms.
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, HiddenFields.
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, HiddenFields.
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 |
Unique identifier assigned to the lead form. | |
| Account | String | False |
Accounts.Id |
Identifier of the advertiser account that owns the lead form. |
| Created | Timestamp | True |
Date and time when the form was initially created. | |
| LastModified | Timestamp | True |
Date and time when the form was last modified. | |
| Description | String | False |
Descriptive text explaining the purpose or content of the form, visible to both the owner and the viewer. | |
| Headline | String | False |
Headline text displayed at the top of the form, visible to both the owner and the viewer. | |
| LandingPage | String | False |
URL of the landing page where the viewer is redirected after submitting the form. | |
| Message | String | False |
Confirmation message shown to the member after the lead form is successfully submitted. | |
| LegalDisclaimer | String | False |
Advertiser-provided legal disclaimer displayed alongside the form to inform users about data use or consent. | |
| Questions | String | False |
List of questions used to collect information from the viewer. At least one question must be defined. | |
| Name | String | False |
Internal name of the form, visible only to the owner for identification and management purposes. | |
| PrivacyPolicy | String | False |
URL of the advertiser's privacy policy covering the handling of data collected through the form. | |
| Country | String | False |
Two-letter lowercase language code defined by ISO-639-1 representing the form's language setting. | |
| Language | String | False |
Two-letter uppercase country code defined by ISO 3166 representing the form's regional context. | |
| ReviewStatus | String | True |
Indicates the current review status of the lead form. 使用できる値は次のとおりです。AUTO_REJECTED, NEEDS_REVIEW, AUTO_APPROVED, PREAPPROVED, REJECTED, APPROVED, PENDING | |
| ReviewedAt | Timestamp | True |
Date and time when the form's review status was last updated or initiated. | |
| Status | String | False |
Specifies the overall state of the lead form. Possible values are DRAFT, PUBLISHED, or ARCHIVED. | |
| VersionTag | String | True |
Indicates the version or number of times the form has been modified. | |
| HiddenFields | String | False |
Defines hidden fields used to track key form attributes, represented in JSON format for additional metadata storage. |
Retrieves metadata for image assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.
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 changeable 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 |
Uniform Resource Name (URN) that uniquely identifies the image asset within LinkedIn. | |
| AccountURN | String | True |
URN that identifies the advertising account associated with the image asset. | |
| MediaLibraryName | String | False |
Display name of the image asset as it appears in the media library. | |
| MediaLibraryStatus | String | False |
Indicates the current status of the image asset in the media library, such as active or archived. 使用できる値は次のとおりです。ACTIVE, ARCHIVED | |
| OwnerURN | String | True |
URN that identifies the entity or account that owns the image asset. | |
| DownloadURL | String | True |
URL used to download the image file from LinkedIn's asset library. | |
| DownloadURLExpiresAt | Datetime | True |
Date and time when the download URL for the image asset expires and is no longer valid. | |
| Status | String | True |
Represents the current processing or availability status of the image asset. 使用できる値は次のとおりです。PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD |
Provides details about message ad creatives in your LinkedIn Ads account, including content, delivery, and performance attributes.
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 |
Uniform Resource Name (URN) that uniquely identifies the message creative. | |
| Name | String | False |
Display name of the message creative, used to identify it in the advertiser's account. | |
| Subject | String | False |
Subject line of the message creative, displayed to recipients in their LinkedIn inbox. | |
| BodyContent | String | False |
Main body of the message creative, formatted in HTML to include text, links, and visual elements. | |
| FooterContent | String | False |
Footer section of the message creative containing terms, conditions, or disclaimers displayed at the bottom of the message. | |
| SubContent | String | False |
Additional sub-content associated with the message creative, which varies depending on the advertiser's objective. It is represented in JSON format. | |
| SenderURN | String | False |
URN that identifies the LinkedIn member profile used as the sender of the message creative. | |
| AccountURN | String | False |
URN that identifies the advertising account associated with the message creative. | |
| CreatedAt | Datetime | True |
Date and time when the message creative was created. | |
| UpdatedAt | Datetime | True |
Date and time when the message creative was last updated. |
Retrieves posts created for a LinkedIn organization, enabling content analysis and engagement tracking.
The OrganizationId column is required and must be specified in the criteria to use this table.
The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
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 |
Unique identifier assigned to the post. | |
| Author | String | False |
Identifier of the author who created the post, which can represent either a LinkedIn member or organization. | |
| Commentary | String | False |
User-generated commentary or text content included in the post. | |
| Content | String | False |
Main content of the post, which may include text, images, videos, or links. | |
| CreatedAt | Datetime | True |
Date and time when the post was originally created. | |
| IsReshareDisabledByAuthor | Boolean | False |
If the value is 'true', the post cannot be reshared because the author has disabled resharing. | |
| LastModifiedAt | Datetime | True |
Date and time when the post was last modified. | |
| LifecycleState | String | False |
Indicates the current lifecycle state of the post. 使用できる値は次のとおりです。DRAFT, PUBLISHED, PUBLISH_REQUESTED, PUBLISH_FAILED | |
| PublishedAt | Datetime | True |
Date and time when the post was published and made visible to its audience. | |
| Visibility | String | False |
Defines the visibility settings of the post. 使用できる値は次のとおりです。CONNECTIONS, PUBLIC, LOGGED_IN, CONTAINER | |
| OrganizationId | String | True |
Identifier of the organization that created or owns the post. | |
| ContentLandingPage | String | False |
URL of the landing page opened when a member clicks on the content associated with the post. | |
| IsDirectSponsoredContent | Boolean | True |
If the value is 'true', the post is classified as Direct Sponsored Content created for advertising purposes. | |
| DirectSponsoredContentAdAccount | String | True |
Identifier of the advertising account that created the Direct Sponsored Content. | |
| DirectSponsoredContentAdType | String | True |
Specifies the type of Direct Sponsored Content. 使用できる値は次のとおりです。VIDEO, STANDARD, CAROUSEL, JOB_POSTING, NATIVE_DOCUMENT, EVENT | |
| DirectSponsoredContentName | String | False |
Plain-text name assigned to the Direct Sponsored Content post for identification purposes. | |
| DirectSponsoredContentStatus | String | False |
Indicates the current status of the Direct Sponsored Content. 使用できる値は次のとおりです。ACTIVE, ARCHIVED | |
| FeedDistribution | String | False |
Specifies how the post is distributed, including whether it appears on LinkedIn feeds or external partner networks. 使用できる値は次のとおりです。MAIN_FEED, NONE |
Retrieves data about publisher restriction files that define which off-network sites are allowed or blocked for ad serving.
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 |
Unique identifier assigned to the publisher restriction file. | |
| URN | String | True |
Uniform Resource Name (URN) that uniquely identifies the publisher restriction file within LinkedIn. | |
| Name | String | False |
Name of the publisher restriction file, used for identification and reference. | |
| RestrictionType | String | False |
Specifies the type of restriction defined in the file. 使用できる値は次のとおりです。BLOCKLIST, ALLOWLIST | |
| MediaURN | String | False |
URN that identifies the media asset containing the uploaded restriction file and its storage location. | |
| Status | String | True |
Indicates the current status of the restriction file, such as active, processing, or archived. | |
| AccountURN | String | False |
URN that identifies the advertising account in which the restriction file resides. | |
| CreatedAt | Datetime | True |
Date and time when the restriction file was created. | |
| UpdatedAt | Datetime | True |
Date and time when the restriction file was last updated. |
Read and write saved audience targeting templates in your ad-accounts.
SELECT * FROM SavedAudienceTemplates WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM SavedAudienceTemplates WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')
When no criteria are specified, as in the statement below:
SELECT * FROM SavedAudienceTemplates;
We internally post-process the query to the following before executing:
SELECT * FROM SavedAudienceTemplates 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 SavedAudienceTemplates (AccountURN, Name, Description, TargetingCriteria)
VALUES ('urn:li:sponsoredAccount:515565126', 'Saved Template 1', 'Saved Template 1',
'{
"include": {
"and": [
{
"or": {
"urn:li:adTargetingFacet:locations": [
"urn:li:geo:90000034",
"urn:li:geo:104079912"
]
}
},
{
"or": {
"urn:li:adTargetingFacet:titles": [
"urn:li:title:1",
"urn:li:title:107"
]
}
}
]
},
"exclude": {
"or": {
"urn:li:adTargetingFacet:degrees": [
"urn:li:degree:1000",
"urn:li:degree:1100"
]
}
}
}');
The following columns are the ones that are mutable after creation:
UPDATE SavedAudienceTemplates
SET Name = 'My Audience Template 1', Description = 'My Audience Template 1', TargetingCriteria =
'{
"include": {
"and": [
{
"or": {
"urn:li:adTargetingFacet:locations": [
"urn:li:geo:90000033",
"urn:li:geo:104079911"
]
}
},
{
"or": {
"urn:li:adTargetingFacet:titles": [
"urn:li:title:2",
"urn:li:title:106"
]
}
}
]
},
"exclude": {
"or": {
"urn:li:adTargetingFacet:degrees": [
"urn:li:degree:1000",
"urn:li:degree:1100"
]
}
}
}' WHERE Id = '42481729';
DELETE FROM SavedAudienceTemplates WHERE Id = '42481729'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique template identifier. | |
| Name | String | False |
The template name, max 100 characters. | |
| Description | String | False |
The template description, max 500 characters. | |
| ApproximateReach | Long | True |
The estimated number of targetable LinkedIn members. | |
| TargetingCriteria | String | False |
The targeting facets criteria matching the targeted audience. Represented in JSON format. | |
| AccountURN | String | False |
The URN of the associated ad-account in which the targeting template is saved at. | |
| CreatedAt | Datetime | True |
The timestamp when the template was created. | |
| UpdatedAt | Datetime | True |
The timestamp when the template was last modified. |
Retrieves existing third-party tracking tags used to monitor conversions and engagement across external platforms.
The Forms view returns a list of the Third-party tracking tags through the ad creative they're associated with. The following request takes in an ad creative URN in the creative parameter to search for third-party tracking tags linked to that ad creative.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM ThirdPartyTracking 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 |
Unique identifier assigned to the third-party tracking tag configuration. | |
| Creative | String | False |
Identifier of the ad creative associated with the third-party tracking tag. | |
| Account | String | True |
Uniform Resource Name (URN) that identifies the advertising account linked to the third-party tracking tag. | |
| Event | String | False |
Specifies the event being tracked. 使用できる値は次のとおりです。IMPRESSION, CLICK | |
| Platform | String | False |
Indicates the third-party tracking platform or provider used for analytics and attribution. 使用できる値は次のとおりです。DOUBLECLICK | |
| TrackingUrl | String | False |
URL endpoint used to track activity for the specified event through the third-party tracking system. | |
| Created | Timestamp | True |
Date and time when the third-party tracking tag configuration was created. | |
| LastModified | Timestamp | True |
Date and time when the third-party tracking tag configuration was last updated. |
Retrieves metadata for video assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.
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 changeable 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 |
Uniform Resource Name (URN) that uniquely identifies the video asset within LinkedIn. | |
| AccountURN | String | True |
URN that identifies the advertising account associated with the video asset. | |
| MediaLibraryName | String | False |
Display name of the video asset as it appears in the media library. | |
| MediaLibraryStatus | String | False |
Indicates the current status of the video asset in the media library, such as active, processing, or archived. 使用できる値は次のとおりです。ACTIVE, ARCHIVED | |
| OwnerURN | String | True |
URN that identifies the entity or organization that owns the video asset. | |
| DownloadURL | String | True |
URL used to download the video file from LinkedIn's media library. | |
| DownloadURLExpiresAt | Datetime | True |
Date and time when the download URL for the video asset expires and is no longer valid. | |
| Status | String | True |
Represents the current processing or availability status of the video asset. 使用できる値は次のとおりです。PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD | |
| AspectRatioHeight | Decimal | True |
Specifies the height component of the video's aspect ratio, used to maintain proper display proportions. | |
| AspectRatioWidth | Decimal | True |
Specifies the width component of the video's aspect ratio, used to maintain proper display proportions. | |
| Duration | Long | True |
Total duration of the video in milliseconds. | |
| ThumbnailDownloadURL | String | True |
URL used to download the thumbnail image associated with the video asset. | |
| CaptionsDownloadURL | String | True |
URL used to download caption files associated with the video asset. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AdFormResponses | Returns lead data collected through LinkedIn Lead Gen Forms, allowing you to analyze responses from forms owned by your organization. |
| Analytics | Delivers performance insights at the account, campaign, and creative levels, including metrics such as impressions, clicks, and engagement. |
| AudienceCount | Estimates the potential reach of your LinkedIn Ads campaigns based on defined targeting criteria, helping advertisers forecast audience size. |
| BudgetPricing | Provides bid and budget recommendations for campaigns, including minimum, maximum, and suggested bids based on your targeting parameters. |
| Degrees | Provides standardized degree data using LinkedIn's degree taxonomy to ensure consistency across educational targeting and reporting. |
| Documents | Retrieves metadata for document assets uploaded to your account, including identifiers, names, and ownership details. |
| EngagementRules | Manage LinkedIn engagement retargeting rules linking DMP segments to member engagements on specific content sources within a defined time frame. |
| FieldsOfStudy | Provides standardized field of study data using LinkedIn's taxonomy to maintain consistency across education-related targeting. |
| GeoLocations | Returns display names and related information for geographic identifiers (geo IDs) used in location-based targeting. |
| IABCategories | Provides access to standardized Interactive Advertising Bureau (IAB) categories used for audience and content classification. |
| Industries | Provides standardized industry data using LinkedIn's taxonomy to enable consistent targeting and analytics across campaigns. |
| JobFunctions | Retrieves standardized job function data through LinkedIn's taxonomy, ensuring consistent segmentation and targeting by function. |
| OrganizationRoleAssignments | Returns role-based access information for organizations the user is associated with, supporting permissions and governance. |
| Seniorities | Provides standardized seniority data using LinkedIn's taxonomy to maintain consistency across audience targeting segments. |
| Skills | Returns standardized skill data from LinkedIn's taxonomy, supporting targeting and reporting based on member skills. |
| SocialActions | Provides access to engagement data, including likes, comments, and shares, for both personal and organizational posts. |
| TargetingEntities | Returns details about available LinkedIn Ads targeting entities, such as companies, job titles, and industries. |
| TargetingFacets | Provides metadata about LinkedIn Ads targeting facets, defining the dimensions available for building audience segments. |
| Titles | Provides standardized job title data through LinkedIn's taxonomy to support accurate audience targeting and reporting. |
Returns lead data collected through LinkedIn Lead Gen Forms, allowing you to analyze responses from forms owned by your organization.
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 | Unique identifier assigned to each submitted form response. | |
| Account | String |
Accounts.Id | Identifier of the advertiser account that owns the lead form associated with this response. |
| Campaign | String | Uniform Resource Name (URN) that identifies the campaign connected to the form response, linking the lead data to its campaign source. | |
| Creative | String | URN that identifies the ad creative associated with the form response, indicating which ad generated the lead. | |
| Form | String | URN that identifies the specific lead form to which this response belongs. | |
| SubmitedAt | Datetime | Date and time when the form response was submitted by the user. | |
| LeadType | String | Specifies the type of lead, indicating whether it was collected from sponsored content or through organic sharing. The default value is 'SPONSORED'. | |
| TestLead | Boolean | Identifies whether or not the lead represents a test submission used for validation or form setup purposes. | |
| ConsentResponses | String | Stores consent-related details as a JSON object, capturing responses to consent questions. | |
| Answers | String | Stores the respondent's answers and corresponding questions in a JSON object for lead data analysis. |
Delivers performance insights at the account, campaign, and creative levels, including metrics such as impressions, clicks, and engagement.
The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT ReportStartTime, ReportEndTime, Clicks, Impressions, Follows, TotalEngagements FROM Analytics WHERE ReportStartTime = '07/20/2016' AND Account = '123456789' AND Granularity = 'MONTHLY'
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 | Groups the analytics results by the advertiser company associated with the campaign data. | |
| Account | String | Groups the analytics results by the advertising account. | |
| Share | String | Groups the analytics results by the sponsored share that generated engagement. | |
| Campaign | String | Groups the analytics results by campaign to enable campaign-level performance analysis. | |
| Creative | String | Groups the analytics results by creative asset to measure individual ad performance. | |
| CampaignGroup | String | Groups the analytics results by campaign group for aggregated reporting. | |
| Conversion | String | Groups the analytics results by conversion type to analyze performance by conversion action. | |
| ServingLocation | String | Groups the analytics results by the ad's serving location, such as LinkedIn feed or partner network. | |
| CardIndex | String | Groups the analytics results by the index of each carousel card to measure engagement by card. | |
| MemberCompanySize | String | Groups the analytics results by the company size of the engaged member. | |
| MemberIndustry | String | Groups the analytics results by the member's industry, based on LinkedIn profile data. | |
| MemberSeniority | String | Groups the analytics results by the seniority level of the engaged member. | |
| MemberJobTitle | String | Groups the analytics results by the job title of the engaged member. | |
| MemberJobFunction | String | Groups the analytics results by the job function of the engaged member. | |
| MemberCountry | String | Groups the analytics results by the member's country. | |
| MemberRegion | String | Groups the analytics results by the member's region. | |
| MemberCounty | String | Groups the analytics results by the member's county. | |
| MemberCompany | String | Groups the analytics results by the company where the engaged member works. | |
| PlacementName | String | Groups the analytics results by placement name, representing where the ad appeared. | |
| ImpressionDeviceType | String | Groups the analytics results by the device type used to view the ad. | |
| CampaignType | String | Groups the analytics results by campaign type for comparative performance insights.
使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC | |
| Granularity | String | Specifies the time granularity of results.
使用できる値は次のとおりです。DAILY, MONTHLY, YEARLY, ALL デフォルト値はMONTHLYです。 | |
| FinderMethod | String | Identifies the query method used to retrieve analytics data. Supported values are 'analytics' and 'statistics'.
使用できる値は次のとおりです。analytics, statistics デフォルト値はanalyticsです。 | |
| ReportStartTime | String | Specifies the start date and time for the reporting period. | |
| ReportEndTime | String | Specifies the end date and time for the reporting period. | |
| EventStage | String | Groups results by stage of a live event to analyze engagement throughout the event lifecycle. | |
| ActionClicks | Long | Number of clicks on the action button within Sponsored InMail messages. | |
| AdUnitClicks | Long | Number of clicks on the ad unit displayed alongside a Sponsored InMail message. | |
| CardClicks | Long | Number of clicks received by individual cards within a carousel ad. | |
| CardImpressions | Long | Number of impressions shown for each card in a carousel ad. | |
| Clicks | Long | Total number of chargeable clicks recorded for the ad. | |
| CommentLikes | Long | Number of likes on comments associated with the ad. | |
| Comments | Long | Number of comments posted in response to the ad. | |
| CompanyPageClicks | Long | Number of clicks to view the advertiser's LinkedIn company page. | |
| ConversionValueInLocalCurrency | Decimal | Total conversion value in the account's local currency, calculated according to advertiser-defined rules. | |
| CostInLocalCurrency | Decimal | Total advertising cost in the account's local currency, aggregated by pivot and time granularity. | |
| CostInUsd | Decimal | Total advertising cost in USD, aggregated by pivot and time granularity. | |
| UsageStartTime | String | Start date for the period covered by the data point. | |
| UsageEndTime | String | End date for the period covered by the data point. | |
| ExternalWebsiteConversions | Long | Number of conversions recorded on an external advertiser website through pixel tracking. | |
| ExternalWebsitePostClickConversions | Long | Number of post-click conversions recorded on an external advertiser website through pixel tracking. | |
| ExternalWebsitePostViewConversions | Long | Number of post-view conversions recorded on an external advertiser website through pixel tracking. | |
| Follows | Long | Number of new followers gained through sponsored content. | |
| FullScreenPlays | Long | Number of times a user tapped a video to enter full-screen viewing mode. | |
| Impressions | Long | Total number of impressions for Direct Ads and Sponsored Updates, or 'sends' for InMail campaigns. | |
| LandingPageClicks | Long | Number of clicks that directed users to the creative's landing page. | |
| LeadGenerationMailContactInfoShares | Long | Number of times a user shared their contact information through a one-click Lead Gen form in Sponsored InMail. | |
| LeadGenerationMailInterestedClicks | Long | Number of clicks indicating user interest in a Sponsored InMail lead generation message. | |
| Likes | Long | Total number of likes received on the ad. | |
| OneClickLeadFormOpens | Long | Number of times users opened a one-click Lead Gen form during a campaign. | |
| OneClickLeads | Long | Number of leads generated through one-click Lead Gen submissions. | |
| Opens | Long | Number of times Sponsored InMail messages were opened by recipients. | |
| OtherEngagements | Long | Number of user interactions with the ad that do not fall into other defined engagement types. | |
| Shares | Long | Number of times the ad was shared by users. | |
| TextUrlClicks | Long | Number of clicks on text links included within the body of Sponsored InMail messages. | |
| TotalEngagements | Long | Total number of user interactions with the ad unit across all engagement types. | |
| VideoCompletions | Long | Number of video ads that played at least 97–100% of their duration. | |
| VideoFirstQuartileCompletions | Long | Number of video ads that played through the first 25% of their duration. | |
| VideoMidpointCompletions | Long | Number of video ads that played through 50% of their duration. | |
| VideoStarts | Long | Number of times users started playing a video ad. | |
| VideoThirdQuartileCompletions | Long | Number of video ads that played through 75% of their duration. | |
| VideoViews | Long | Number of video ads viewed for at least two continuous seconds while 50% visible, or when a call-to-action (CTA) click occurs first. | |
| ViralCardClicks | Long | Number of clicks on viral carousel cards that spread through organic sharing. | |
| ViralCardImpressions | Long | Number of viral impressions shown for each card in a carousel ad. | |
| ViralClicks | Long | Number of clicks on viral impressions generated by organic distribution. | |
| ViralComments | Long | Number of comments originating from viral impressions of this ad. | |
| ViralCompanyPageClicks | Long | Number of clicks to view the advertiser's company page from viral impressions. | |
| ViralExternalWebsiteConversions | Long | Number of conversions on external websites driven by viral impressions. | |
| ViralExternalWebsitePostClickConversions | Long | Number of post-click conversions on external websites driven by viral engagement. | |
| ViralExternalWebsitePostViewConversions | Long | Number of post-view conversions on external websites driven by viral engagement. | |
| ViralFollows | Long | Number of followers gained through viral impressions. | |
| ViralFullScreenPlays | Long | Number of times users opened a viral video in full-screen mode. | |
| ViralImpressions | Long | Total number of viral impressions generated by organic sharing. | |
| ViralLandingPageClicks | Long | Number of clicks on viral impressions that led users to the ad's landing page. | |
| ViralLikes | Long | Number of likes generated from viral impressions. | |
| ViralOneClickLeadFormOpens | Long | Number of times users opened a lead form through viral impressions in a Lead Gen campaign. | |
| ViralOneClickLeads | Long | Number of leads generated through one-click Lead Gen submissions from viral impressions. | |
| ViralOtherEngagements | Long | Number of user interactions with viral impressions not categorized elsewhere. | |
| ViralShares | Long | Number of shares generated from viral impressions. | |
| ViralTotalEngagements | Long | Total number of user interactions recorded for viral ad units. | |
| ViralVideoCompletions | Long | Number of viral video ads that played at least 97–100% of their duration. | |
| ViralVideoFirstQuartileCompletions | Long | Number of viral video ads that played through the first 25% of their duration. | |
| ViralVideoMidpointCompletions | Long | Number of viral video ads that played through 50% of their duration. | |
| ViralVideoStarts | Long | Number of times users started playing a viral video ad. | |
| ViralVideoThirdQuartileCompletions | Long | Number of viral video ads that played through 75% of their duration. | |
| ViralVideoViews | Long | Number of viral video ads viewed for at least two continuous seconds while 50% visible, or when a CTA click occurs first. | |
| AverageDailyReachMetricsApproximateReach | Decimal | Average daily reach, representing unique member accounts with at least one impression per day. | |
| AverageDailyReachMetricsApproximateFrequency | Decimal | Average number of impressions shown per member account reached per day. | |
| AverageDailyReachMetricsApproximateCost | Decimal | Average daily advertising spend per 1,000 member accounts reached. | |
| AveragePreviousSevenDayReachMetricsApproximateReach | Decimal | Average reach for the previous 7 days, representing unique member accounts with at least one impression. | |
| AveragePreviousSevenDayReachMetricsApproximateFrequency | Decimal | Average number of impressions shown per member account reached over the last 7 days. | |
| AveragePreviousSevenDayReachMetricsApproximateCost | Decimal | Average advertising spend per 1,000 member accounts reached during the last 7 days. | |
| AveragePreviousThirtyDayReachMetricsApproximateReach | Decimal | Average reach for the previous 30 days, representing unique member accounts with at least one impression. | |
| AveragePreviousThirtyDayReachMetricsApproximateFrequency | Decimal | Average number of impressions shown per member account reached over the last 30 days. | |
| AveragePreviousThirtyDayReachMetricsApproximateCost | Decimal | Average advertising spend per 1,000 member accounts reached during the last 30 days. | |
| ApproximateMemberReach | Long | Estimated number of unique member accounts with at least one impression, available for reporting periods up to 92 days and excluding the current UTC day. | |
| ValidWorkEmailLeads | Long | Number of leads containing a valid work email address that does not belong to a free or personal domain. | |
| PostClickRegistrations | Decimal | Number of event or seminar registrations completed after a user clicked an ad with a LinkedIn landing page. | |
| PostViewRegistrations | Decimal | Number of event or seminar registrations completed after a user viewed an ad with a LinkedIn event landing page. | |
| DownloadClicks | Long | Number of times users clicked the download icon in an ad to indicate intent to download media or content. | |
| QualifiedLeads | Long | Number of qualified leads determined by the advertiser as having a higher likelihood of becoming customers based on engagement and fit. | |
| CostPerQualifiedLead | Decimal | Average cost spent per qualified lead, calculated as cost in local currency divided by number of qualified leads. | |
| MessagingAdvertSendCount | Long | Number of Sponsored Messaging ads sent to recipients. | |
| MessagingAdvertOpenCount | Long | Number of Sponsored Messaging ads opened by recipients. | |
| AudiencePenetration | Decimal | Ratio of unique members reached to the total target audience size. Available only for date ranges up to 92 days and supported for the 'CAMPAIGN' pivot with 'MONTHLY' granularity excluded. | |
| AverageDwellTime | Long | Average time in seconds that more than 50% of an ad's pixels remained visible on screen, indicating user attention duration. | |
| DocumentCompletions | Long | Number of times users viewed 100% of a document's length, including those who skipped directly to the end. |
Estimates the potential reach of your LinkedIn Ads campaigns based on defined targeting criteria, helping advertisers forecast audience size.
The AudienceCount view allows advertisers to forecast the reach of targeting criteria.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM AudienceCount WHERE AgeRanges = '(25,34)' SELECT * FROM AudienceCount WHERE DegreesId = '1234' SELECT * FROM AudienceCount WHERE FieldsOfStudyId = '1234' SELECT * FROM AudienceCount WHERE Genders = 'MALE' SELECT * FROM AudienceCount WHERE IndustriesId = '1234' SELECT * FROM AudienceCount WHERE JobFunctionsId = '1234' SELECT * FROM AudienceCount WHERE LocationsId = '1234' SELECT * FROM AudienceCount WHERE ProfileLocationsId = '1234' SELECT * FROM AudienceCount WHERE SenioritiesId = '1234' SELECT * FROM AudienceCount WHERE SkillsId = '1234' SELECT * FROM AudienceCount WHERE StaffCountRanges = '(11,50)' SELECT * FROM AudienceCount WHERE TitlesId = '1234'
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 | Represents the count of active LinkedIn members matching the specified targeting criteria. | |
| TotalAudience | Integer | Represents the total number of LinkedIn members that meet the defined targeting parameters, regardless of recent activity. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| AgeRange | String | Specifies the age ranges used to match against members. Supported values: (18, 24), (25, 34), (35, 54), (55, 2147483647). | |
| DegreeId | String | Specifies the educational degrees attained by members to use for targeting. | |
| FieldOfStudyId | String | Specifies the fields of study to target, matched against those listed in members' profiles. | |
| Gender | String | Defines the gender-based targeting criteria. Supported values: MALE, FEMALE. | |
| IndustryId | String | Specifies the industries to target, based on members' current or past roles. | |
| JobFunctionId | String | Defines the top-level job functions to target, representing groupings of related job titles. | |
| LocationId | String | Specifies the geographic locations to include in audience targeting. | |
| ProfileLocationId | String | Specifies member profile locations for targeting, similar to LocationId but based on a member's listed profile location. | |
| SeniorityId | String | Defines the seniority levels to target, such as entry-level, manager, or director. | |
| SkillId | String | Specifies the skills to target, matched against those listed on members' profiles. | |
| StaffCountRange | String | Defines the organization size range to target. Supported values: (1, 1), (2, 10), (11, 50), (51, 200), (201, 500), (501, 1000), (1001, 5000), (5001, 10000), (10001, 2147483647). | |
| TitleId | String | Specifies the job titles to target, matched against members' current titles. | |
| AudienceMatchingSegmentId | String | Identifies an ad segment composed of specific entities, such as members or companies. It is used for audience matching. | |
| RetargetingSegmentId | String | Identifies an ad segment composed of entities previously engaged with your ads. It is used for retargeting campaigns. | |
| EmployerId | String | Specifies the employer identifier to match against companies listed in members' profiles. | |
| CompanyId | String | Specifies the company identifier to target, matched against companies listed in members' profiles. | |
| InterfaceLocaleId | String | Specifies the locale identifier to target, matched against members' preferred language or regional settings. |
Provides bid and budget recommendations for campaigns, including minimum, maximum, and suggested bids based on your targeting parameters.
The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM BudgetPricing WHERE AgeRanges = '(25,34)' AND Account = '1234' SELECT * FROM BudgetPricing WHERE DegreesId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE FieldsOfStudyId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE Genders = 'MALE' AND Account = '1234' SELECT * FROM BudgetPricing WHERE IndustriesId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE JobFunctionsId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE LocationsId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE ProfileLocationsId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE SenioritiesId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE SkillsId = '1234' AND Account = '1234' SELECT * FROM BudgetPricing WHERE StaffCountRanges = '(11,50)' AND Account = '1234' SELECT * FROM BudgetPricing WHERE TitlesId = '1234' AND Account = '1234'
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 | Represents the suggested bid amount recommended for a given campaign setup. | |
| SuggestedBidMin | String | Indicates the lower end of the suggested bid range for the selected targeting criteria. | |
| SuggestedBidMax | String | Indicates the upper end of the suggested bid range for the selected targeting criteria. | |
| DailyBudgetLimitsDefault | String | Specifies the default daily budget amount recommended by LinkedIn Ads. | |
| DailyBudgetLimitsMin | String | Specifies the minimum allowable daily budget for the campaign. | |
| DailyBudgetLimitsMax | String | Specifies the maximum allowable daily budget for the campaign. | |
| BidLimitsMax | String | Defines the maximum bid amount permitted for the selected campaign type or bidding strategy. | |
| BidLimitsMin | String | Defines the minimum bid amount allowed, also referred to as the floor price. | |
| Account | String | Uniform Resource Name (URN) that identifies the advertising account associated with the budget or pricing configuration. | |
| CampaignType | String | Specifies the type of campaign.
使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES デフォルト値はTEXT_ADです。 | |
| BidType | String | Defines the bidding method used for the campaign.
使用できる値は次のとおりです。CPM, CPC, CPV デフォルト値はCPMです。 | |
| MatchType | String | Specifies the targeting match type used to determine how closely audience attributes must align with defined criteria.
使用できる値は次のとおりです。EXACT, AUDIENCE_EXPANDED デフォルト値はEXACTです。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| AgeRange | String | Defines the age ranges used for audience targeting. Supported values: (18, 24), (25, 34), (35, 54), (55, 2147483647). | |
| DegreeId | String | Specifies the educational degrees attained by members for use in audience targeting. | |
| FieldOfStudyId | String | Defines the academic fields of study to target, based on members' profile information. | |
| Gender | String | Specifies gender-based audience targeting criteria. Supported values: MALE, FEMALE. | |
| IndustryId | String | Defines the industries to target based on members' professional backgrounds. | |
| JobFunctionId | String | Specifies the job functions to target, representing broad categories of professional roles. | |
| LocationId | String | Defines the geographic locations to include in audience targeting. | |
| ProfileLocationId | String | Specifies member profile locations for targeting, similar to LocationId but based on a member's listed profile location. | |
| SeniorityId | String | Specifies the seniority levels to target, such as entry-level, manager, or executive. | |
| SkillId | String | Defines the professional skills to target, matched against those listed in members' profiles. | |
| StaffCountRange | String | Defines the organization size range to target. Supported values: (1, 1), (2, 10), (11, 50), (51, 200), (201, 500), (501, 1000), (1001, 5000), (5001, 10000), (10001, 2147483647). | |
| TitleId | String | Specifies the job titles to target, matched against members' current titles. | |
| AudienceMatchingSegmentId | String | Identifies an ad segment consisting of specific entities, such as members or companies, used for audience matching. | |
| RetargetingSegmentId | String | Identifies an ad segment composed of entities previously engaged with your ads, used for retargeting campaigns. | |
| EmployerId | String | Specifies the employer identifier to match against companies listed in members' profiles. | |
| CompanyId | String | Specifies the company identifier to target, matched against companies listed in members' profiles. | |
| InterfaceLocaleId | String | Defines the locale identifier to target, matched against members' preferred language or regional settings. |
Provides standardized degree data using LinkedIn's degree taxonomy to ensure consistency across educational targeting and reporting.
The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Degrees
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized degree entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized degree within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the degree, represented as a MultiLocaleString type supporting multiple languages. |
Retrieves metadata for document assets uploaded to your account, including identifiers, names, and ownership details.
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 | Uniform Resource Name (URN) that uniquely identifies the document asset within LinkedIn. | |
| OwnerURN | String | URN that identifies the entity or account that owns the document asset. | |
| DownloadURL | String | URL that provides access to download the document file. | |
| DownloadURLExpiresAt | Datetime | Date and time when the document's download URL expires and becomes inaccessible. | |
| Status | String | Indicates the current processing or availability status of the document asset.
使用できる値は次のとおりです。PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD |
Manage LinkedIn engagement retargeting rules linking DMP segments to member engagements on specific content sources within a defined time frame.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id and DMPSegmentId columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM EngagementRules WHERE Id = '12345';
SELECT * FROM EngagementRules WHERE DMPSegmentId = '43318048';
| Name | Type | References | Description |
| Id [KEY] | Long | The engagement rule id. | |
| DMPSegmentId | Long |
DMPSegments.Id | The DMP segment id that this engagement retargeting rule belongs. |
| EngagementSource | String | The content URN that members are engaging with. | |
| EngagementTrigger | String | The action that users can take on the source. | |
| TimeFrame | Object | The time frame members engaged with the specified source URN with the specified engagement trigger. | |
| CreatedAt | Datetime | Date and time when the engagement rule was first created. | |
| UpdatedAt | Datetime | Date and time when the engagement rule was last modified. |
Provides standardized field of study data using LinkedIn's taxonomy to maintain consistency across education-related targeting.
The FieldsOfStudy view returns a list of the fields of study found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM FieldsOfStudy
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized field of study entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized field of study within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the field of study, represented as a MultiLocaleString type supporting multiple languages. |
Returns display names and related information for geographic identifiers (geo IDs) used in location-based targeting.
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 | Unique identifier assigned to the geographic location. | |
| Name | String | Display name of the location as shown within LinkedIn Ads targeting options. | |
| LocaleCountry | String | Two-letter uppercase country code defined by ISO 3166 representing the country of the location. | |
| LocaleLanguage | String | Two-letter lowercase language code defined by ISO 639 representing the language associated with the location. |
Provides access to standardized Interactive Advertising Bureau (IAB) categories used for audience and content classification.
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 | Unique identifier assigned to the IAB category. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the IAB category within LinkedIn's taxonomy. | |
| Name | String | Display name of the IAB category in the 'en_US' locale. | |
| IABName | String | Original name of the IAB category as defined in the Open Real-Time Bidding (OpenRTB) 2.3 specification. | |
| ParentId | String | Unique identifier of the parent IAB category, used to establish category hierarchy. |
Provides standardized industry data using LinkedIn's taxonomy to enable consistent targeting and analytics across campaigns.
The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Industries
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized industry entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized industry within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the industry, represented as a MultiLocaleString type supporting multiple languages. | |
| ChildrenIndustries | String | List of URNs representing child industries related to this industry node within the hierarchy. | |
| ParentIndustries | String | List of URNs representing parent industries associated with this industry node within the hierarchy. |
Retrieves standardized job function data through LinkedIn's taxonomy, ensuring consistent segmentation and targeting by function.
The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM JobFunctions
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized job function entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized job function within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the job function, represented as a MultiLocaleString type supporting multiple languages. |
Returns role-based access information for organizations the user is associated with, supporting permissions and governance.
| Name | Type | References | Description |
| OrganizationURN [KEY] | String | Uniform Resource Name (URN) that uniquely identifies the organization within LinkedIn. | |
| MemberURN [KEY] | String | URN that uniquely identifies the LinkedIn member assigned a specific organizational role. | |
| Role [KEY] | String | Specifies the role granted to the member for managing or administering the organization.
使用できる値は次のとおりです。ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR | |
| State | String | Indicates the current state of the role assignment.
使用できる値は次のとおりです。APPROVED, REJECTED, REQUESTED, REVOKED |
Provides standardized seniority data using LinkedIn's taxonomy to maintain consistency across audience targeting segments.
The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Seniorities
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized seniority entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized seniority within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the seniority level, represented as a MultiLocaleString type supporting multiple languages. |
Returns standardized skill data from LinkedIn's taxonomy, supporting targeting and reporting based on member skills.
The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Skills
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized skill entry. | |
| Name | String | Localized display name of the skill, represented as a MultiLocaleString type supporting multiple languages. |
Provides access to engagement data, including likes, comments, and shares, for both personal and organizational posts.
The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
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 directly made on the post. | |
| AggregatedTotalComments | Integer | Total number of comments on the post, including both first-level and nested replies. | |
| LikedByCurrentUser | Boolean | If the value is 'true', the current user has liked the post; if 'false', they have not. | |
| TotalLikes | Integer | Total number of likes the post has received from all users. | |
| Target | String | Identifier of the post, article, or entity on which the social action was performed. | |
| UGCPostId | String |
Posts.Id | Unique identifier of the user-generated content (UGC) post associated with the social action data. |
Returns details about available LinkedIn Ads targeting entities, such as companies, job titles, and industries.
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 | Uniform Resource Name (URN) that uniquely identifies the ad-targeting entity within LinkedIn Ads. | |
| Name | String | Display name of the ad-targeting entity used in audience selection or campaign setup. | |
| FacetURN | String |
TargetingFacets.URN | URN that identifies the ad-targeting facet used when searching for entities within a specific targeting category. |
| TypeaheadEntityType | String | Specifies the type of entity to search for using the TYPEAHEAD finder, such as company or skill. | |
| TypeaheadCriteria | String | Defines the text or name input used to search for entities through the TYPEAHEAD finder. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SimilarEntityURN | String | URN of an entity used with the SIMILAR_ENTITIES finder to identify related or similar entities for targeting. |
Provides metadata about LinkedIn Ads targeting facets, defining the dimensions available for building audience segments.
| Name | Type | References | Description |
| URN [KEY] | String | Uniform Resource Name (URN) that uniquely identifies the targeting facet within LinkedIn Ads. | |
| Name | String | Display name of the targeting facet used to define a specific audience attribute, such as industry or company size. | |
| EntityTypes | String | Lists the types of entities associated with this facet, which determine what can be targeted through it. | |
| EntityFinders | String | Specifies the available entity finders for this facet, used to search or retrieve related targeting entities. |
Provides standardized job title data through LinkedIn's taxonomy to support accurate audience targeting and reporting.
The Titles view returns a list of the job titles found accross LinkedIn so they can be used as dimensions in analytic requests.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM Titles
| Name | Type | References | Description |
| Id | String | Unique identifier assigned to the standardized job title entry. | |
| URN | String | Uniform Resource Name (URN) that uniquely identifies the standardized job title within LinkedIn's taxonomy. | |
| Name | String | Localized display name of the job title, represented as a MultiLocaleString type supporting multiple languages. | |
| Function | String | URN that identifies the job function associated with this title within the LinkedIn taxonomy. | |
| SuperTitle | String | URN that identifies the broader or parent title category (super title) to which this title belongs. |
ストアドプロシージャはファンクションライクなインターフェースで、LinkedIn Marketing Solutions の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにLinkedIn Marketing Solutions から関連するレスポンスデータを返します。
| Name | Description |
Downloads document, image, or video assets from your LinkedIn organization or ad account, allowing you to retrieve creative files for reuse, reporting, or backup purposes.
| Name | Type | Required | Description |
| URN | String | True | Uniform Resource Name (URN) of the asset to download. Supported types include 'urn:li:document:', 'urn:li:image:', and 'urn:li:video:'. |
| LocalFile | String | False | Specifies the absolute local file path where the downloaded asset should be saved. |
| Overwrite | Boolean | False | If the value is 'true', an existing file at the specified LocalFile path will be overwritten during download.
デフォルト値はfalseです。 |
| Name | Type | Description |
| Success | Boolean | If the value is 'true', the asset was downloaded successfully; if 'false', the download failed. |
| FileData | String | Contains the downloaded asset data as a Base64-encoded string. This output is returned only when both LocalFile and FileStream parameters are not specified. |
Gets the OAuth access token from LinkedIn.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB. |
| Verifier | String | False | The verifier token returned by LinkedIn after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
| Scope | String | False | The scope or permissions you are requesting. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the LinkedIn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
| OAuthRefreshToken | String | The OAuth refresh token. |
Gets the LinkedIn authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to LinkedIn.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL that LinkedIn will return to after the user has authorized your app. |
| Scope | String | False | The scope or permissions you are requesting. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the LinkedIn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
Refreshes the OAuth access token used for authentication with LinkedInAds.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from LinkedInAds. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Uploads document assets, such as PDFs or whitepapers, to your LinkedIn organization so they can be attached to posts or used in sponsored content campaigns.
If no parameter is used, or more than one parameter is used, the procedure will fail.
Below are some other restrictions for document assets:
| Name | Type | Required | Description |
| OwnerURN | String | True | Uniform Resource Name (URN) that identifies the account or organization that will own the uploaded document asset. |
| LocalFile | String | False | Specifies the absolute local file path of the document to upload to LinkedIn. |
| FileData | String | False | Contains the document data as a Base64-encoded string, used when neither LocalFile nor FileStream parameters can be provided. |
| Name | Type | Description |
| DocumentURN | String | URN that uniquely identifies the newly created document asset after a successful upload. |
Uploads image assets to your LinkedIn organization or ad account for use in posts, sponsored ads, or creative libraries, ensuring consistent visual branding.
If no parameter is used, or more than one parameter is used, the procedure will fail.
Below are some other restrictions for image assets:
| Name | Type | Required | Description |
| AccountURN | String | True | Uniform Resource Name (URN) that identifies the advertising account whose media library will store the uploaded image asset. |
| AssetName | String | True | Specifies the name under which the image will be saved in the account's media library. |
| OwnerURN | String | False | URN that identifies the organization or advertising account that will own the uploaded image. If not provided, the account defined in the AccountURN parameter will be set as the owner. |
| LocalFile | String | False | Specifies the absolute local file path of the image to upload to LinkedIn. |
| FileData | String | False | Contains the image data as a Base64-encoded string, used when neither LocalFile nor FileStream parameters can be provided. |
| Name | Type | Description |
| ImageURN | String | URN that uniquely identifies the newly created image asset after a successful upload. |
Uploads video assets to your LinkedIn organization or ad account, making them available for use in video posts, video ads, and campaign creatives.
If no parameter is used, or more than one parameter is used, the procedure will fail.
If the video has a thumbnail, you can use the value returned in the ThumbnailUploadURL output parameter to upload the video's thumbnail through the UploadVideoThumbnail stored procedure.
If the video has captions, you can use the value returned in the CaptionsUploadURL output parameter to upload the video's captions through the UploadVideoCaptions stored procedure.
For a video asset to be usable (where you can use it to create posts or ads), you must:
Below are some other restrictions for video assets:
There are more restrictions for the video, depending on how you intend to use it:
| Name | Type | Required | Description |
| AccountURN | String | True | Uniform Resource Name (URN) that identifies the advertising account whose media library will store the uploaded video asset. |
| AssetName | String | True | Specifies the name under which the video will be saved in the account's media library. |
| OwnerURN | String | True | URN that identifies the organization designated as the owner of the uploaded video asset. |
| LocalFile | String | False | Specifies the absolute local file path of the video to upload to LinkedIn. |
| FileStreamSize | Long | False | Specifies the size in bytes of the InputStream object defined in the FileStream parameter. This field is required when FileStream is used. |
| FileData | String | False | Contains the video data as a Base64-encoded string, used when neither LocalFile nor FileStream parameters can be provided. |
| HasCaptions | Boolean | False | If the value is 'true', the uploaded video will include captions, and a URL for uploading caption files will be returned in the output.
デフォルト値はfalseです。 |
| HasThumbnail | Boolean | False | If the value is 'true', the uploaded video will include a thumbnail image, and a URL for uploading the thumbnail will be returned in the output.
デフォルト値はfalseです。 |
| Name | Type | Description |
| VideoURN | String | URN that uniquely identifies the newly created video asset after a successful upload. |
| CaptionsUploadURL | String | URL provided for uploading caption files associated with the video asset. |
| ThumbnailUploadURL | String | URL provided for uploading the thumbnail image associated with the video asset. |
Uploads caption files for your video assets to improve accessibility and engagement. Only the '.srt' caption format is supported.
If no parameter is used, or more than one parameter is used, the procedure will fail.
| Name | Type | Required | Description |
| UploadURL | String | True | URL endpoint used to upload caption files for the video asset. |
| LocalFile | String | False | Specifies the absolute local file path of the subtitle file to upload as the video's captions. |
| FileData | String | False | Contains the subtitle data as a Base64-encoded string, used when neither LocalFile nor FileStream parameters can be provided. |
| Name | Type | Description |
| Success | Boolean | If the value is 'true', the caption file was uploaded successfully; if 'false', the upload failed. |
Uploads custom thumbnail images for your video assets, helping control the preview image that appears in video posts and advertisements.
If no parameter is used, or more than one parameter is used, the procedure will fail.
| Name | Type | Required | Description |
| UploadURL | String | True | URL endpoint used to upload the thumbnail image for the video asset. |
| LocalFile | String | False | Specifies the absolute local file path of the image file to upload as the video's thumbnail. |
| FileData | String | False | Contains the image data as a Base64-encoded string, used when neither LocalFile nor FileStream parameters can be provided. |
| Name | Type | Description |
| Success | Boolean | Identifies whether or not the thumbnail image was uploaded successfully. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| Scope | A specific scope that the user requires the access token. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| Scope | A specific scope that the user requires the access token. |
カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります：
（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes：
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
A specific scope that the user requires the access token.
This property must be set in the connection string to get a scoped token with specific privileges.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
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：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がLinkedIn Marketing Solutions への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がLinkedIn Marketing Solutions への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がLinkedIn Marketing Solutions にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類：
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note：Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード（クラウドジョブ）に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\LinkedInAds Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note：特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse（ローカルタイムを使用）です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
provider がLinkedIn Marketing Solutions にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
クエリを処理する際、LinkedIn Marketing Solutions でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。
Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Analytics WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
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.