Amazon Ads Connector
Documentation
Version: 1
Documentation

Reading Amazon Ads data in SQL Server using ZappySys Data Gateway


This section covers steps for setting up Amazon Ads Connector in the ZappySys Data Gateway data source (based on API Driver) to read Amazon Ads data in SQL Server:

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    AmazonAdsDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "Amazon Ads" from the list of Popular Connectors. If "Amazon Ads" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    AmazonAdsDSN
    Amazon Ads
    ODBC DSN Template Selection
  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Amazon OAuth Security Profile has be created in Amazon Developer portal. [API reference]

    Steps how to get and use Amazon Ads credentials : OAuth Authentication [OAuth]
    1. Firstly, login into Amazon Developer portal in https://developer.amazon.com.
    2. Then click Sign in.
    3. If you don't have an account, press Create your Amazon Developer account button to create one.
    4. Once logged in, click on your profile icon on the right-top of the window and hit Settings: Amazon developer profile settings
    5. Then click Security Profiles and proceed with creating a new Security Profile:
    6. Create Amazon developer security profile
    7. After that, click Web Settings subtab, then hit Show Secret button to reveal the Client Secret (you will need it later), and click Edit to add a Redirect URL:
    8. Reveal client secret in Amazon developer security profile
    9. Continue by setting Allowed Return URLs (you can have your own or use https://zappysys.com/oauth): Set return URLs in Amazon developer security profile
    10. Done! Now you can use Client ID, Client Secret, and Redirect URL when configuring OAuth Authentication parameters: Use client ID and client secret to connect to REST API Amazon services

    Fill in all required parameters and set optional parameters if needed:

    AmazonAdsDSN
    Amazon Ads
    OAuth Authentication [OAuth]
    https://advertising-api.amazon.com/v2
    Required Parameters
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    AuthorizationUrl Fill-in the parameter...
    ReturnUrl Fill-in the parameter...
    Scope Fill-in the parameter...
    Profile (click 'Generate Token' before this) Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration

  7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    AmazonAdsDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in to retrieve data from Amazon Ads. Hit OK button to use this query in the next step.

    SELECT * FROM Orders
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Amazon Ads API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
  9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in :

    - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    AmazonAdsDSN
    SELECT * FROM Orders
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Amazon Ads API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Amazon Ads servers).
  10. Click OK to finish creating the data source.

Read data in SQL Server

  1. First, let's open SQL Server Management Studio, create a new Linked Server, and start configuring it:

    LS_TO_AMAZON_ADS_IN_GATEWAY
    Microsoft OLE DB Driver for SQL Server
    localhost,5000
    AmazonAdsDSN
    AmazonAdsDSN
    SSMS SQL Server Configure Linked Server
    Choose SQL Server Native Client 11.0 as Provider if you don't see the option shown above.
  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:

    SSMS SQL Server Configure Linked Server User Name
  3. Optional step. Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

    RPC and MSDTC Settings

    You need to enable RPC Out if you plan to use EXEC(...) AT [LS_TO_AMAZON_ADS_IN_GATEWAY] rather than OPENQUERY.
    If don't enabled it, you will encounter the Server 'LS_TO_AMAZON_ADS_IN_GATEWAY' is not configured for RPC error.

    Query Example:

    EXEC('SELECT * FROM Orders') AT [LS_TO_AMAZON_ADS_IN_GATEWAY]


    If you plan to use 'INSERT INTO <TABLE> EXEC(...) AT [LS_TO_AMAZON_ADS_IN_GATEWAY]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
    If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

    Query Example:

    INSERT INTO dbo.Products
    EXEC('SELECT * FROM Orders') AT [LS_TO_AMAZON_ADS_IN_GATEWAY]
    

  4. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([LS_TO_AMAZON_ADS_IN_GATEWAY], 'SELECT * FROM Orders')
    Execute query at Linked Server to ZappySys Data Gateway in SSMS

    SELECT * FROM OPENQUERY([LS_TO_AMAZON_ADS_IN_GATEWAY], 'SELECT * FROM Orders')

Amazon Ads Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Amazon Ads API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Amazon Ads.

Click here to find more Amazon Ads Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Consume Data inside your App / Programming Language

Once you know how to load data from Amazon Ads Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from Amazon Ads Connector.

ODBC inside ETL / Reporting / BI Tools

ODBC inside Programming Languages

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

  1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Amazon Ads without requiring extensive technical expertise or programming knowledge.

  2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Amazon Ads.

  3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Amazon Ads and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

  4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Amazon Ads API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

  5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

  6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Amazon Ads, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Amazon Ads, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.