Cloud

Build 25.0.9434
  • Twitter Ads
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • AdAudiencePermissions
        • AdAudiences
      • ビュー
        • AdAccounts
        • AdActiveEntities
        • AdCampaignAudienceReach
        • AdCampaigns
        • AdCards
        • AdFundingInstruments
        • AdFundingInstrumentsAudienceReach
        • AdLineItems
        • AdPromotedTweets
        • AdStats
        • AdTweets
      • ストアドプロシージャ
        • ManageAudienceUsers
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AccountId
        • AdsAPIVersion
        • UseAppOnlyAuthentication
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • AuthToken
        • AuthKey
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • IsPremiumTwitter
        • MaxRateLimitDelay
        • MaxRows
        • PseudoColumns
        • SearchTerms
        • StreamPageSize
        • StreamReadDuration
        • StreamTimeout
        • Timeout
        • UseAsyncAPI
    • Third Party Copyrights

Twitter Ads - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるTwitter Ads へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してTwitter Ads に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Twitter Ads への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Twitter Ads は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

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

Twitter Ads への接続

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

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

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

CData Cloud

接続の確立

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

Twitter Ads への接続

Twitter Ads はOAuth 認証のみサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。カスタムアプリケーションの作成について詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

CData Cloud

データモデル

CData Cloud は、Twitter Ads エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。

Cloud は、Twitter Ads API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

ビュー

ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。

ストアドプロシージャ

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

CData Cloud

テーブル

Cloud はTwitter Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Twitter Ads テーブル

Name Description
AdAudiencePermissions Retrieve details for some or all permissions associated with the specified tailored audience.
AdAudiences Retrieve details for some or all Tailored Audiences associated with the current account.

CData Cloud

AdAudiencePermissions

Retrieve details for some or all permissions associated with the specified tailored audience.

Columns

Name Type ReadOnly Description
Id [KEY] String True

The unique identifier of the ad audience permission.

AudienceId [KEY] String False

The unique identifier of the ad custom audience.

AccountId String False

Id of the advertising account to work with.

GrantedAccountId String False

The unique identifier of the ad account who has been granted this permission.

CreatedAt Datetime True

The time of the creation of this audience permission.

Deleted Boolean True

Whether the audience permission is deleted.

PermissionLevel String False

The level of the audience permission.

UpdatedAt Datetime True

The time of the last change of the properties of this audience permission.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String

Boolean used for including or not the deleted accounts.

デフォルト値はfalseです。

CData Cloud

AdAudiences

Retrieve details for some or all Tailored Audiences associated with the current account.

View Specific Information

Select

Only the Id filter is supported.

SELECT * FROM AdAudiences WHERE Id = 'TXR1'

Insert

This table supports simple Insert and batch Insert operations.

Simple Insert:

INSERT INTO [AdAudiences] (name) VALUES ('test')

Batch Insert:

Batch inserts are used to generate a new audience based on existing audiences and by setting a couple of conditions on them.

For example: To create a new audience based on the most active users of X1 AND (X2 or X3) audience the structure would be like this:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

INSERT INTO [AdAudiences] (audienceType, name, segments) SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Make sure to set the required columns on initial temp tables, for example a#TEMP, which are: CustomAudienceId and LookbackWindow.

Values that are set in these temp table will be used by AdAudiences#TEMP in the Segments column, which will be used as a criteria, combined with AND/OR logical operators.

Update

This table supports simple and batch Update operations.

Simple Update:

UPDATE [AdAudiences] SET Name = 'testModified' WHERE Name = 'test'

Batch Update:

Batch updates are used to modify an existing audience by setting a couple of new conditions on it.

For example: To modify an audience based on the most active users of X1 AND (X2 or X3) audience the structure would be like this:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

UPDATE [AdAudiences] (audienceType, name, segments) SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Delete

This table supports simple and batch Delete operations.

Simple Delete:

DELETE FROM [AdAudiences] WHERE Name = 'test'

Batch Delete:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

DELETE FROM [AdAudiences] WHERE EXISTS SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Columns

Name Type ReadOnly Description
Id [KEY] String True

The unique identifier of the ad tailored audience.

AccountId String False

Id of the advertising account to work with.

OwnerAccountId String True

The unique identifier of the owner account.

Name String False

The name of the tailored audience.

AudienceSize Integer True

The size of the tailored audience.

AudienceType String True

The type of the tailored audience.

CreatedAt Datetime True

The time of the creation of this audience.

UpdatedAt Datetime True

The time of the last change of the properties of this audience.

PartnerSource String True

The partner source of this tailored audience.

PermissionLevel String True

The permission level of this tailored audience.

ReasonsNotTargetable String True

The reasons why this audience is not targetable, if it is not targetable.

TargetableTypes String True

Targetable types of the audience.

Targetable Boolean True

Shows if the audience is targetable or not.

Deleted Boolean True

Whether the audience is deleted.

Segments String True

Useful only in Batch Insert, Update and Delete operations.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String

Boolean used for including or not the deleted accounts.

デフォルト値はfalseです。

CData Cloud

ビュー

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

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

CData Cloud - Twitter Ads ビュー

Name Description
AdAccounts 認証するユーザーがアクセスできるすべての広告アカウントを取得します。
AdActiveEntities Retrieve details about which entities' analytics metrics have changed in a given time period.
AdCampaignAudienceReach Retrieve reach and average frequency analytics for specified campaigns.
AdCampaigns 現在のアカウントに関連付けられている一部またはすべてのキャンペーンの詳細を取得します。
AdCards Retrieve details for some or all cards associated with the current account.
AdFundingInstruments パスで指定されたアカウントに関連付けられている一部もしくはすべてのお支払方法を取得します。
AdFundingInstrumentsAudienceReach Retrieve reach and average frequency analytics for specified funding instruments.
AdLineItems 指定されたアカウントに関連付けられた一部もしくはすべてのfunding instruments を取得します。
AdPromotedTweets 認証するユーザーがアクセスできるすべての広告ツイート。
AdStats 特定のエンティティのすべての利用可能な指標の情報をクエリします。
AdTweets Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

CData Cloud

AdAccounts

認証するユーザーがアクセスできるすべての広告アカウントを取得します。

ビュー固有の情報

Select

このビューでは、使用可能なフィルタはありません。

Columns

Name Type Description
Id [KEY] String アカウントの一意の識別子。
Name String アカウントの名前。
ApprovalStatus String アカウントがプロモーションに適切かどうかを示します。次の値を指定できます:ACCEPTED、UNDER_REVIEW、もしくはREJECTED。
CreatedAt Datetime アカウントが作成された時刻。
UpdatedAt Datetime アカウントのプロパティが最後に編集された時刻。
Timezone String アカウント設定で選択されたタイムゾーン。それぞれのキャンペーンはこのタイムゾーンが適用されます。
TimezoneSwitchAt Datetime 最後にタイムゾーンが変更された時刻。
Deleted Boolean アカウントが削除されたかどうか。
Salt String アカウントを指定するユニークなランダム文字列。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String 削除されたアカウントを含むかどうかのboolean。

デフォルト値はfalseです。

CData Cloud

AdActiveEntities

Retrieve details about which entities' analytics metrics have changed in a given time period.

Columns

Name Type Description
EntityID String The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.
AccountId String Id of the advertising account to work with.
ActivityStartTime Datetime Start time of the activity
ActivityEndTime Datetime The end time of the activity
Placements String

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Entity String The entity type to retrieve data for.
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.
CampaignIds String Scope the response to just entities associated with desired campaigns by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.
FundingInstrumentIds String Scope the response to just entities associated with desired funding instruments by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.

CData Cloud

AdCampaignAudienceReach

Retrieve reach and average frequency analytics for specified campaigns.

Columns

Name Type Description
AccountId String The unique identifier of the ad account.
CampaignIds [KEY] String
TotalAudienceReach String
AverageFrequency String
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.

CData Cloud

AdCampaigns

現在のアカウントに関連付けられている一部またはすべてのキャンペーンの詳細を取得します。

ビュー固有の情報

Select

AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Cloud はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。

Columns

Name Type Description
Id [KEY] String キャンペーンの一意の識別子。特定のキャンペーンを識別するために使用されます。
AccountId String 使用する広告アカウントのId。
Name String キャンペーンの名前。
CreatedAt Datetime キャンペーンが作成された時刻。
UpdatedAt Datetime キャンペーンのプロパティが最後に変更された時刻。
EntityStatus String このエンティティのステータス:ACTIVE、DRAFT、およびPAUSED。
TotalBudget Long キャンペーンにユーザーが設定した総予算。
DailyBudget Long キャンペーンで使用できる1日の上限予算金額。
Currency String デフォルトの通貨。
FundingInstrumentId String キャンペーンの予算源として使用されたお支払方法を識別するID。
StandardDelivery String True の場合、このフィールドは1日を通して均等な割合で予算を消費します。それ以外の場合は、日別予算がなくなるまでできるだけ早くインプレッションを獲得してエンゲージメントを生成します。ターゲティングや競合相手によっては、1日の早いうちに予算がなくなる場合があります。これは、集中配信と呼ばれます。
Deleted Boolean キャンペーンが削除され、配信されなくなったかどうかを示します。
BudgetOptimization String Indicates the type of budget optimization being applied

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String 削除されたアカウントを含めるかどうかのboolean。

デフォルト値はfalseです。

CData Cloud

AdCards

Retrieve details for some or all cards associated with the current account.

Columns

Name Type Description
id [KEY] String The id identifier for a card.
AccountId String Id of the advertising account to work with.
Name String The name for the card. Maximum length: 80 characters.
CreatedAt Datetime The date the card was created.
UpdatedAt Datetime The date the card was last updated.
Deleted Boolean Whether the card is deleted or not
CardType String The type of the card.
ComponentType String The type of the component.
MediaKeys String Media Keys
LabelType String Labels define the text shown on buttons
LabelValue String The value of the label
DestinationType String The destination type, which determines its schema.
DestinationURL String The URL of the website to redirect a user to.
DestinationCountryCode String The ISO 3166-1 alpha-2 two-letter code for the country where the app is sold.
DestinationGooglePlayAppId String The Google Play application package name.
DestinationIOSAppStoreId String The iOS app store identifier.
DestinationGooglePlayDeepLink String A deep link into the Android app you're promoting.
DestinationIOSDeepLink String A deep link into the iOS app you're promoting.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String Boolean used for including or not the deleted accounts.

デフォルト値はfalseです。

CData Cloud

AdFundingInstruments

パスで指定されたアカウントに関連付けられている一部もしくはすべてのお支払方法を取得します。

ビュー固有の情報

Select

AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Cloud はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。

Columns

Name Type Description
Id [KEY] String お支払方法の識別子。
AccountId String 使用する広告アカウントのId。
Type String お支払方法は次のいずれかになります:クレジットカード、クレジットライン、複数ユーザー名のクレジットライン。
Description String お支払方法の拡張情報。
CreatedAt Datetime レコードが作成された時刻。
UpdatedAt Datetime 項目のプロパティに関連付けられた最後の請求時刻。
CreditLimit Long このお支払い方法で利用可能な合計クレジット額。
FundedAmount Long このお支払い方法に割り当てられた合計予算額。
CreditRemaining Long このお支払方法で利用可能なクレジット残高。
Currency String デフォルトの通貨。
StartTime Datetime この方法が利用可能になった時刻。
EndTime Datetime この方法が利用できなくなった時刻。
Cancelled Boolean お支払い方法がキャンセルされたかどうかを示します。
Deleted Boolean 項目が削除され、使用できなくなったかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String 削除されたアカウントを含むかどうかのboolean。

デフォルト値はfalseです。

CData Cloud

AdFundingInstrumentsAudienceReach

Retrieve reach and average frequency analytics for specified funding instruments.

Columns

Name Type Description
AccountId String Id of the advertising account to work with.
FundingInstrumentIds [KEY] String The unique identifier of the ad account.
TotalAudienceReach String
AverageFrequency String
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.

CData Cloud

AdLineItems

指定されたアカウントに関連付けられた一部もしくはすべてのfunding instruments を取得します。

ビュー固有の情報

Select

AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Cloud はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。

Columns

Name Type Description
Id [KEY] String 特定のラインアイテムを指定するユニークなラインアイテムId。
AccountId String レバレッジされたアカウントの識別子。
CampaignId String 扱うキャンペーンのId。
Name String ラインアイテムにアサインされた名前。ブランクの場合は、デフォルトでUntitled となります。
TotalBudget Long ラインアイテムに関連付けられたbid 額を表す数字。指定されたfunding instrument の通貨が使われます。USD の場合、$1.50 は1.50*1e6 もしくは、1,500,000 となります。
BidType String ビッドメカニズム。
AutomaticallySelectBid Boolean [非推奨]このboolean パラメータがtrue の場合、日次の予算とキャンペーンが出る日をベースにビッドが自動的に最適化されます。
ProductType String このラインアイテムが含むプロモーション製品のタイプ。
Placements String このラインアイテムが表示されるプレースメント位置のカンマ区切りのリスト。
Objective String ラインアイテムのキャンペーン目標。
EntityStatus String このエンティティのステータス:ACTIVE、DRAFT、およびPAUSED。
IncludeSentiment String ラインアイテムがポジティブ、もしくはネガティブなセンチメントでターゲットされたかどうか。ツイートのトーンがポジティブの場合、ツイートはポジティブもしくはネガティブのセンチメントを持つといわれます。これは、Product Type がPROMOTED_TWEETS であり、プレースメントがALL_OF_TWITTER、もしくはTWITTER_TIMELINES の場合に有効です。有効な値は次のとおりです:デフォルトのPOSITIVE_ONLY はポジティブなセンチメントのツイートのみをターゲットにし、ALL はネガティブセンチメントを含むすべてのツイートをターゲットにします。
TotalBudgetAmountLocalMicro Long ラインアイテムに割り当てられる予算額を表す数字。指定されたfunding instrument およびキャンペーンの通貨が使われます。USD の場合、$37.50 は37.50*1e6 もしくは、37,500,000 とエンコードされます。
StartTime Datetime ラインアイテムのUTC 時間。現在の時刻よりも後でなければなりません。
EndTime Datetime ラインアイテムが停止されるUTC 時間。指定された場合、現在の時刻よりも後でなければなりません。
PrimaryWebEventTag String プライマリーWeb イベントタグの識別子。ラインアイテムのキャンペーンのエンゲージメントのより正確なトラッキングを可能にします。
ChargeBy String This field is returned for line items using the APP_INSTALLS objective. Defaults to charging by bid unit except for line items with bid unit APP_INSTALLS, where it defaults to charging by app clicks.
AdvertiserDomain String プロトコルスペックなしの広告主のウェブサイトドメイン。このフィールドはTwitter Audience Platform (TAP) を使っているラインアイテムで有効です。
Categories String 広告主のIAB カテゴリ。この設定はTwitter Audience Platform (TAP) を使っているラインアイテムで有効です。
TargetCPALocalMicro Integer ラインアイテムに割り当てられるCPA 額を表すinteger。指定されたfunding instrument およびキャンペーンの通貨が使われます。USD の場合、$5.50 は5.50*1e6 もしくは、5,500,000 となります。
CreatedAt Datetime キャンペーンが作成された時刻。
UpdatedAt Datetime キャンペーンのプロパティが最後に変更された時刻。
Goal String The optimization setting used with this line item.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String 削除されたアカウントを含むかどうかのboolean。

デフォルト値はfalseです。

CData Cloud

AdPromotedTweets

認証するユーザーがアクセスできるすべての広告ツイート。

ビュー固有の情報

Select

AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Cloud はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。

Columns

Name Type Description
Id [KEY] String 指定されたプロモーションに対応する識別子。
TweetId String プロモーションされているステータスアップデートまたはツイートのID。
LineItemId String このツイートが含まれるラインアイテムのId。
AccountId String 使用する広告アカウントのId。
CreatedAt Datetime ツイートがプロモーションされた時刻。
UpdatedAt Datetime ツイートが更新された時刻。
Deleted Boolean アイテムが削除されたかどうかを示すboolean。
EntityStatus String このエンティティのステータス:ACTIVE、DRAFT、およびPAUSED。
ApprovalStatus String プロモーションが届いたかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeDeleted String 削除されたアカウントを含むかどうかのboolean。

デフォルト値はfalseです。

CData Cloud

AdStats

特定のエンティティのすべての利用可能な指標の情報をクエリします。

ビュー固有の情報

AdStats は、すべてのエンティティタイプの分析指標がすべて含まれています。このビューをクエリすると、指定されたエンティティによりサポートされる指標のみが値付きで生成されます。

Twitter Ads 非同期API のサポート

このビューはTwitter Ads 非同期API をサポートします。UseAsyncAPI プロパティをTRUE に設定するとAPI が有効になります。デフォルトはFALSE です。

Select

次のフィールドで結果セットをフィルタンリングできます。

AccountId これはTwitter 分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Cloud はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。
StartTime and EndTime タイムウィンドウを指定するために使われます。この値は7日間を超える設定ができません。ウィンドウが指定されない場合、直近7日の分析が返されます。
SELECT * FROM AdStats WHERE StartTime = '12/02/2016' AND EndTime = '12/09/2016'
Entity および EntityId エンティティタイプは5個あります:
  • ACCOUNT
  • FUNDING_INSTRUMENT
  • CAMPAIGN
  • LINE_ITEM
  • PROMOTED_TWEET
  • ORGANIC_TWEET

それぞれのエンティティはビューを持ち、有効なアイテムのリストやそれぞれのID を取得するために使われます。デフォルトでこれらのフィルタの一つが指定されると、Cloud はAccountId 接続プロパティで指定されたID のアカウントの分析を取得します。

Note:Entity フィールドに"ORGANIC_TWEET" を設定した場合、WHERE 句にEntityId を設定する必要があります。

SELECT * FROM AdStats WHERE EntityId = '807000624822882304' AND Entity = 'ORGANIC_TWEET'

Granularityこの値は、返されるデータポイントの粒度を定義します。有効な値はTOTAL、DAY、およびHOUR です。TOTAL 以外の値に設定する場合、StartTime とEndTime で指定された期間のそれぞれのユニットにブレークダウンされた分析が返されます。例えば、DAY に設定された場合、指定された期間の日次の分析が返されます。デフォルトはDAY です。
SELECT * FROM AdStats WHERE Granularity = 'HOUR'
Placement Twitter、もしくはTwitter Audience Platform のすべてのプレースメントの指標を集計前に戻すために使われます。利用可能な値はALL_ON_TWITTER、およびPUBLISHER_NETWORK です。プレースメントは、1つの値しかとれません。Twitter のプレースメントとTwitter Audience Platform のプレースメントの分析データをフェッチするには別々のクエリが必要です。デフォルトはALL_ON_TWITTER に設定されています。
SELECT * FROM AdStats WHERE Placement = 'PUBLISHER_NETWORK'

フィルタのリストはオプションですが、Entity、EntityId、およびtime window は少なくとも指定することが推奨されます。

SELECT * FROM AdStats WHERE EntityId = '807000624822882304' AND Entity = 'ORGANIC_TWEET' AND StartTime = '12/02/2016' AND EndTime = '12/09/2016' 

Columns

Name Type Description
AccountId String 使用する広告アカウントのId。
Entity String クエリするエンティティ。
EntityId String クエリするエンティティのId。
StartTime Date StartTime とEndTime の間のタイムウィンドウで集められたデータと取得されたデータの範囲。1時間単位での設定となります。
EndTime Date StartTime とEndTime の間のタイムウィンドウで集められたデータと取得されたデータの範囲。1時間単位での設定となります。
IntervalStartTime Datetime 現在のインターバルの開始時間。これはGranularity DAY およびHOUR にのみ適用されます。
IntervalEndTime Datetime 現在のインターバルの終了時間。これはGranularity DAY およびHOUR にのみ適用されます。
Placement String プレースメント。有効な値は次のとおりです:ALL_ON_TWITTER、PUBLISHER_NETWORK。

使用できる値は次のとおりです。ALL_ON_TWITTER, PUBLISHER_NETWORK

Granularity String この値は、StartTime とEndTime で定義されるタイムレンジ内で返されるデータポイントの粒度を定義します。例えば、HOUR に設定すると、StartTime とEndTime の間の1時間ごとのデータポイントが表示されます。

使用できる値は次のとおりです。TOTAL, DAY, HOUR

Engagements Integer エンゲージメントの総数。
Impressions Integer インプレッションの総数。
Retweets Integer リツイートの総数。
Replies Integer リプライの総数。
Likes Integer いいねの総数。
Follows Integer フォローの総数。
CardEngagements Integer エンゲージメントの総数。
Clicks Integer クリックの総数。
AppClicks Integer アプリのインストール数、もしくはアプリを開こうとした回数。
UrlClicks Integer リンクURL のクリック数。
QualifiedImpressions Integer 有効なインプレッションの総数。
BilledEngagements Integer 有償エンゲージメントの総数。
BilledCharge Long ミクロでの総支払。
VideoTotalViews Integer ビデオビューの総数。
VideoViews25 Integer すくなくとも25%のビデオが見られたビューの総数。
VideoViews50 Integer すくなくとも50%のビデオが見られたビューの総数。
VideoViews75 Integer 少なくとも50%のビデオが見られたビューの総数。
VideoViews100 Integer 100%のビデオが見られたビューの総数。
VideoCTAClicks Integer call to action のクリック総数。
VideoContentStarts Integer ビデオのプレーバックスタートの総数。
VideoMrcViews Integer Media Rating Council ガイダンスによるビューの総数。
Video3s100pctViews Integer 100% のビューの内、少なくとも3秒は再生されたビューの総数。
MediaViews Integer ビデオ、vines、GIF、画像に渡るメディアのビュー(プレイバックおよびクリック)の総数。
MediaEngagements Integer ビデオ、vines、GIF、画像に渡るメディアのクリックの総数。
Purchases Integer PURCHASE タイプの会話の数。
SignUps Integer SIGN_UP タイプの会話の数。
SiteVisits Integer SITE_VISIT タイプの会話の数。
Downloads Integer DOWNLOAD タイプの会話の数。
ConversionCustom Integer CUSTOM タイプの会話の数。
MobileConversionSpentCredits Integer SPENT_CREDIT タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionInstalls Integer INSTALL タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionContentViews Integer CONTENT_VIEW タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionAddToWishlists Integer ADD_TO_WISHLIST タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionCheckoutsInitiated Integer CHECKOUT_INITIATED タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionReservations Integer RESERVATION タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionTutorialsCompleted Integer TUTORIAL_COMPLETED タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionAchievementsUnlocked Integer ACHIEVEMENT_UNLOCKED タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionSearches Integer SEARCH タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionAddToCarts Integer ADD_TO_CART タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionPaymentInfoAdditions Integer PAYMENT_INFO_ADDITION タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionReEngages Integer RE_ENGAGE タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionShares Integer SHARE タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionRates Integer RATE タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionLogins Integer LOGIN タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionUpdates Integer UPDATE タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionLevelsAchieved Integer LEVEL_ACHIEVED タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionInvites Integer INVITE タイプのモバイルコンバージョンのポストビュー、ポストエンゲージメント、whether assisted、注文量、および売上ごとのブレイクダウン。
MobileConversionKeyPageViews Integer KEY_VIEW タイプのモバイルコンバージョンのポストビューおよびポストエンゲージメント毎のコンバージョンのブレイクダウン。
LifetimeValuePurchases Integer PURCHASE タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueSignUps Integer SIGN_UP タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueUpdates Integer UPDATE タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueTutorialsCompleted Integer TUTORIAL_COMPLETED タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueReservations Integer RESERVATION タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueAddToCarts Integer ADD_TO_CART タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueAddToWishlists Integer ADD_TO_WISHLIST タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueCheckoutsInitiated Integer CHECKOUT_INITIATED タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueLevelsAchieved Integer LEVEL_ACHIEVED タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueAchievementsUnlocked Integer ACHIEVEMENT_UNLOCKED タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueShares Integer SHARE タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueInvites Integer INVITE タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValuePaymentInfoAdditions Integer PAYMENT_INFO_ADDITION タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueSpentCredits Integer SPENT_CREDIT タイプのモバイルコンバージョンのブレイクダウン。
LifetimeValueRates Integer RATE タイプのモバイルコンバージョンのブレイクダウン。

CData Cloud

AdTweets

Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

ビュー固有の情報

Select

AccountId フィールドはサーバーサイドでフィルタリング可能です。

SELECT * FROM AdTweets WHERE AccountId = '1234'

SELECT * FROM AdTweets WHERE AccountId IN (SELECT Id FROM AdAccounts)

Columns

Name Type Description
ID [KEY] String The Id of the status update or tweet. Set this value when inserting to retweet an existing tweet.
IDLong String The long type Id of the status update or tweet.
SearchTerms String The SearchTerms to search against. This cannot be used with the Screen_Name or User_Id inputs. For more information on using the advanced query operators, see the Twitter API documentation here: https://dev.twitter.com/docs/using-search. Roughly 1500 results can be returned using the SearchTerms.
Created_At Datetime When the tweet was made.
Text String The text of the tweet.
Lang String Language code the tweet was made in.
Source String Source of the tweet.
Favorited Boolean Boolean indicating if this tweet has been favorited.
Favorite_Count Integer The approximate number of times this tweet has been favorited.
Retweeted Boolean Boolean indicating if this tweet has been retweeted.
Retweet_Count Integer The number of times the tweet has been retweeted.
Retweeted_Status_Id String Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.
Truncated Boolean Boolean indicating if this tweet has been truncated.
Filter_Level String Indicates the maximum value of the Filter_Level parameter that can be used and still stream this tweet.
Possibly_Sensitive String This field is available only when a tweet contains a link. The meaning of the field does not pertain to the tweet content itself, but instead it is an indicator that the URL contained in the tweet may contain content or media identified as sensitive content.
Withheld_Copyright Boolean When present and set to true, indicates that this piece of content has been withheld due to a DMCA complaint.
Withheld_Scope String When present, indicates whether the content being withheld is the status or a user.
Withheld_In_Countries String A list of uppercase, two-letter country codes this content is withheld from.
Contributors String An XML collection of user objects (usually only one) indicating users who contributed to the authorship of the tweet, on behalf of the official tweet author.
Coordinates_Coordinates String The geographic coordinates of this tweet (longitude first, then latitude).
Coordinates_Type String The type of coordinate, if applicable.
Place_Full_Name String The full name of the location of this tweet (city and state).
Place_Country String The country of origin of this tweet.
Current_User_Retweet_Id String Details the tweet Id of the authenticated user's own retweet (if it exists) of this tweet.
Scopes String A set of key-value pairs indicating the intended contextual delivery of the containing tweet. Currently used by Twitter's promoted products.
In_Reply_To_Status_Id String Represents the Id of the original status if this tweet is in reply to another.
From_User_Id String Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Screen_Name String Screen name of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Name String Name of the user who made the tweet.
From_User_Location String Location of the user who made the tweet.
From_User_Profile_URL String URL to the user who made the tweet. This is not returned when a SearchTerms is specified.
From_User_Profile_Image_Url String URL to the profile image for the from user.
To_User_Id String Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
To_User_Screen_Name String Screen name of the user who made the tweet.
User_Mentions String Mentions of other users in the tweet, returned as an XML aggregate.
URLs String URLs in the tweet, returned as an XML aggregate.
Hashtags String Hashtags in the tweet, returned as an XML aggregate.
Media String Media in the tweet, returned as an XML aggregate.
Name String The name of the Tweet, also known as the Ad name in the Twitter Ads UI. This field might be returned as null if no input name is provided when creating tweets using the Tweet composer. The name that is displayed in the UI for these cases is the Card name.
AccountId String The Id of the advertising account this AdTweet is associated with.
Card_Uri String The identifier for a Twitter Card attached to this Tweet.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
TimelineType String Whether to return nullcasted (a.k.a. 'Promoted-only') Tweets, organic Tweets, or both. Possible values: ALL, NULLCAST, ORGANIC
TweetType String The Tweet type of the tweets. Possible values: DRAFT, PUBLISHED, SCHEDULED

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - Twitter Ads ストアドプロシージャ

Name Description
ManageAudienceUsers 特定のカスタムオーディエンスId からユーザーを追加、変更、削除します。

CData Cloud

ManageAudienceUsers

特定のカスタムオーディエンスId からユーザーを追加、変更、削除します。

Input

Name Type Description
AudienceId String Twitter 広告のカスタムオーディエンスの一意の識別子。
OperationType String 実行中のユーザーグループごとの操作タイプ。

使用できる値は次のとおりです。Update, Delete

UserEmail String ユーザーのE メールアドレス。
UserDeviceID String ユーザーのdeviceId:IDFA/AdID/Android ID。
UserHandle String ユーザーに属する@handle(s)。
UserTwitterID String ユーザーのTwitter Id。
PartnerId String パートナーのユーザーId。
EffectiveAt String カスタムオーディエンスアソシエーションが有効になるUTC 時間。
ExpiresAt String カスタムオーディエンスアソシエーションが期限切れになるUTC 時間。
CSVFilePath String バッチデータを含むCSV ファイルの場所。

Result Set Columns

Name Type Description
AccountId String 場所Id。
AudienceId String 場所名。
Success String プロシージャが正常に実行された場合はtrue を返します。
UsersAffected String 変更 / 削除されたユーザーの数。
ErrorMessage String リクエストが成功しなかった場合にAPI からスローされるエラー。それ以外の場合はnull を返します。

CData Cloud

システムテーブル

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

スキーマテーブル

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

  • 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:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns

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

CData Cloud

sys_schemas

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

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

          SELECT * FROM sys_schemas
          

Columns

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

CData Cloud

sys_tables

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

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

          SELECT * FROM sys_tables
          

Columns

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

CData Cloud

sys_tablecolumns

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

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

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

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 から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

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

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

          SELECT * FROM sys_procedures
          

Columns

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

CData Cloud

sys_procedureparameters

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

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

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAuthorizationUrl' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのTwitter Ads プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

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

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

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

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 主キーのカラム名。

CData Cloud

sys_foreignkeys

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

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

         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 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

CData Cloud

sys_indexes

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

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

          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 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

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

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

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 プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

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

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

データソースのSELECT 機能

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

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。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_BYGROUP 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_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加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_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。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 構文の詳細。

CData Cloud

sys_identity

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

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

         SELECT * FROM sys_identity
          

Columns

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

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AccountId広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。
AdsAPIVersionTwitter API の現在のバージョン。
UseAppOnlyAuthenticationApp-Only 認証を使用するかどうかを示すboolean。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication key used to request and obtain the OAuth Access Token.

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
IsPremiumTwitterTwitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。
MaxRateLimitDelayレートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SearchTerms何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。
StreamPageSize返されるページごとのTwitter ストリームから取得されたデータの結果数。
StreamReadDurationThis property represents the maximum time to read streaming data, in seconds.
StreamTimeoutストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseAsyncAPIThis field sets whether the Twitter Ads Asynchronous API is enabled.
CData Cloud

Authentication

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


プロパティ説明
AccountId広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。
AdsAPIVersionTwitter API の現在のバージョン。
UseAppOnlyAuthenticationApp-Only 認証を使用するかどうかを示すboolean。
CData Cloud

AccountId

広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。

データ型

string

デフォルト値

""

解説

広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。

CData Cloud

AdsAPIVersion

Twitter API の現在のバージョン。

データ型

string

デフォルト値

"11"

解説

Twitter API の現在のバージョン。

CData Cloud

UseAppOnlyAuthentication

App-Only 認証を使用するかどうかを示すboolean。

データ型

bool

デフォルト値

false

解説

ユーザーの代わりに、Twitter アプリをTwitter にログインさせるには、これをtrue に設定します。

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication key used to request and obtain the OAuth Access Token.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

AuthToken

The authentication token used to request and obtain the OAuth Access Token.

データ型

string

デフォルト値

""

解説

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

CData Cloud

AuthKey

The authentication key used to request and obtain the OAuth Access Token.

データ型

string

デフォルト値

""

解説

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

CData Cloud

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

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

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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

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


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

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


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

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


プロパティ説明
IsPremiumTwitterTwitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。
MaxRateLimitDelayレートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SearchTerms何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。
StreamPageSize返されるページごとのTwitter ストリームから取得されたデータの結果数。
StreamReadDurationThis property represents the maximum time to read streaming data, in seconds.
StreamTimeoutストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseAsyncAPIThis field sets whether the Twitter Ads Asynchronous API is enabled.
CData Cloud

IsPremiumTwitter

Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。

データ型

bool

デフォルト値

false

解説

Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。

CData Cloud

MaxRateLimitDelay

レートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。

データ型

string

デフォルト値

"60"

解説

Twitter は、異なるエンドポイントに対してレートリミットリクエスト数が異なります。レートリミットには、15分で15リクエストから15分に900リクエストまで幅があります。 内部では、CData Cloud が、与えられたリクエストがレートリミットに当たるかどうかをチェックしています。レートリミットにヒットする場合には、CData Cloud は内部でリミットが当たらない時間までリクエスト送信を遅らせることができます。 ただし、これにより、データのリクエストに数分を待たなければいけない結果となる可能性があり、よい挙動とはいえません。

MaxRateLimitDelay では、CData Cloud がレートリミットが発生することを探知した場合に最大何秒リクエスト送信を遅らせるかをコントロールできます。CData Cloud が待たなければいけない時間が計算できるため、MaxRateLimitDelay で設定した以上の時間を待っている場合には、エラーであると判断できます。

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

SearchTerms

何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。

データ型

string

デフォルト値

""

解説

何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。

CData Cloud

StreamPageSize

返されるページごとのTwitter ストリームから取得されたデータの結果数。

データ型

string

デフォルト値

"50"

解説

返されるページごとのTwitter ストリームから取得されたデータの結果数。

CData Cloud

StreamReadDuration

This property represents the maximum time to read streaming data, in seconds.

データ型

int

デフォルト値

0

解説

Set StreamReadDuration property to consume streaming data for a specific time period. When StreamReadDuration is reached and StreamTimeout is 0, then the connection will be closed.

CData Cloud

StreamTimeout

ストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。

データ型

string

デフォルト値

"0"

解説

StreamTimeout の値を0 に設定すると、続けて接続を開いていられるようになります。このプロパティの値がゼロよりも大きい場合、StreamPageSize プロパティの値はオーバーライドされ、1に設定されます。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseAsyncAPI

This field sets whether the Twitter Ads Asynchronous API is enabled.

データ型

bool

デフォルト値

false

解説

AdStats is the only table impacted.

Note that when you use the Async API, the Twitter Ads driver polls for a response. How long it waits before timing out is governed by the Timeout connection property. The default is timeout value is 60 seconds, so if you receive a timeout error, increase the value.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434