CData Sync App は、LinkedIn Marketing Solutions データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
LinkedIn Marketing Solutions コネクタはCData Sync アプリケーションから使用可能で、LinkedIn Marketing Solutions からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、LinkedIn Marketing Solutions REST API バージョン2.x のエンティティをリレーショナルテーブルとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、LinkedIn Marketing Solutions プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。
スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。
例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。
| Scope | Description |
| r_ads | Read-only access to ad accounts. Required for the following views:
|
| rw_ads | Read and write access to ad accounts. Required for the following views:
|
| r_ads_reporting | Read access to ad reporting and analytics data. Required for the following view: Analytics |
| r_marketing_leadgen_automation | Access to lead generation forms and marketing automation data. Required for the following view: AdFormResponses |
| w_organization_social | Write access to organizational social media content. Required for the following views:
|
| r_organization_social | Read-only access to organizational social media content. Required for the following views:
|
| w_member_social | Write access to member social media content. Required for the following views:
|
| r_member_social | Provides read access to member social media content. Required for the following views:
|
| r_compliance | Required to retrieve activities for compliance monitoring and archiving. Required for the following views:
|
| w_compliance | Manage and delete data on behalf of an authenticated member for compliance requirements. This is a private permission and access is granted to select developers. Required for the following views:
|
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note： ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| accounts.linkedin.com | TRUE | The subdomain used for OAuth. |
| api.linkedin.com | TRUE | The subdomain used for accessing various services. |
このセクションでは、LinkedIn Marketing Solutions Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、LinkedIn Marketing Solutions API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
CData Sync App は、データをビュー にモデル化し、標準SQL でのクエリおよび更新を容易にします。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Accounts | The Account status finder returns all accounts in a specified status that the authenticated user has access to. |
| AdFormResponses | Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form. |
| Analytics | The Analytics API provides account, campaign, and creative level insights on click intelligence numbers. |
| AudienceCount | The Audience Count API allows advertisers to forecast the reach of targeting criteria. |
| BudgetPricing | The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria. |
| CampaignGroups | The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
| CampaignInsights | The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions. |
| Campaigns | The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
| Conversions | Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business. |
| Creatives | The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN. |
| Degrees | Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| FieldsOfStudy | Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| Forms | Query form data for the forms that belong to a specified owner (account). |
| GeoLocations | Provides the display name for a given geo Id, or a set of geo Ids. |
| Industries | Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| JobFunctions | Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| Posts | Retrieve all posts for an organization. |
| Seniorities | Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| Skills | Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
| SocialActions | The socialActions API allows access to both personal and organization social actions. |
| ThirdPartyTracking | Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag. |
| Titles | Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
The Account status finder returns all accounts in a specified status that the authenticated user has access to.
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'
| Name | Type | Description |
| Id | String | Id of the account |
| Name | String | A label for the account |
| Currency | String | The account's ISO-4217currency code. |
| Type | String | The type of account. |
| NotifiedOnCreativeRejection | Boolean | Indicates if creative contact is notified when a creative has been rejected due to content. |
| NotifiedOnEndOfCampaign | Boolean | Indicates if campaign contact is notified when an associated campaign has been completed. |
| Status | String | Status of the account |
| NotifiedOnCampaignOptimization | Boolean | Indicates if campaign contact is notified about campaign optimization opportunities. |
| Version | String | Version of the account |
| Reference | String | The entity on whose behalf the account advertises. |
| NotifiedOnCreativeApproval | Boolean | Indicates if creative contact is notified when a creative has been reviewed and approved. |
| AuditStampsCreator | String | The person who created audit stamps for the first time |
| AuditStampsCreatedAt | Datetime | The datetime in which the audit stamp was created first |
| AuditStampsLastModifier | String | Last modifier of the Audit stamps |
| AuditStampsLastModifiedAt | Datetime | Last modified datetime of the audit stamps |
Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.
The Account and LeadType columns must be specified in the criteria to use this view.
For the Account column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:
SELECT * FROM AdFormResponses WHERE Account = '512859024';
SELECT * FROM AdFormResponses WHERE Account IN ('512859024', '513009855');
To satisfy the requirement mentioned in the beginning, 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');
To satisfy the requirement mentioned in the beginning, 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 | Description |
| Id [KEY] | String | Identifier for the form response. |
| Account | String | Identifier for the owner of the form. This is the advertiser account. |
| Campaign | String | URN identifying the campaign to which the form response is responding. |
| Creative | String | URN identifying the creative to which the form response is responding. |
| Form | String | URN identifying which form this response responds to. |
| SubmitedAt | Datetime | Timestamp for when the form response was submitted. |
| LeadType | String | Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED. |
| TestLead | Boolean | Whether the lead is a test lead. |
| ConsentResponses | String | A JSON object containing all the consent responses. |
| Answers | String | A JSON object containing all the answers and the respective questions. |
The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.
The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.
The 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'
Analytic reports:
| Dimensions | Required | FinderMethod, ReportStartTime, Granularity |
| Optional | ReportEndTime, CampaignType | |
| If FinderMethod is Analytics | Use 0 or 1 (Default is Campaign) | Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, MemberCompany |
| If FinderMethod is Statistics | Use 1 or 2 (Default is Campaign) | Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex
Note: The default value for FinderMethod will be Analytics. The default value for Granularity will be MONTHLY. The default time window will be the last year period. |
| Metrics | Use 1 or more | ActionClicks, AdUnitClicks, CardClicks, CardImpressions, Clicks, CommentLikes, Comments, CompanyPageClicks, ConversionValueInLocalCurrency, CostInLocalCurrency, CostInUsd, StartPeriod, EndPeriod, ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, Follows, FullScreenPlays, Impressions, LandingPageClicks, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, Likes, OneClickLeadFormOpens, OneClickLeads, Opens, OtherEngagements, Pivot, PivotValue, Shares, TextUrlClicks, TotalEngagements, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoStarts, VideoThirdQuartileCompletions, VideoViews, ViralCardClicks, ViralCardImpressions, ViralClicks, ViralComments, ViralCompanyPageClicks, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralFullScreenPlays, ViralImpressions, ViralLandingPageClicks, ViralLikes, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralOtherEngagements, ViralShares, ViralTotalEngagements, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoStarts, ViralVideoThirdQuartileCompletions, ViralVideoViews, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost, AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost, ApproximateMemberReach, ValidWorkEmailLeads, PostClickRegistrations, PostViewRegistrations, DownloadClicks, QualifiedLeads, CostPerQualifiedLead, MessagingAdvertSendCount, MessagingAdvertOpenCount |
| Filter | Use 1 or more | Account, Campaign, Creative
Note: If there are no filters specified the default filter will be all the accounts that belong to the user. |
| Name | Type | Description |
| Company | String | Pivot value which groups the result by advertiser's company. |
| Account | String | Pivot value which groups the result by account. |
| Share | String | Pivot value which groups the result by sponsored share. |
| Campaign | String | Pivot value which groups the result by campaign. |
| Creative | String | Pivot value which groups the result by creative. |
| CampaignGroup | String | Pivot value which groups the result by campaign group. |
| Conversion | String | Pivot value which groups the result by conversion. |
| ServingLocation | String | Pivot value which groups the result by serving location. |
| CardIndex | String | Pivot value which groups the result by card index. |
| MemberCompanySize | String | Pivot value which groups the result by member company size. |
| MemberIndustry | String | Pivot value which groups the result by member industry. |
| MemberSeniority | String | Pivot value which groups the result by member seniority. |
| MemberJobTitle | String | Pivot value which groups the result by member job title. |
| MemberJobFunction | String | Pivot value which groups the result by member job function. |
| MemberCountry | String | Pivot value which groups the result by member country. |
| MemberRegion | String | Pivot value which groups the result by member region. |
| MemberCounty | String | Pivot value which groups the result by member county. |
| MemberCompany | String | Pivot value which groups the result by member company. |
| PlacementName | String | Pivot value which groups the result by member company. |
| ImpressionDeviceType | String | Pivot value which groups the result by member company. |
| CampaignType | String | Match result by campaign type. |
| Granularity | String | Time granularity of results.
デフォルト値はMONTHLYです。 |
| FinderMethod | String | Designates the query finder. The only allowed values are analytics or statistics.
デフォルト値はanalyticsです。 |
| ReportStartTime | String | The start time of the period. |
| ReportEndTime | String | The end time of the period. |
| EventStage | String | Organize results based on the stage of the live event. |
| ActionClicks | Long | The count of clicks on the action button of the Sponsored InMail. |
| AdUnitClicks | Long | The count of clicks on the ad unit displayed alongside the Sponsored InMail. |
| CardClicks | Long | The number of clicks for each card of a carousel ad. |
| CardImpressions | Long | The number of impressions shown for each card of a carousel ad. |
| Clicks | Long | The count of chargeable clicks. |
| CommentLikes | Long | The count of likes of a comment. |
| Comments | Long | The count of comments. Sponsored |
| CompanyPageClicks | Long | The count of clicks to view the company page. |
| ConversionValueInLocalCurrency | Decimal | Value of the conversions in the account's local currency based on rules defined by the advertiser. |
| CostInLocalCurrency | Decimal | Cost in the account's local currency based on the pivot and timeGranularity. |
| CostInUsd | Decimal | Cost in USD based on the pivot and timeGranularity. |
| UsageStartTime | String | Date start covered by the report data point. |
| UsageEndTime | String | Date end covered by the report data point. |
| ExternalWebsiteConversions | Long | The count of conversions indicated by pixel loads on an external advertiser website. |
| ExternalWebsitePostClickConversions | Long | The count of post-click conversions indicated by pixel loads on an external advertiser website. |
| ExternalWebsitePostViewConversions | Long | The count of post-view conversions indicated by pixel loads on an external advertiser website. |
| Follows | Long | The count of follows. Sponsored |
| FullScreenPlays | Long | A user taps on the video, going into video view mode. |
| Impressions | Long | This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails. |
| LandingPageClicks | Long | The count of clicks which take the user to the creative landing page. |
| LeadGenerationMailContactInfoShares | Long | The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail. |
| LeadGenerationMailInterestedClicks | Long | The count of InMail recipients showing interest. |
| Likes | Long | The count of likes. |
| OneClickLeadFormOpens | Long | The count of times a user opened the lead form for a One Click Lead Gen campaign. |
| OneClickLeads | Long | The count of leads generated through One Click Lead Gen. |
| Opens | Long | The count of opens of Sponsored InMail. |
| OtherEngagements | Long | The count of user interactions with the ad unit that do not fit into any other more specific category. |
| Shares | Long | The count of shares. |
| TextUrlClicks | Long | The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. |
| TotalEngagements | Long | The count of all user interactions with the ad unit. |
| VideoCompletions | Long | The count of video ads that played 97-100% of the video. |
| VideoFirstQuartileCompletions | Long | The count of video ads that played through the first quartile of the video. |
| VideoMidpointCompletions | Long | The count of video ads that played through the midpoint of the video. |
| VideoStarts | Long | The count of video ads that were started by a user. |
| VideoThirdQuartileCompletions | Long | The count of video ads that played through the third quartile of the video. |
| VideoViews | Long | A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. |
| ViralCardClicks | Long | The number of viralClicks for each card of a carousel ad. |
| ViralCardImpressions | Long | The number of viralImpressions shown for each card of a carousel ad. |
| ViralClicks | Long | The count of clicks on viral impressions. |
| ViralComments | Long | The count of comments from viral impressions for this activity. |
| ViralCompanyPageClicks | Long | The count of clicks to view the company page from viral impressions for this activity. |
| ViralExternalWebsiteConversions | Long | The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. |
| ViralExternalWebsitePostClickConversions | Long | The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. |
| ViralExternalWebsitePostViewConversions | Long | The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. |
| ViralFollows | Long | The count of follows from viral impressions for this activity. |
| ViralFullScreenPlays | Long | A user taps on the video, going into video view mode. |
| ViralImpressions | Long | The count of viral impressions for this activity. |
| ViralLandingPageClicks | Long | The count of clicks on viral impressions to take the user to the creative landing page. |
| ViralLikes | Long | The count of likes from viral impressions for this activity. |
| ViralOneClickLeadFormOpens | Long | The count of times a user opened the lead form for viral impressions from a Lead Gen campaign. |
| ViralOneClickLeads | Long | The count of leads generated through One Click Lead Gen from viral impressions for this activity. |
| ViralOtherEngagements | Long | The count of user interactions with viral impressions that do not fit into any other more specific category. |
| ViralShares | Long | The count of shares from viral impressions for this activity. |
| ViralTotalEngagements | Long | The count of all user interactions with a viral ad unit. |
| ViralVideoCompletions | Long | The count of viral video ads that played 97-100% of the video. |
| ViralVideoFirstQuartileCompletions | Long | The count of viral video ads that played through the first quartile of the video. |
| ViralVideoMidpointCompletions | Long | The count of viral video ads that played through the midpoint of the video. |
| ViralVideoStarts | Long | The count of viral video ads that were started by a user. |
| ViralVideoThirdQuartileCompletions | Long | The count of viral video ads that played through the third quartile of the video. |
| ViralVideoViews | Long | A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. |
| AverageDailyReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (daily). |
| AverageDailyReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (daily). |
| AverageDailyReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily). |
| AveragePreviousSevenDayReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (last 7 days). |
| AveragePreviousSevenDayReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (last 7 days). |
| AveragePreviousSevenDayReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days). |
| AveragePreviousThirtyDayReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (last 30 days). |
| AveragePreviousThirtyDayReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (last 30 days). |
| AveragePreviousThirtyDayReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days). |
| ApproximateMemberReach | Long | The estimated number of unique member accounts with at least one impression. This metric is only available when the number of days in the date range is less than or equal to 92 days. It will be returned only if the following pivots/columns are specified in the query: Creative, Campaign, CampaignGroup, CampaignType and/or ServingLocation. Additionally, it will not be available for the current UTC day. The expected delay for current UTC day will be 24-48 hours. If the present day is specified in ReportEndTime, the date range will only return reach for days where data exists. |
| ValidWorkEmailLeads | Long | The count of leads with a valid work email that does not use an established free or personal email domain. |
| PostClickRegistrations | Decimal | The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page. |
| PostViewRegistrations | Decimal | The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page. |
| DownloadClicks | Long | The number of times users have indicated the intent to download the media in an ad by clicking the download icon. |
| QualifiedLeads | Long | The count of qualified leads shared by the advertiser. Qualified lead is a lead that has been deemed more likely to become a customer compared to other leads, based on their engagement and fit. |
| CostPerQualifiedLead | Decimal | How much money was spent per qualified lead. Ratio is costInLocalCurrency / qualifiedLeads. |
| MessagingAdvertSendCount | Long | The count of sends of Sponsored Messaging ads. |
| MessagingAdvertOpenCount | Long | The count of opens of Sponsored Messaging ads. |
The Audience Count API allows advertisers to forecast the reach of targeting criteria.
The AudienceCount view allows advertisers to forecast the reach of targeting criteria.
The 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 | Description |
| ActiveAudience | Integer | Active audience count for the given targeting criteria. |
| TotalAudience | Integer | Total audience count for the given targeting criteria. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AgeRange | String | Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647) |
| DegreeId | String | Educational degrees attained to match against those of the member. |
| FieldOfStudyId | String | Fields of study to match against those listed by the member. |
| Gender | String | Genders to match against member. Supported values are: MALE, FEMALE |
| IndustryId | String | Industries to be targeted. |
| JobFunctionId | String | Top level groupings of supertitles to be targeted. |
| LocationId | String | Location to be targeted. |
| ProfileLocationId | String | The values are similar to |
| SeniorityId | String | Seniorities to be targeted. |
| SkillId | String | Skills to match against the member's listed skills. |
| StaffCountRange | String | Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647) |
| TitleId | String | Job titles to match against the member's current title. |
| AudienceMatchingSegmentId | String | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. |
| RetargetingSegmentId | String | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. |
| EmployerId | String | Employer ID to match against member's listed companies. |
| CompanyId | String | Company ID to match against member's listed companies. |
| InterfaceLocaleId | String | Locale ID to match against member's preferred locale settings. |
The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
The 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 | Description |
| SuggestedBidDefault | String | The suggested bid |
| SuggestedBidMin | String | Low end of suggested bid range |
| SuggestedBidMax | String | High end of suggested bid range |
| DailyBudgetLimitsDefault | String | Default daily budget |
| DailyBudgetLimitsMin | String | Minimum daily budget |
| DailyBudgetLimitsMax | String | Maximum daily budget |
| BidLimitsMax | String | The maximum bid allowed |
| BidLimitsMin | String | The minimum bid allowed, also known as the floor price |
| Account | String | Sponsored account URN. |
| CampaignType | String | The campaign type.
デフォルト値はTEXT_ADです。 |
| BidType | String | The bidding type.
デフォルト値はCPMです。 |
| MatchType | String | The matching type.
デフォルト値はEXACTです。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AgeRange | String | Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647) |
| DegreeId | String | Educational degrees attained to match against those of the member. |
| FieldOfStudyId | String | Fields of study to match against those listed by the member. |
| Gender | String | Genders to match against member. Supported values are: MALE, FEMALE |
| IndustryId | String | Industries to be targeted. |
| JobFunctionId | String | Top level groupings of supertitles to be targeted. |
| LocationId | String | Location to be targeted. |
| ProfileLocationId | String | The values are similar to |
| SeniorityId | String | Seniorities to be targeted. |
| SkillId | String | Skills to match against the member's listed skills. |
| StaffCountRange | String | Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647) |
| TitleId | String | Job titles to match against the member's current title. |
| AudienceMatchingSegmentId | String | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. |
| RetargetingSegmentId | String | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. |
| EmployerId | String | Employer ID to match against member's listed companies. |
| CompanyId | String | Company ID to match against member's listed companies. |
| InterfaceLocaleId | String | Locale ID to match against member's preferred locale settings. |
The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.
The 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'
| Name | Type | Description |
| Id | String | Numerical identifier for the campaign group |
| Account | String | URN identifying the advertising account associated with the Campaign Group. This value is immutable once set |
| Name | String | The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose |
| Status | String | Current Status of the campaign group |
| TotalBudgetAmount | Decimal | Maximum amount to spend over the life of the Campaign Group. |
| TotalBudgetCurrencyCode | String | ISO currency code. The currency code must match that of the parent account. |
| ScheduleStartTime | Datetime | Represents the inclusive (greater than or equal to) value in which to start the range. |
| ScheduleEndTime | Datetime | Scheduled date range to run associated objects. |
| Backfilled | Boolean | Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns. |
| AdAccountId | String | Id of the account |
The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.
NOTE: This view is deprecated and will be removed in early 2025.
The CampaignInsights view returns a list of the analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.
The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.
SELECT * FROM CampaignInsights WHERE Campaign = '123456'
| Name | Type | Description |
| Campaign | String | The campaign to which this recommendation belongs. |
| AverageSpendAmount | String | The average spend of the entity. |
| AverageSpendCurrencyCode | String | The currency code of the average spend. |
| BidAmount | String | A prediction of how much additional impressions could be generated from a different bid. |
| BidCurrencyCode | String | The currency code of additional impressions. |
| RelativeImpressions | Decimal | A prediction of how much additional impressions could be generated from a different bid. |
| BudgetExhaustedAt | Timestamp | Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time. |
| CampaignRelevanceScore | Long | A score between 0 and 10 (inclusive) indicating how relevant this campaign is compared to its competitors. |
| DailyBudgetUtilization | Decimal | The average daily budget utilization. |
| TotalBudgetUtilization | Decimal | The fraction of the total budget this ad entity has spent so far. |
The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.
The 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'
| Name | Type | Description |
| Id | String | Numerical identifier for the campaign |
| Account | String | URN identifying the advertising account associated with the Campaign. |
| CampaignGroup | String | Numerical identifier for the campaign group. |
| AssociatedEntity | String | An URN for a strongly associated object, with semantics varying based on the Campaign type. |
| AudienceExpansionEnabled | Boolean | Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria |
| CostType | String | CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link |
| CreativeSelection | String | ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance |
| DailyBudgetAmount | String | The amount of money as a real number string |
| DailyBudgetCurrency | String | ISO currency code |
| Country | String | An uppercase two-letter country code as defined by ISO-3166. |
| Language | String | A lowercase two-letter language code as defined by ISO-639. |
| Name | String | The name of the Campaign |
| OffsiteDeliveryEnabled | Boolean | Allow this campaign access to be served on the LinkedIn Advertising Network. |
| ScheduleStartTime | Datetime | Scheduled date range to run associated creatives. |
| ScheduleEndTime | Datetime | Scheduled date range to run associated creatives. |
| Status | String | Current Status of the campaign |
| Type | String | Type of campaign |
| UnitCostAmount | String | Amount to bid per click, impression, or other event depending on the pricing model. |
| UnitCostCurrency | String | Currency of the UnitCostAmount |
| ObjectiveType | String | The Campaign Objective type. |
| AdAccountId | String | Id of the account |
| ConnectedTelevisionOnly | Boolean | Flag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false. |
| TimeSpanDuration | Integer | Represents the length of time. |
| TimeSpanUnit | String | Represents the unit of the duration of time |
| Frequency | Integer | The number of times the campaign is shown to a member. |
Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.
The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.
The 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'
| Name | Type | Description |
| Id | String | Numerical identifier for the Conversion. |
| Account | String | URN identifying the advertising account associated with the Conversion. |
| DomainId | String | The insightTagDomain key that this Conversion resides under. |
| Name | String | A short name for this rule, which will be shown in the UI and in reports. |
| Created | String | The timestamp when the Conversion was created. |
| LastModified | String | The timestamp when the Conversion was last modified. |
| LastCallbackAt | String | The timestamp of the last callback from the Conversion. |
| Amount | String | The amount of money as a real number string. |
| CurrencyCode | String | Identifying code for currency type. See currency codes for the valid codes. |
| Type | String | The type of the rule. |
| Enabled | String | Set to true or false to enable or disable this rule from matching on the advertiser's website. |
| ImagePixelTag | String | The HTML representation of the image pixel. |
| PostClickAttributionWindowSize | Integer | The HTML representation of the image pixel. |
| ViewThroughAttributionWindowSize | Integer | The HTML representation of the image pixel. |
The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.
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 Account = '510013292'
SELECT * FROM Creatives WHERE Account IN ('510013292', '510013293')
SELECT * FROM Creatives WHERE Campaign = '198952936'
SELECT * FROM Creatives WHERE IntendedStatus = 'ACTIVE'
| Name | Type | Description |
| Id | String | Numerical identifier for the creative. |
| Account | String | URN identifying the advertising account associated with the creative. |
| Campaign | String | URN identifying the campaign associated with the creative. |
| Content | String | Content sponsored in the creative. |
| CreatedAt | Datetime | Datetime when the creative was first created |
| CreatedBy | String | Entity that developed the creative. |
| IntendedStatus | String | Creative user intended status. |
| IsServing | Boolean | This indicates whether the creative is currently being served or not. |
| ServingHoldReasons | String | Array that contains all the reasons why the creative is not serving. |
| LastModifiedAt | Datetime | Datetime when the creative was last modified. |
| LastModifiedBy | String | Entity that modified the creative. |
| ReviewStatus | String | The current review status of the creative. |
| IsTest | Boolean | Flag showing whether this creative is a test creative, i.e., belongs to a test campaign. |
| AdAccountId | String | Id of the account |
| CallToActionLabel | String | Label for the CallToAction button. Present only if the campaign objective is LEAD_GENERATION. |
| CallToActionFormId | String | The Id of the corresponding form which the call to action redirects to. Present only if the campaign objective is LEAD_GENERATION. |
| RejectionReasons | String | A comma-seperated list of values with reasons explaining why the creative has been rejected. |
| Name | String | The name of the creative that can be set by advertiser; primarily used to make it easier to reference a Creative and to recall its purpose. |
Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 | Description |
| Id | String | Degree id |
| URN | String | Standardized degree URN |
| Name | String | Degree name in various locales. Represented as MultiLocaleString type. |
Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
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 | Description |
| Id | String | Field of study id |
| URN | String | Standardized field of study URN |
| Name | String | Field of study name in various locales. Represented as MultiLocaleString type. |
Query form data for the forms that belong to a specified owner (account).
The Account column must be specified in the criteria to use this view.
For the Account column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:
SELECT * FROM Forms WHERE Account = '512859024';
SELECT * FROM Forms WHERE Account IN ('512859024', '513009855');
When no criteria is specified as shown below:
SELECT * FROM Forms;, we internally post-process the query to the following before executing:
SELECT * FROM Forms WHERE Account IN (SELECT Id FROM Accounts);
The rest of the query is processed client-side.
| Name | Type | Description |
| Id [KEY] | String | Identifier for the form. |
| Account | String | Identifier for the owner of the form. This is the advertiser account. |
| Created | Timestamp | Timestamp for creation of the form. |
| LastModified | Timestamp | Timestamp for last modification of the form. |
| Description | String | Description of the form, visible to both the owner and the viewer. |
| Headline | String | Headline of the form, visible to both the owner and the viewer. |
| LandingPage | String | The landing page URL after the viewer clicks on submit. |
| LegalDisclaimer | String | Advertiser's legal disclaimer to accompany this form. |
| Name | String | Name of the form, visible to the owner of the form but not visible to the viewer. |
| PrivacyPolicy | String | The URL of the privacy policy that covers any data passed to the owner of the form. |
| Country | String | A lowercase two-letter language code as defined by ISO-639-1 |
| Language | String | An uppercase two-letter country code as defined by ISO-3166. |
| ReviewStatus | String | The status of the review of the form. |
| ReviewedAt | Timestamp | Timestamp for when the form's review status was initiated/last updated. |
| Status | String | Indicates the state of review for the Lead Form. Can be one of the following: DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED. |
| VersionTag | String | The number of times the form has been modified. |
Provides the display name for a given geo Id, or a set of geo Ids.
The Id column must be specified in the criteria to use this view.
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 GeoLocations WHERE Id = '123456';
SELECT * FROM GeoLocations WHERE Id IN ('123456', '234567');
The rest of the query is processed client-side.
| Name | Type | Description |
| Id [KEY] | String | Identifier for the location. |
| Name | String | The name of the location. |
| LocaleCountry | String | An uppercase two-letter country code as defined by ISO-3166. |
| LocaleLanguage | String | A lowercase two-letter language code as defined by ISO-639. |
Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 | Description |
| Id | String | Industry id |
| URN | String | Standardized industry URN |
| Name | String | Industry name in various locales. Represented as MultiLocaleString type. |
| ChildrenIndustries | String | The URNs of the children industries associated with this node. |
| ParentIndustries | String | The URNs of the parent industry associated with this node. |
Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 | Description |
| Id | String | Job function id |
| URN | String | Standardized Job function URN |
| Name | String | Job function name in various locales. Represented as MultiLocaleString type. |
Retrieve all posts for an organization.
The OrganizationId column is required and must be specified in the criteria to use this view.
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.
"com.linkedin.common.CompanyAttributedEntity": { "company": "urn:li:organization:12345" }
SELECT * FROM Posts WHERE OrganizationId = '123456789'
| Name | Type | Description |
| Id [KEY] | String | Id of the post. |
| Author | String | Author of the post. |
| Commentary | String | The user generated commentary for the post. |
| Content | String | The posted content. |
| CreatedAt | Datetime | Datetime when the post was created. |
| IsReshareDisabledByAuthor | Boolean | Indicates whether resharing of the post has been disabled by the author. |
| LastModifiedAt | Datetime | Datetime when the post was lastly modified. |
| LifecycleState | String | Lifecycle state of the post. |
| PublishedAt | Datetime | Datetime at which the content was published. |
| Visibility | String | Visibility restrictions on content. |
| OrganizationId | String | Id of the organization who created the post. |
| ContentLandingPage | String | Web page that is opened when the member clicks on the associated content. |
| IsDirectSponsoredContent | Boolean | Whether or not this post is Direct Sponsored Content. |
| DirectSponsoredContentAdAccount | String | The Ad Account that created the Direct Sponsored Content. |
| DirectSponsoredContentAdType | String | The type of Direct Sponsored Content. |
| DirectSponsoredContentName | String | Plain text name of the Direct Sponsored Content post. |
| DirectSponsoredContentStatus | String | The status of the advertising company content. |
Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 | Description |
| Id | String | Seniority id |
| URN | String | Standardized Seniority URN |
| Name | String | Seniority name in various locales. Represented as MultiLocaleString type. |
Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 | Description |
| Id | String | skill id |
| Name | String | skill name in various locales. Represented as MultiLocaleString type. |
The socialActions API allows access to both personal and organization social actions.
The 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 | Description |
| TotalFirstLevelComments | Integer | Total number of first level comments. |
| AggregatedTotalComments | Integer | Total number of aggregated comments. |
| LikedByCurrentUser | Boolean | Indicator if the post is liked by current user. |
| TotalLikes | Integer | Total number of likes. |
| Target | String | Total number of likes. |
| UGCPostId | String | Id of UGC Post. |
Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.
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'
| Name | Type | Description |
| Id | String | The campaign to which this recommendation belongs. |
| Creative | String | The campaign to which this recommendation belongs. |
| Account | String | The average spend of the entity. |
| Event | String | The currency code of the average spend. |
| Platform | String | A prediction of how much additional impressions could be generated from a different bid. |
| TrackingUrl | String | The currency code of additional impressions. |
| Created | Timestamp | A prediction of how much additional impressions could be generated from a different bid. |
| LastModified | Timestamp | Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time. |
Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
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 | Description |
| Id | String | Titles id |
| URN | String | Standardized Titles URN |
| Name | String | Titles name in various locales. Represented as MultiLocaleString type. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタム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 トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）の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 | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | LinkedIn Marketing Solutions から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | A specific scope that the user requires the access token. |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみ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 接続プロパティは設定しないでください。 |
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 を参照してください。
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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | LinkedIn Marketing Solutions から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
LinkedIn Marketing Solutions から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、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.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。