Amazon Ads Connector for SSIS

Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.

In this article you will learn how to quickly and efficiently integrate Amazon Ads data in SSIS without coding. We will use high-performance Amazon Ads Connector to easily connect to Amazon Ads and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Video Tutorial - Integrate Amazon Ads data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Amazon Ads integration in SSIS
  • How to configure the connection for Amazon Ads
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Amazon Ads in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Amazon Ads in SSIS (Export data)

In this section we will learn how to configure and use Amazon Ads Connector in API Source to extract data from Amazon Ads.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom

    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop
  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Amazon Ads Connector from Popular Connector List or press Search Online radio button to download Amazon Ads Connector. Once downloaded simply use it in the configuration:

    Amazon Ads
    Amazon Ads Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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

    Configuring authentication parameters
    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
    ZappySys OAuth Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Amazon Ads using Amazon Ads Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Amazon Ads and load into target

Write data to Amazon Ads using SSIS (Import data)

In this section we will learn how to configure and use Amazon Ads Connector in the API Destination to write data to Amazon Ads.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Amazon Ads integration in SSIS
  • How to configure connection for Amazon Ads
  • How to write or lookup data to Amazon Ads
  • Features about SSIS API Destination
  • Using Amazon Ads Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Amazon Ads in the API Source to POST data to the Amazon Ads.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    API Destination - New Connection

  4. Use a preinstalled Amazon Ads Connector from Popular Connector List or press Search Online radio button to download Amazon Ads Connector. Once downloaded simply use it in the configuration:

    Amazon Ads
    Amazon Ads Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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

    Configuring authentication parameters
    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
    ZappySys OAuth Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Amazon Ads
    Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Amazon Ads API call using ZappySys Amazon Ads Connector

    Execute Package - Reading data from API Source and load into target

Load Amazon Ads data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Amazon Ads data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table
  9. Click OK to save the configuration.

  10. Run the package and Amazon Ads data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target
  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Actions supported by Amazon Ads Connector

Amazon Ads Connector supports following actions for REST API integration:

Get Beta Report

Description

Generates and downloads an Amazon Ads report.

Parameters

You can provide the following parameters to this action:

  • Report Name
  • Report Type
  • Report Start Date (yyyy-MM-dd) Maximum date range: 31 days
  • Report End Date (yyyy-MM-dd) Maximum date range: 31 days
  • Report Start Date (yyyy-MM-dd) Maximum date range: 731 days
  • Report End Date (yyyy-MM-dd) Maximum date range: 731 days
  • Time Unit
  • Group By
  • Group By
  • Group By
  • Group By
  • Group By
  • Metrics
  • Metrics
  • Metrics
  • Metrics
  • Metrics
  • Metrics

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Get Profiles

Description

Gets your Amazon Ads profiles.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • ProfileId
  • CountryCode
  • CurrencyCode
  • DailyBudget
  • Timezone
  • AccountInfoMarketPlaceStringId
  • AccountInfoId
  • AccountInfoType
  • AccountInfoName
  • AccountInfoValidPaymentMethod
  • UserId

Visit documentation for more information.

Get Report

Description

Downloads an Amazon Ads report.

Parameters

You can provide the following parameters to this action:

  • Record Type
  • Report Date (yyyyMMdd)
  • Metrics
  • State Filter
  • Campaign Type
  • Segment

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Test Connection

Description

Endpoint to test connection.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request

Description

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • Body
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Conclusion

In this article we showed you how to connect to Amazon Ads in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download Amazon Ads Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Amazon Ads Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Amazon Ads

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