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 Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、LinkedIn Marketing Solutions にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
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 | The response data for leads that filled out a form within the last 90 days. Older responses are not included. |
Analytics | The Analytics API provides account, campaign, and creative level insights on click intelligence numbers. |
AudienceCount | The Audience Count API allows advertisers to forecast the reach of targeting criteria. |
BudgetPricing | The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria. |
CampaignGroups | The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
CampaignInsights | The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions. |
CampaignRecommendations | The Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives. |
Campaigns | The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
Conversions | Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business. |
Creatives | The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN. |
Degrees | Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
FieldsOfStudy | Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Forms | LinkedIn Lead Gen Forms make it easy for advertisers to collect leads through forms that LinkedIn members can submit. |
Industries | Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
JobFunctions | Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Locations | Location taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Posts | Retrieve all posts for an organization. |
Seniorities | Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Skills | Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
SocialActions | The socialActions API allows access to both personal and organization social actions. |
ThirdPartyTracking | Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag. |
Titles | Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
The Account status finder returns all accounts in a specified status that the authenticated user has access to.
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 |
The response data for leads that filled out a form within the last 90 days. Older responses are not included.
Note: This view is unavailable when authenticating with the embedded OAuth app. Create a custom app with the required r_ads_leadgen_automation scope (see カスタムOAuth アプリケーションの作成) to access it.
Name | Type | Description |
Id | String | URN identifying the ad form response. |
Account | String | The URN which describes which account the response is generated under. |
Campaign | String | URN identifying the campaign to which the form response is responding. |
Creative | String | URN identifying the creative to which the form response is responding. |
Form | String | URN identifying which form this response responds to. |
SubmitedAt | Datetime | The time when the form response was submitted. |
LeadType | String | Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED. |
TestLead | Boolean | Whether the lead is a test lead |
ConsentResponses | String | A JSON object containing all the consent responses. |
Answers | String | A JSON object containing all the answers and the respective questions. |
The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.
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 |
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です。 |
ReportStartTime | String | The start time of the period. |
ReportEndTime | String | The end time of the period. |
ActionClicks | Long | The count of clicks on the action button of the Sponsored InMail. |
AdUnitClicks | Long | The count of clicks on the ad unit displayed alongside the Sponsored InMail. |
CardClicks | Long | The number of clicks for each card of a carousel ad. |
CardImpressions | Long | The number of impressions shown for each card of a carousel ad. |
Clicks | Long | The count of chargeable clicks. |
CommentLikes | Long | The count of likes of a comment. |
Comments | Long | The count of comments. Sponsored |
CompanyPageClicks | Long | The count of clicks to view the company page. |
ConversionValueInLocalCurrency | Decimal | Value of the conversions in the account's local currency based on rules defined by the advertiser. |
CostInLocalCurrency | Decimal | Cost in the account's local currency based on the pivot and timeGranularity. |
CostInUsd | Decimal | Cost in USD based on the pivot and timeGranularity. |
UsageStartTime | String | Date start covered by the report data point. |
UsageEndTime | String | Date end covered by the report data point. |
ExternalWebsiteConversions | Long | The count of conversions indicated by pixel loads on an external advertiser website. |
ExternalWebsitePostClickConversions | Long | The count of post-click conversions indicated by pixel loads on an external advertiser website. |
ExternalWebsitePostViewConversions | Long | The count of post-view conversions indicated by pixel loads on an external advertiser website. |
Follows | Long | The count of follows. Sponsored |
FullScreenPlays | Long | A user taps on the video, going into video view mode. |
Impressions | Long | This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails. |
LandingPageClicks | Long | The count of clicks which take the user to the creative landing page. |
LeadGenerationMailContactInfoShares | Long | The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail. |
LeadGenerationMailInterestedClicks | Long | The count of InMail recipients showing interest. |
Likes | Long | The count of likes. |
OneClickLeadFormOpens | Long | The count of times a user opened the lead form for a One Click Lead Gen campaign. |
OneClickLeads | Long | The count of leads generated through One Click Lead Gen. |
Opens | Long | The count of opens of Sponsored InMail. |
OtherEngagements | Long | The count of user interactions with the ad unit that do not fit into any other more specific category. |
Shares | Long | The count of shares. |
TextUrlClicks | Long | The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. |
TotalEngagements | Long | The count of all user interactions with the ad unit. |
VideoCompletions | Long | The count of video ads that played 97-100% of the video. |
VideoFirstQuartileCompletions | Long | The count of video ads that played through the first quartile of the video. |
VideoMidpointCompletions | Long | The count of video ads that played through the midpoint of the video. |
VideoStarts | Long | The count of video ads that were started by a user. |
VideoThirdQuartileCompletions | Long | The count of video ads that played through the third quartile of the video. |
VideoViews | Long | A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. |
ViralCardClicks | Long | The number of viralClicks for each card of a carousel ad. |
ViralCardImpressions | Long | The number of viralImpressions shown for each card of a carousel ad. |
ViralClicks | Long | The count of clicks on viral impressions. |
ViralComments | Long | The count of comments from viral impressions for this activity. |
ViralCompanyPageClicks | Long | The count of clicks to view the company page from viral impressions for this activity. |
ViralExternalWebsiteConversions | Long | The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. |
ViralExternalWebsitePostClickConversions | Long | The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. |
ViralExternalWebsitePostViewConversions | Long | The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. |
ViralFollows | Long | The count of follows from viral impressions for this activity. |
ViralFullScreenPlays | Long | A user taps on the video, going into video view mode. |
ViralImpressions | Long | The count of viral impressions for this activity. |
ViralLandingPageClicks | Long | The count of clicks on viral impressions to take the user to the creative landing page. |
ViralLikes | Long | The count of likes from viral impressions for this activity. |
ViralOneClickLeadFormOpens | Long | The count of times a user opened the lead form for viral impressions from a Lead Gen campaign. |
ViralOneClickLeads | Long | The count of leads generated through One Click Lead Gen from viral impressions for this activity. |
ViralOtherEngagements | Long | The count of user interactions with viral impressions that do not fit into any other more specific category. |
ViralShares | Long | The count of shares from viral impressions for this activity. |
ViralTotalEngagements | Long | The count of all user interactions with a viral ad unit. |
ViralVideoCompletions | Long | The count of viral video ads that played 97-100% of the video. |
ViralVideoFirstQuartileCompletions | Long | The count of viral video ads that played through the first quartile of the video. |
ViralVideoMidpointCompletions | Long | The count of viral video ads that played through the midpoint of the video. |
ViralVideoStarts | Long | The count of viral video ads that were started by a user. |
ViralVideoThirdQuartileCompletions | Long | The count of viral video ads that played through the third quartile of the video. |
ViralVideoViews | Long | A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. |
AverageDailyReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (daily). |
AverageDailyReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (daily). |
AverageDailyReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily). |
AveragePreviousSevenDayReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (last 7 days). |
AveragePreviousSevenDayReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (last 7 days). |
AveragePreviousSevenDayReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days). |
AveragePreviousThirtyDayReachMetricsApproximateReach | Decimal | The average reach, or unique member accounts with at least one impression (last 30 days). |
AveragePreviousThirtyDayReachMetricsApproximateFrequency | Decimal | The average of impressions shown to each member account that received at least one impression (last 30 days). |
AveragePreviousThirtyDayReachMetricsApproximateCost | Decimal | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days). |
ApproximateUniqueImpressions | Long | The estimated number of unique member accounts with at least one impression. |
ValidWorkEmailLeads | Long | The count of leads with a valid work email that does not use an established free or personal email domain. |
The Audience Count API allows advertisers to forecast the reach of targeting criteria.
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.
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 Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.
The CampaignInsights view returns a list of the recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.
The 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 CampaignRecommendations WHERE Campaign = '123456'
Name | Type | Description |
Campaign | String | The campaign to which this recommendation belongs. |
CreatedAt | Timestamp | The epoch timestamp in milliseconds of when this recommendation was generated. |
ExpandAudience | Boolean | If true, the recommendation is to expand the audience of this campaign. |
ImproveCreativeQuality | Long | If true, the recommendation is to improve the quality of this campaign's creatives. |
NumOfCreatives | Long | The recommended number of creatives in the campaign. |
Priority | Long | The priority of the recommendation, 0 indexed, with 0 being the highest priority. |
Type | String | The type of recommendation. |
The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
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 |
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 |
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. |
LinkedIn Lead Gen Forms make it easy for advertisers to collect leads through forms that LinkedIn members can submit.
The Forms view returns a list of the forms that LinkedIn members can submit. With Lead Gen Forms, advertisers can collect leads at much higher conversion rates.
The 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 Forms WHERE Account = '123456'
Name | Type | Description |
Id | String | Numerical identifier for the AdForm. |
Account | String | URN identifying the owner of the form. This is the advertiser account. |
Created | Timestamp | Timestamp for creation of the form. |
LastModified | Timestamp | Timestamp for last modification of the form. |
Description | String | Description of the form, visible to both the owner and the viewer. |
Headline | String | Headline of the form, visible to both the owner and the viewer. |
LandingPage | String | The landing page URL after the viewer clicks on submit. |
LegalDisclaimer | String | Advertiser's legal disclaimer to accompany this form. |
Name | String | Name of the form, visible to the owner of the form but not visible to the viewer. |
PrivacyPolicy | String | The URL of the privacy policy that covers any data passed to the owner of the form. |
Country | String | Locale of the form. |
Language | String | Locale of the form. |
ReviewStatus | String | The status of the review of the form. |
ReviewedAt | Timestamp | The timestamp of the review of the form. |
Status | String | DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED. |
VersionTag | String | The number of times the form has been modified. |
Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
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. |
Location taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
The Locations view returns a list of the locations and regions found accross LinkedIn so they can be used as dimensions in analytic requests.
The 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 Locations
Name | Type | Description |
Id | String | The country code. |
CountryGroup | String | The country group URN that this country belongs to. |
URN | String | Standardized country URN |
Name | String | Country name in various locales. Represented as LocaleString type. |
Retrieve all posts for an organization.
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. |
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. |
プロパティ | 説明 |
APIVersion | The version of the LinkedIn Marketing API to be used. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | A specific scope that the user requires the access token. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
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 を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
プロパティ | 説明 |
APIVersion | The version of the LinkedIn Marketing API to be used. |
The version of the LinkedIn Marketing API to be used.
The API version used by default is 202308. To use a different API version set this to the format YYYYMM.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | A specific scope that the user requires the access token. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
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 | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はLinkedIn Marketing Solutions への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\LinkedInAds Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。
Pagesize プロパティは、LinkedIn Marketing Solutions から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Analytics WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。