Amazon Ads Connector for SQL Server : Get profiles via SQL

Integrate SQL Server and Amazon Ads
Integrate SQL Server and Amazon Ads

Learn how to get profiles using the Amazon Ads Connector for SQL Server. This connector enables you to read and write Amazon Ads data effortlessly. Integrate, manage, and automate campaigns, ad groups, and performance metrics — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Amazon Ads ODBC Driver

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
    • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
  4. 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
  5. 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 Ads authentication

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

    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:

      Create Amazon developer security profile
    6. 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:

      Reveal client secret in Amazon developer security profile
    7. 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
    8. 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
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth Authentication [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    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

  6. Then go to Preview tab to start building a SQL query.

  7. Once you do that, proceed by opening Query Builder:

    ZappySys API Driver - Amazon Ads
    Read and write Amazon Ads data effortlessly. Integrate, manage, and automate campaigns, ad groups, and performance metrics — almost no coding required.
    AmazonAdsDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Then simply select the Get Profiles endpoint (action).

  9. Continue by configuring the Required parameters. You can also set optional parameters too.

  10. Move on by hitting Preview Data button to preview the results.

  11. If you see the results you need, simply copy the generated query:

    Get Profiles
    This Endpoint has no parameters.
    SELECT * FROM Profiles
    Query Builder
  12. Click OK to use built SQL query and close the Query Builder.

  13. 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 SQL Server:

    ZappySys API Driver - Amazon Ads
    Read and write Amazon Ads data effortlessly. Integrate, manage, and automate campaigns, ad groups, and performance metrics — almost no coding required.
    AmazonAdsDSN
    SELECT * FROM Profiles
    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).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Amazon Ads SQL query examples

Use these SQL queries in your SQL Server data source:

List profiles

Return all available advertising profiles as rows. Use this to see which profiles (accounts) are accessible with the current credentials.

SELECT * FROM Profiles

get_profiles endpoint belongs to Profiles table(s), and can therefore be used via those table(s).

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table
  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"
    ZappySys Driver - Execute Custom Virtual Table Query

Get profiles in SQL Server via SQL view

  1. First of all, copy the generated SQL query from the previous step.

  2. Then open Microsoft SQL Server Management Studio.

  3. 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 Profiles')
    Execute query at Linked Server to ZappySys Data Gateway in SSMS

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

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    
    ZappySys Driver - Create Custom Stored Procedure
  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';
    ZappySys Driver - Execute Custom Stored Procedure

Conclusion

And there you have it — a complete guide on how to get profiles in SQL Server without writing complex code. All of this was powered by Amazon Ads ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by Amazon Ads Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Amazon Ads operations directly in SQL Server, so you can skip the trial and error. Find your next step-by-step guide below:

More Amazon Ads integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications