このページでは、CData Cloud でのLinkedIn Marketing Solutions への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

LinkedIn Marketing Solutions への接続

接続の確立 は、CData Cloud にデータベースを作成するためのLinkedIn Marketing Solutions への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してLinkedIn Marketing Solutions からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、LinkedIn Marketing Solutions に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

LinkedIn Marketing Solutions への認証（OAuth）

LinkedIn Marketing Solutions はOAuth 認証のみサポートします。

カスタムOAuth アプリケーションの作成

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、から接続する際に使用できます。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

LinkedIn Marketing Solutions で使用するカスタムOAuth アプリケーションを作成するには：

1. LinkedIn developers dashboard にログインしてCreate New App をクリックします。
2. アプリに関連付けたいページのURL およびユーザーがアプリケーションへのアクセス許可を求める際に表示される情報を入力します。
3. アプリケーションを選択します。
4. Products タブでSign in with LinkedIn を選択します。
5. LinkedIn ページのオーナーがアプリケーションを承認するのを待ちます。承認されると、アプリケーションは必要とされるOAuth 2.0の権限を持つことになります。これらのアクセス権限は、Auth タブで表示されます。
6. リダイレクトURI を設定：
   • デスクトップアプリケーションでは、Auth タブでリダイレクトURI をhttp://localhost:33333 または任意のポート番号に設定してください。接続するには、CallbackURL 接続プロパティをこのURL に設定する必要があります。
     OAuthClientId およびOAuthClientSecret が、同じページに表示されます。
7. アプリケーションのScope プロパティを、以下のスコープすべてを含むように設定します。
   • r_emailaddress
   • r_ads,
   • w_organization_social
   • rw_ads,r_basicprofile
   • r_liteprofile
   • r_ads_reporting
   • r_organization_social
   • r_member_social
   • rw_organization_admin
   • w_member_social
   • r_1st_connections_size
   • r_ads_leadgen_automation

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud は、LinkedIn Marketing Solutions API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

テーブル

CData Cloud は、データをビュー にモデル化し、標準SQL でのクエリおよび更新を容易にします。

ビュー

ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - LinkedIn Marketing Solutions ビュー

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.

Table Specific Information

Select

The Accounts view returns a list of the accounts that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Accounts WHERE Status = 'ACTIVE'

Columns

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.

Columns

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.

Table Specific Information

Select

The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT ReportStartTime, ReportEndTime, Clicks, Impressions, Follows, TotalEngagements FROM Analytics WHERE ReportStartTime = '07/20/2016' AND Account = '123456789' AND Granularity = 'MONTHLY'

Select Rules

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.

Columns

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.

Table Specific Information

Select

The AudienceCount view allows advertisers to forecast the reach of targeting criteria.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM AudienceCount WHERE AgeRanges = '(25,34)'

SELECT * FROM AudienceCount WHERE DegreesId = '1234'

SELECT * FROM AudienceCount WHERE FieldsOfStudyId = '1234'

SELECT * FROM AudienceCount WHERE Genders = 'MALE'

SELECT * FROM AudienceCount WHERE IndustriesId = '1234'

SELECT * FROM AudienceCount WHERE JobFunctionsId = '1234'

SELECT * FROM AudienceCount WHERE LocationsId = '1234'

SELECT * FROM AudienceCount WHERE ProfileLocationsId = '1234'

SELECT * FROM AudienceCount WHERE SenioritiesId = '1234'

SELECT * FROM AudienceCount WHERE SkillsId = '1234'

SELECT * FROM AudienceCount WHERE StaffCountRanges = '(11,50)'

SELECT * FROM AudienceCount WHERE TitlesId = '1234'

Select Rules

Audience count reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.

Columns

Name	Type	Description
ActiveAudience	Integer	Active audience count for the given targeting criteria.
TotalAudience	Integer	Total audience count for the given targeting criteria.

Pseudo-Columns

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.

Table Specific Information

Select

The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM BudgetPricing WHERE AgeRanges = '(25,34)' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE DegreesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE FieldsOfStudyId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE Genders = 'MALE' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE IndustriesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE JobFunctionsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE LocationsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE ProfileLocationsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE SenioritiesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE SkillsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE StaffCountRanges = '(11,50)' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE TitlesId = '1234' AND Account = '1234'

Select Rules

Budget pricing reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.
Filter	Required	CampaignType, Account, BidType, MatchType Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. The default value for CampaignType will be TEXT_AD. The default value for BidType will be CPM. The default value for MatchType will be EXACT. If there is no Account specified there will be records for every account that belongs to the user.

Columns

Name	Type	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です。

Pseudo-Columns

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.

Table Specific Information

Select

The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignGroups WHERE Status = 'ACTIVE'

Columns

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.

Table Specific Information

Select

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignInsights WHERE Campaign = '123456'

Columns

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.

Table Specific Information

Select

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignRecommendations WHERE Campaign = '123456'

Columns

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.

Table Specific Information

Select

The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Campaigns WHERE Status = 'ACTIVE'

Columns

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.

Table Specific Information

Select

The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Conversions WHERE Account = '123456'

Columns

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.

Table Specific Information

Select

The Creatives view returns a list of the creatives that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Creatives WHERE Id = '179345687'

SELECT * FROM Creatives WHERE Account = '510013292'

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

SELECT * FROM Creatives WHERE Campaign = '198952936'

SELECT * FROM Creatives WHERE IntendedStatus = 'ACTIVE'

Columns

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.

Table Specific Information

Select

The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Degrees

Columns

Name	Type	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.

Table Specific Information

Select

The FieldsOfStudy view returns a list of the fields of study found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FieldsOfStudy

Columns

Name	Type	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.

Table Specific Information

Select

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Forms WHERE Account = '123456'

Columns

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.

Table Specific Information

Select

The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Industries

Columns

Name	Type	Description
Id	String	Industry id
URN	String	Standardized industry URN
Name	String	Industry name in various locales. Represented as MultiLocaleString type.
ChildrenIndustries	String	The URNs of the children industries associated with this node.
ParentIndustries	String	The URNs of the parent industry associated with this node.

Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM JobFunctions

Columns

Name	Type	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.

Table Specific Information

Select

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Locations

Columns

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.

Select

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

The Cloud will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

• OrganizationId supports the '=' comparisons.

OrganizationID

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

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

Code Samples

The following queries are processed server side:

SELECT * FROM Posts WHERE OrganizationId = '123456789'

Columns

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.

Table Specific Information

Select

The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Seniorities

Columns

Name	Type	Description
Id	String	Seniority id
URN	String	Standardized Seniority URN
Name	String	Seniority name in various locales. Represented as MultiLocaleString type.

Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Skills

Columns

Name	Type	Description
Id	String	skill id
Name	String	skill name in various locales. Represented as MultiLocaleString type.

The socialActions API allows access to both personal and organization social actions.

Select

The Cloud will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

• UGCPostId supports the '=, IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM SocialActions WHERE UGCPostId = 'urn:li:share:12345'

SELECT * FROM SocialActions WHERE UGCPostId IN ('urn:li:share:12345', 'urn:li:share:23456')

Columns

Name	Type	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.

Table Specific Information

Select

The Forms view returns a list of the Third-party tracking tags through the ad creative they're associated with. The following request takes in an ad creative URN in the creative parameter to search for third-party tracking tags linked to that ad creative.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM ThirdPartyTracking WHERE Creative = '123456'

Columns

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.

Table Specific Information

Select

The Titles view returns a list of the job titles found accross LinkedIn so they can be used as dimensions in analytic requests.

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Titles

Columns

Name	Type	Description
Id	String	Titles id
URN	String	Standardized Titles URN
Name	String	Titles name in various locales. Represented as MultiLocaleString type.

ストアドプロシージャはファンクションライクなインターフェースで、LinkedIn Marketing Solutions の単純なSELECT 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにLinkedIn Marketing Solutions から関連するレスポンスデータを返します。

CData Cloud - LinkedIn Marketing Solutions ストアドプロシージャ

Name	Description

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、LinkedIn Marketing Solutions のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Analytics テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Analytics' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

主キーおよび外部キーについて説明します。

次のクエリは、Analytics テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Analytics' 
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:linkedinads:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Connection

---

プロパティ	説明
APIVersion	The version of the LinkedIn Marketing API to be used.

OAuth

---

プロパティ	説明
Scope	A specific scope that the user requires the access token.

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Logging

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Pagesize	LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

---

プロパティ	説明
APIVersion	The version of the LinkedIn Marketing API to be used.

The version of the LinkedIn Marketing API to be used.

データ型

string

デフォルト値

"202308"

解説

The API version used by default is 202308. To use a different API version set this to the format YYYYMM.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
Scope	A specific scope that the user requires the access token.

A specific scope that the user requires the access token.

データ型

string

デフォルト値

""

解説

This property must be set in the connection string to get a scoped token with specific privileges.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログ ページに記載されています。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Pagesize	LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

データ型

int

デフォルト値

-1

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

LinkedIn Marketing Solutions から返されるページあたりの結果の最大数。

データ型

int

デフォルト値

100

解説

Pagesize プロパティは、LinkedIn Marketing Solutions から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

データ型

string

デフォルト値

""

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

データ型

int

デフォルト値

60

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。