eBay Analytics Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.9039 of the connector.

Get Started

eBay Analytics Version Support

The connector leverages the EbayAnalytics API to enable bidirectional access to EbayAnalytics.

Establish a Connection

Connect to eBay Analytics

You can establish a connection and authenticate to the eBay Analytics only via the OAuth 2 authentication method. The eBay Analytics API requires an access token created with the authorization code grant flow to authorize the requests.

Authenticate to eBay Analytics

eBay Analytics supports OAuth authentication only. AuthScheme must be set to OAuth in all OAuth flows.

Desktop Applications

You must create a custom OAuth application to authenticate via a desktop application. See Creating a Custom OAuth App for more information.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: Set this to the App Id(client Id) assigned when you registered your application.
• OAuthClientSecret: Set this to the Cert ID (client secret) assigned when you registered your application.
• RuName: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.
• CallbackURL (Optional): Set this to a local Redirect URL (ex. http://localhost:33333) in case your OAuth application's auth accepted URL is set to https://oauth.cdata.com/oauth/ or to the actual one in case you are using another redirect URL.
• (Optional) UseSandbox: Set this to True if you are connecting to the Sandbox environment

When you connect, the connector opens eBay Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.

Create a Custom OAuth App

eBay Analytics supports the OAuth 2.0 Authentication method. To perform this authentication, you need to first join the eBay Developers Program.

Register an OAuth Application and get your OAuth credentials

You can follow the procedure below to obtain the OAuth client credentials, the OAuthClientId, OAuthClientSecret and the RuName.

1. In the developers program Home, select the Application access keys option from the dropdown list of the "Hi YourAccountName" menu bar button.

2. On the Application Keys page. create an OAuth application and request a pair of OAuth credentials for either your Production environment or for your Sandbox one.

3. After generating and saving your App ID (Client ID) and your Cert ID (Client Secret), click User Tokens next to your App ID (Client ID) of the keyset you want to use.

   • Use production keys if you are getting analytics data from your real eBay store.
   • Use sandbox keys if you are looking to get analytics data from the eBay testing environment.

4. Click Get a Token from eBay via Your Application and in the expanded section make sure that you select OAuth enabled and set Your auth accepted URL to your preferred Callback URL. Here you should also retrieve and save the RuName (redirect_uri).

   Note that eBay Analytics requires a secure Redirect URI (https). For Desktop applications you can set this to https://oauth.cdata.com/oauth/ and optionally, the CallbackURL connection property to a local Redirect URL (for example, http://localhost:33333).

After following these steps, save the OAuthClientId, OAuthClientSecret and RuName with the configured CallbackURL.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the eBay Analytics connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to eBay Analytics and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The eBay Analytics connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

Overview

This section shows the available API resources and provides more information on executing SQL to eBay Analytics APIs.

Key Features

• The connector models eBay Analytics reports as relational views, allowing you to write SQL to query eBay Analytics data.
• Stored procedures allow you to execute operations to eBay Analytics.
• Live connectivity to these objects means any changes to your eBay Analytics account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, SellerStandardsProfile, TrafficReportByDay and TrafficReportByListing.

Stored Procedures

Stored Procedures are function-like interfaces to eBay Analytics. Stored procedures allow you to execute operations to eBay Analytics. The eBay Analytics supports only stored procedures related to authentication.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

eBay Analytics Connector Views

CustomerServiceMetricByCategory

Returns a seller's performance and rating for the customer service metric by the primary proudct categories.

Select

The connector 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 connector.

To query the CustomerServiceMetricByCategory view, a value for the EvaluationType and MarketplaceId columns should be specified.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.

  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'

• The seller has a valid transaction on the specified marketplace (MarketplaceId) during the past 12 months.
• If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (MarketplaceId) for a complete benchmarking period (eBay evaluation period, usually one month).

Columns

CustomerServiceMetricByShippingRegion

Returns a seller's performance and rating for the customer service metric by the established shipping corridors.

Select

The connector 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 connector.

To query the CustomerServiceMetricByShippingRegion view, a value for the EvaluationType and MarketplaceId columns should be specified.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.

  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'

• The seller has a valid transaction on the specified marketplace (MarketplaceId) during the past 12 months.
• If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (MarketplaceId) for a complete benchmarking period (eBay evaluation period, usually one month).

Columns

SellerStandardsProfile

Returns the standards profiles for the associated seller.

Select

The connector 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 connector.

The Program and Cycle columns support server side filtering only when specified at the same time and only for the = operator.

• Supported values for the Program column are: PROGRAM_DE, PROGRAM_UK, PROGRAM_US and PROGRAM_GLOBAL.
• Supported values for the Cycle column are: CURRENT and PROJECTED.

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

Columns

TrafficReportByDay

Returns a report that details the user traffic received by a seller's listings per day.

Select

The connector 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 connector.

To query the TrafficReportByDay view, a value for the MarketplaceId and the report date range via the columns ReportStartDate and ReportEndDate should be specified.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.

  The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.

• Additionally the user can limit the report data to a listing or to a group of listings via the ListingId input.

  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'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TrafficReportByListing

Returns a report that details the user traffic received by a seller's listings per listing.

Select

The connector 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 connector.

To query the TrafficReportByListing view, at least the report date range via the columns ReportStartDate and ReportEndDate should be specified.

• In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.

  The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.

• The MarketplaceId input is server side filterable and can be used to limit the report data only to the specified Marketplaces.

  The MarketplaceId input supports the operators: "=" and "IN".

  Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.

• Additionally the user can limit the report data to a listing or to a group of listings via the ListingId column.

  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'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with eBay Analytics.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from eBay Analytics, along with an indication of whether the procedure succeeded or failed.

eBay Analytics Connector Stored Procedures

GetOAuthAccessToken

Gets the OAuth access token from eBay.

Input

Result Set Columns

GetOAuthAuthorizationURL

Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay Analytics.

Input

Result Set Columns

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with EBay.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for eBay Analytics:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the TrafficReportByListing table:

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

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

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

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the TrafficReportByListing table:

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

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:ebayanalytics:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Connection

OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

The scheme used for authentication. Accepted entries are OAuth and OAuthClient.

Possible Values

OAuth, OAuthClient

Data Type

string

Default Value

Auto

Remarks

• OAuth: Set to this to perform OAuth authentication with the code grant type.
• OAuthClient: Set to this to perform OAuth with the client credentials grant type.

Connection

This section provides a complete list of connection properties you can configure.

RuName

The Redirect URL name used for validation.

Data Type

string

Default Value

""

Remarks

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".

UseSandbox

A boolean indicating if you are using a sandbox account.

Data Type

bool

Default Value

false

Remarks

A boolean indicating if you are using a sandbox account.

MarketplaceId

The identification number for the eBay Marketplace.

Possible Values

EBAY_DE, EBAY_GB, EBAY_AU, EBAY_US

Data Type

string

Default Value

DEFAULT

Remarks

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.

• CustomerServiceMetricByCategory: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
• CustomerServiceMetricByShippingRegion: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
• TrafficReportByDay: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).
• TrafficReportByListing: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\EbayAnalytics Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\EbayAnalytics Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

http://localhost:33333

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthGrantType

The grant type for the OAuth flow.

Possible Values

CODE, CLIENT

Data Type

string

Default Value

CLIENT

Remarks

The following options are available: CODE,CLIENT

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\EbayAnalytics Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\EbayAnalytics Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.