CData Sync App は、eBay Analytics データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
eBay Analytics コネクタはCData Sync アプリケーションから使用可能で、eBay Analytics からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、eBay Analytics への接続を作成します。eBay Analytics アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからeBay Analytics コネクタをダウンロードおよびインストールします。
必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。
OAuth 2.0認証方法でのみeBay Analytics へ認証することができます。eBay Analytics API では、リクエストの認可に、認証コード付与フローで作成されたアクセストークンが必要です。
OAuth 2.0プロトコルを使用した認証方法について、詳しい手順はOAuth 認証の使用 を参考にしてください。
このセクションでは、eBay Analytics Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、eBay Analytics にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI リソースを示し、eBay Analytics API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、CustomerServiceMetricByCategory、CustomerServiceMetricByShippingRegion、SellerStandardsProfile、TrafficReportByDay、およびTrafficReportByListing を静的にモデル化するように定義されています。
ストアドプロシージャ は、eBay Analytics のファンクションライクなインターフェースです。ストアドプロシージャを使用するとeBay Analytics の操作を実行できます。eBay Analytics では認証に関連するストアドプロシージャのみをサポートしています。
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| Name | Description |
| CustomerServiceMetricByCategory | Returns a seller's performance and rating for the customer service metric by the primary proudct categories. |
| CustomerServiceMetricByShippingRegion | Returns a seller's performance and rating for the customer service metric by the established shipping corridors. |
| SellerStandardsProfile | Returns the standards profiles for the associated seller. |
| TrafficReportByDay | Returns a report that details the user traffic received by a seller's listings per day. |
| TrafficReportByListing | Returns a report that details the user traffic received by a seller's listings per listing. |
Returns a seller's performance and rating for the customer service metric by the primary proudct categories.
The Sync App will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
To query the CustomerServiceMetricByCategory view, a value for the EvaluationType and MarketplaceId columns should be specified.
The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByCategory data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId connection property.
SELECT * FROM CustomerServiceMetricByCategory
The example query below will return CustomerServiceMetricByCategory data for the PROJECTED Evaluation Type period and for the US Marketplace.
SELECT * FROM CustomerServiceMetricByCategory WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_US'
Note: Querying this view will return results only if the below conditions are met.
| Name | Type | Description |
| CategoryId | String | The primary category ID in which the items being rated were listed. |
| CategoryName | String | The primary category name in which the items being rated were listed. |
| TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
| Count | Integer | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. |
| DistributionsBasis | String | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. |
| DistributionsData | String | Expands the Count column data via an aggregated list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria. |
| Rate | Double | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. |
| BenchmarkBasis | String | The basis by which the benchmark is calculated for the MetricType. |
| BenchmarkRating | String | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. |
| BenchmarkAverage | Double | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. |
| BenchmarkAdjustment | String | The reason why the rating given to the seller was adjusted. |
| EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
| EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
| StartDate | Datetime | The start date and time of the transaction lookback range. |
| EndDate | Datetime | End date and time of the transaction lookback range. |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
| MetricType | String | The type of customer service metric. |
Returns a seller's performance and rating for the customer service metric by the established shipping corridors.
The Sync App will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
To query the CustomerServiceMetricByShippingRegion view, a value for the EvaluationType and MarketplaceId columns should be specified.
The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByShippingRegion data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId connection property.
SELECT * FROM CustomerServiceMetricByShippingRegion
The example query below will return CustomerServiceMetricByShippingRegion data for the PROJECTED Evaluation Type period and for the German Marketplace.
SELECT * FROM CustomerServiceMetricByShippingRegion WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_DE'
Note: Querying this view will return results only if the below conditions are met.
| Name | Type | Description |
| ShippingRegionId | String | The Id of the established shipping corridor. |
| ShippingRegionName | String | The Name of the established shipping corridor. |
| TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
| Count | Integer | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. |
| DistributionsBasis | String | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. |
| DistributionsData | String | Expands the Count column data via an aggregated list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria. |
| Rate | Double | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. |
| BenchmarkBasis | String | The basis by which the benchmark is calculated for the MetricType. |
| BenchmarkRating | String | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. |
| BenchmarkAverage | Double | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. |
| BenchmarkAdjustment | String | The reason why the rating given to the seller was adjusted. |
| EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
| EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
| StartDate | Datetime | The start date and time of the transaction lookback range. |
| EndDate | Datetime | End date and time of the transaction lookback range. |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
| MetricType | String | The type of customer service metric. |
Returns the standards profiles for the associated seller.
The Sync App will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The Program and Cycle columns support server side filtering only when specified at the same time and only for the = operator.
For example, the query below is processed server side and it returns the SellerStandardsProfile report data for the Current cycle based on the US Program standards.
SELECT * FROM SellerStandardsProfile WHERE Cycle = 'CURRENT' AND Program = 'PROGRAM_US'
The other example query below, will return the SellerStandardsProfile for every available program standards region and for both cycles, Current and PROJECTED.
SELECT * FROM SellerStandardsProfile
| Name | Type | Description |
| Program | String | The program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL. |
| DefaultProgram | Boolean | Boolean indicating if this is the default program for the seller. |
| StandardsLevel | String | The overall standards level of the seller, one of TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD. |
| EvaluationReason | String | Specifies how the overall seller level was calculated. |
| Cycle | String | The cycle type, either CURRENT or PROJECTED. CURRENT means the profile's metrics values are from the most recent official eBay monthly standards evaluation. PROJECTED means the profile values were determined when the profile was requested. |
| EvaluationDate | Datetime | The date and time at which the standard compliance values were determined for the profile. |
| EvaluationMonth | String | The month in which the currently effective seller level was computed. The value is always formatted as YYYY-MM. If the cycle is CURRENT, this value is the month and year the of the last eBay compliance evaluation. If this is for a PROJECTED cycle, the value is the month and year of the next scheduled evaluation. |
| MinimumDaysOnSite | Integer | Minimum days on site. |
| Transactions | Integer | The total Transactions count. |
| SalesAmount | Decimal | The total Sales amount. |
| TransactionDefectRate | Decimal | Transaction defect rate. |
| CasesClosedWithoutSellerResolution | Decimal | Total cases closed without seller resolution. |
| LateShipmentRate | Decimal | Late shipment rate. |
| TrackingUploadedOnTimeAndValidated | Decimal | Tracking uploaded on time and validated. |
| BusinessSeller | Boolean | Business seller critera met. |
| PowerSeller | Boolean | Power seller criteria met. |
| MinimumDaysOnSiteLevel | String | The seller level for the MinimumDaysOnSite metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| TransactionsLevel | String | The seller level for the Transactions metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| SalesAmountLevel | String | The seller level for the SalesAmount metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| TransactionDefectRateLevel | String | The seller level for the TransactionDefectRate metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| CasesClosedWithoutSellerResolutionLevel | String | The seller level for the CasesClosedWithoutSellerResolution metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| LateShipmentRateLevel | String | The seller level for the LateShipmentRate metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| TrackingUploadedOnTimeAndValidatedLevel | String | The seller level for the TrackingUploadedOnTimeAndValidated metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| BusinessSellerLevel | String | The seller level for the BusinessSeller metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| PowerSellerLevel | String | The seller level for the PowerSeller metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
| MinimumDaysOnSiteThresholdLowerBound | Integer | Specifies the lowest number value for the MinimumDaysOnSite metric can be and still qualify for the currently assigned seller level. |
| TransactionsThresholdLowerBound | Integer | Specifies the lowest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
| SalesAmountThresholdLowerBound | Decimal | Specifies the lowest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
| TrackingUploadedOnTimeAndValidatedThresholdLowerBound | Decimal | Specifies the lowest number value for the TrackingUploadedOnTimeAndValidated metric can be and still qualify for the currently assigned seller level. |
| BusinessSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
| PowerSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
| TransactionsThresholdUpperBound | Integer | Specifies the highest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
| SalesAmountThresholdUpperBound | Decimal | Specifies the highest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
| TransactionDefectRateThresholdUpperBound | Decimal | Specifies the highest number value for the TransactionDefectRate metric can be and still qualify for the currently assigned seller level. |
| CasesClosedWithoutSellerResolutionThresholdUpperBound | Decimal | Specifies the highest number value for the CasesClosedWithoutSellerResolution metric can be and still qualify for the currently assigned seller level. |
| LateShipmentRateThresholdUpperBound | Decimal | Specifies the highest number value for the LateShipmentRate metric can be and still qualify for the currently assigned seller level. |
| BusinessSellerThresholdUpperBound | Boolean | Specifies the highest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
| PowerSellerThresholdUpperBound | Boolean | Specifies the highest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
| MinimumDaysOnSiteThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the MinimumDaysOnSite metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| TransactionsThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the Transactions metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| SalesAmountThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the SalesAmount metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| TransactionDefectRateThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TransactionDefectRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| CasesClosedWithoutSellerResolutionThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the CasesClosedWithoutSellerResolution metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| LateShipmentRateThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the LateShipmentRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| TrackingUploadedOnTimeAndValidatedThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TrackingUploadedOnTimeAndValidated metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
| TransactionsLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the Transactions metric. |
| SalesAmountLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the SalesAmount metric. |
| TransactionDefectRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TransactionDefectRate metric. |
| CasesClosedWithoutSellerResolutionLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
| LateShipmentRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the LateShipmentRate metric. |
| TrackingUploadedOnTimeAndValidatedLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
| TransactionsLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the Transactions metric. |
| SalesAmountLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the SalesAmount metric. |
| TransactionDefectRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TransactionDefectRate metric. |
| CasesClosedWithoutSellerResolutionLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
| LateShipmentRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the LateShipmentRate metric. |
| TrackingUploadedOnTimeAndValidatedLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
| SalesAmountCurrency | String | The sales amount currency. |
Returns a report that details the user traffic received by a seller's listings per day.
The Sync App will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
To query the TrafficReportByDay view, a value for the MarketplaceId and the report date range via the columns ReportStartDate and ReportEndDate should be specified.
The MarketplaceId is server side filterable and supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
The ListingId is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByDay data for the Marketplace specified in the MarketplaceId connection property and for the last 90 days.
SELECT * FROM TrafficReportByDay
The other example query below, will return TrafficReportByDay data for the specified listings in the US Marketplace within the defined date range.
SELECT * FROM TrafficReportByDay WHERE ListingId IN ('182227914336', '182283742135', '311698881010') AND MarketplaceId = 'EBAY_US' AND ReportStartDate='2019-07-12' AND ReportEndDate = '2019-09-13'
| Name | Type | Description |
| Day | Date | The Day (individual date) by which the metrics are grouped. |
| ClickThroughRate | Double | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. |
| ListingImpressionSearchResultsPage | Integer | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. |
| ListingImpressionStore | Integer | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. |
| ListingImpressionTotal | Integer | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. |
| ListingViewsSourceDirect | Integer | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. |
| ListingViewsSourceOffEbay | Integer | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. |
| ListingViewsSourceOtherEbay | Integer | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. |
| ListingViewsSourceSearchResultsPage | Integer | The number of times the item displayed on the search results page. |
| ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
| ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
| SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
| TransactionsCount | Integer | The total number of completed transactions. |
| UsageStartDate | Datetime | The start date of the actual date range of the report data. |
| UsageEndDate | Datetime | The end date of the actual date range of the report data. |
| LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
| ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
| ReportEndDate | Date | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
| ListingId | String | The Id of the Listing by which the metrics are grouped. You can get your ListingId-s from the TrafficReportByListing view. |
Returns a report that details the user traffic received by a seller's listings per listing.
The Sync App will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
To query the TrafficReportByListing view, at least the report date range via the columns ReportStartDate and ReportEndDate should be specified.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
The MarketplaceId input supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
The ListingId column is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByListing data for every available Marketplace, including every Listing the last 90 days.
SELECT * FROM TrafficReportByListing
The other example query below, will return TrafficReportByListing data for the specified listings in the GB Marketplace within the defined date range.
SELECT * FROM TrafficReportByListing WHERE ReportStartDate = '2019-06-20' AND ReportEndDate = '2019-09-15' AND ListingId IN ('201294636968', '201450979387', '201461563488') AND MarketplaceId = 'EBAY_GB'
| Name | Type | Description |
| ListingId | String | The Id of the Listing by which the metrics are grouped. |
| ListingName | String | The Listing Name. |
| ClickThroughRate | Double | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. |
| ListingImpressionSearchResultsPage | Integer | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. |
| ListingImpressionStore | Integer | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. |
| ListingImpressionTotal | Integer | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. |
| ListingViewsSourceDirect | Integer | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. |
| ListingViewsSourceOffEbay | Integer | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. |
| ListingViewsSourceOtherEbay | Integer | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. |
| ListingViewsSourceSearchResultsPage | Integer | The number of times the item displayed on the search results page. |
| ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
| ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
| SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
| TransactionsCount | Integer | The total number of completed transactions. |
| UsageStartDate | Datetime | The start date of the actual date range of the report data. |
| UsageEndDate | Datetime | The end date of the actual date range of the report data. |
| LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
| ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
| ReportEndDate | Date | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
| プロパティ | 説明 |
| RuName | The Redirect URL name used for validation. |
| UseSandbox | A boolean indicating if you are using a sandbox account. |
| MarketplaceId | The identification number for the eBay Marketplace. |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthGrantType | OAuth フローのグラント種別。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
The scheme used for authentication. Accepted entries are OAuth and OAuthClient.
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| RuName | The Redirect URL name used for validation. |
| UseSandbox | A boolean indicating if you are using a sandbox account. |
| MarketplaceId | The identification number for the eBay Marketplace. |
The Redirect URL name used for validation.
It is not necessary when refreshing the Access Token. This property is only needed when performing the Code grant type OAuth flow to get an Access Token. You can obtain this by clicking "User Tokens" from your developer account, clicking "Get a Token from eBay via Your Application", and then clicking "Add eBay Redirect URL".
A boolean indicating if you are using a sandbox account.
A boolean indicating if you are using a sandbox account.
The identification number for the eBay Marketplace.
By default, it has no value assigned to it, this means that to query the reports: CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, TrafficReportByDay and TrafficReportByListing, you must specify the MarketplaceId/s in the query criteria.
You should note that each report is supported in distinct marketplaces, as outlined in the below.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthGrantType | OAuth フローのグラント種別。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
OAuth フローのグラント種別。
次のオプションが利用可能です：CODE,CLIENT
このセクションでは、本プロバイダーの接続文字列で設定可能な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 はeBay Analytics への接続を開き、プロキシを経由して通信が行われます。 |
| 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 | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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\\EbayAnalytics Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"