CData Sync App は、Twitter Ads データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Twitter Ads コネクタはCData Sync アプリケーションから使用可能で、Twitter Ads からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はTwitter Ads REST API バージョン7 の動作をビューとしてモデル化します。Twitter Ads API への接続には、開発者アカウントが必要です。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
接続するには、以下の変数を設定します。
Twitter Ads への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
ドライバーは、以下のようにOAuth プロセスを完了します。
このセクションでは、Twitter Ads Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Twitter Ads にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Twitter Ads エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Sync App はTwitter Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
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. |
Retrieve details for some or all permissions associated with the specified tailored audience.
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String |
Boolean used for including or not the deleted accounts. デフォルト値はfalseです。 |
Retrieve details for some or all Tailored Audiences associated with the current account.
Only the Id filter is supported.
SELECT * FROM AdAudiences WHERE Id = 'TXR1'
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.
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]
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]
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String |
Boolean used for including or not the deleted accounts. デフォルト値はfalseです。 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
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. |
認証するユーザーがアクセスできるすべての広告アカウントを取得します。
このビューでは、使用可能なフィルタはありません。
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 | アカウントを指定するユニークなランダム文字列。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | 削除されたアカウントを含むかどうかのboolean。
デフォルト値はfalseです。 |
Retrieve details about which entities' analytics metrics have changed in a given time period.
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 |
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. |
Retrieve reach and average frequency analytics for specified campaigns.
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. |
現在のアカウントに関連付けられている一部またはすべてのキャンペーンの詳細を取得します。
AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Sync App はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | 削除されたアカウントを含めるかどうかのboolean。
デフォルト値はfalseです。 |
Retrieve details for some or all cards associated with the current account.
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | Boolean used for including or not the deleted accounts.
デフォルト値はfalseです。 |
パスで指定されたアカウントに関連付けられている一部もしくはすべてのお支払方法を取得します。
AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Sync App はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。
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 | 項目が削除され、使用できなくなったかどうかを示します。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | 削除されたアカウントを含むかどうかのboolean。
デフォルト値はfalseです。 |
Retrieve reach and average frequency analytics for specified funding instruments.
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. |
指定されたアカウントに関連付けられた一部もしくはすべてのfunding instruments を取得します。
AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Sync App はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | 削除されたアカウントを含むかどうかのboolean。
デフォルト値はfalseです。 |
認証するユーザーがアクセスできるすべての広告ツイート。
AccountId フィルタがサポートされています。これは分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Sync App はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。
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 | プロモーションが届いたかどうかを示します。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
IncludeDeleted | String | 削除されたアカウントを含むかどうかのboolean。
デフォルト値はfalseです。 |
特定のエンティティのすべての利用可能な指標の情報をクエリします。
AdStats は、すべてのエンティティタイプの分析指標がすべて含まれています。このビューをクエリすると、指定されたエンティティによりサポートされる指標のみが値付きで生成されます。
次のフィールドで結果セットをフィルタンリングできます。
AccountId | これはTwitter 分析に関連するすべてのビューで一般的に必要とされるフィルタです。指定された場合、AccountId 接続プロパティの値をオーバーライドします。値が指定されない場合には、Sync App はAdAccount ビューから返されたリストの初めのアカウントを取得しに行きます。 |
StartTime and EndTime | タイムウィンドウを指定するために使われます。この値は7日間を超える設定ができません。ウィンドウが指定されない場合、直近7日の分析が返されます。
SELECT * FROM AdStats WHERE StartTime = '12/02/2016' AND EndTime = '12/09/2016' |
Entity および EntityId | エンティティタイプは5個あります:
それぞれのエンティティはビューを持ち、有効なアイテムのリストやそれぞれのID を取得するために使われます。デフォルトでこれらのフィルタの一つが指定されると、Sync App は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'
Name | Type | Description |
AccountId | String | 使用する広告アカウントのId。 |
Entity | String | クエリするエンティティ。 |
EntityId | String | クエリするエンティティのId。 |
StartTime | Date | StartTime とEndTime の間のタイムウィンドウで集められたデータと取得されたデータの範囲。1時間単位での設定となります。 |
EndTime | Date | StartTime とEndTime の間のタイムウィンドウで集められたデータと取得されたデータの範囲。1時間単位での設定となります。 |
IntervalStartTime | String | 現在のインターバルの開始時間。これはGranularity DAY およびHOUR にのみ適用されます。 |
IntervalEndTime | String | 現在のインターバルの終了時間。これは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 タイプのモバイルコンバージョンのブレイクダウン。 |
Retrieve all of the advertising-enabled Tweets the authenticating user has access to.
AccountId フィールドはサーバーサイドでフィルタリング可能です。
SELECT * FROM AdTweets WHERE AccountId = '1234'
SELECT * FROM AdTweets WHERE AccountId IN (SELECT Id FROM AdAccounts)
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. |
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 |
プロパティ | 説明 |
AccountId | 広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。 |
AdsAPIVersion | Twitter API の現在のバージョン。 |
UseAppOnlyAuthentication | App-Only 認証を使用するかどうかを示すboolean。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication key used to request and obtain the OAuth Access Token. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
IsPremiumTwitter | Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。 |
MaxRateLimitDelay | レートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SearchTerms | 何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。 |
StreamPageSize | 返されるページごとのTwitter ストリームから取得されたデータの結果数。 |
StreamReadDuration | This property represents the maximum time to read streaming data, in seconds. |
StreamTimeout | ストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseAsyncAPI | This field sets whether the Twitter Ads Asynchronous API is enabled. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AccountId | 広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。 |
AdsAPIVersion | Twitter API の現在のバージョン。 |
UseAppOnlyAuthentication | App-Only 認証を使用するかどうかを示すboolean。 |
広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。
広告アカウントの識別子。このID は、指定されるアカウントの分析情報を取得するために使われます。AddAccounts ビューを使ってID のあるアカウントのリストを取得することができます。
Twitter API の現在のバージョン。
Twitter API の現在のバージョン。
App-Only 認証を使用するかどうかを示すboolean。
ユーザーの代わりに、Twitter アプリをTwitter にログインさせるには、これをtrue に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication key used to request and obtain the OAuth Access Token. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
The authentication token used to request and obtain the OAuth Access Token.
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.
The authentication key used to request and obtain the OAuth Access Token.
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.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はTwitter Ads への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\TwitterAds Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IsPremiumTwitter | Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。 |
MaxRateLimitDelay | レートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SearchTerms | 何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。 |
StreamPageSize | 返されるページごとのTwitter ストリームから取得されたデータの結果数。 |
StreamReadDuration | This property represents the maximum time to read streaming data, in seconds. |
StreamTimeout | ストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseAsyncAPI | This field sets whether the Twitter Ads Asynchronous API is enabled. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。
Twitter プレミアムアカウントかどうかを指定します。デフォルトはfalse です。
レートリミットの場合に、リクエストを送信する前にディレイする時間(秒単位)の最大値。
Twitter は、異なるエンドポイントに対してレートリミットリクエスト数が異なります。レートリミットには、15分で15リクエストから15分に900リクエストまで幅があります。 内部では、CData Sync App が、与えられたリクエストがレートリミットに当たるかどうかをチェックしています。レートリミットにヒットする場合には、CData Sync App は内部でリミットが当たらない時間までリクエスト送信を遅らせることができます。 ただし、これにより、データのリクエストに数分を待たなければいけない結果となる可能性があり、よい挙動とはいえません。
MaxRateLimitDelay では、CData Sync App がレートリミットが発生することを探知した場合に最大何秒リクエスト送信を遅らせるかをコントロールできます。CData Sync App が待たなければいけない時間が計算できるため、MaxRateLimitDelay で設定した以上の時間を待っている場合には、エラーであると判断できます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。
何も指定されなかった場合のデフォルトのSearchTerms。SearchTerms を指定できるTweets などの一部のテーブルで使用されます。
返されるページごとのTwitter ストリームから取得されたデータの結果数。
返されるページごとのTwitter ストリームから取得されたデータの結果数。
This property represents the maximum time to read streaming data, in seconds.
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.
ストリーミング中に結果を待つ最長秒数。この値に達して、ツイートが返ってこない場合には、接続は閉じられます。
StreamTimeout の値を0 に設定すると、続けて接続を開いていられるようになります。このプロパティの値がゼロよりも大きい場合、StreamPageSize プロパティの値はオーバーライドされ、1に設定されます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
This field sets whether the Twitter Ads Asynchronous API is enabled.
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.
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM AdAudiences WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。