How to Make Generic API Request (Bulk Write) — Amazon Ads Connector for SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Make Generic API Request (Bulk Write) in SSIS
-
Begin with opening Visual Studio and Create a New Project.
-
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
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.
-
Select New Connection to create a new connection:
API Destination - Amazon AdsAmazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports. -
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 -
Now it's time to configure authentication. Firstly, configure authentication settings in Amazon Ads service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:
Amazon Ads authentication
Amazon OAuth Security Profile has be created in Amazon Developer portal. [API reference]
- Firstly, login into Amazon Developer portal in https://developer.amazon.com.
- Then click Sign in.
- If you don't have an account, press Create your Amazon Developer account button to create one.
- Once logged in, click on your profile icon on the right-top of the window and hit Settings:
- Then click Security Profiles and proceed with creating a new Security Profile:
- 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:
- Continue by setting Allowed Return URLs (you can have your own or use
https://zappysys.com/oauth
): -
Done!
Now you can use Client ID, Client Secret, and Redirect URL
when configuring OAuth Authentication parameters:
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
OAuth Authentication [OAuth]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
Amazon AdsOAuth Authentication [OAuth]https://advertising-api.amazon.com/v2Required 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 -
Select Generic Table (Bulk Read / Write) table from the dropdown, then select Insert, Update as operation, and hit Preview Data:
API Destination - Amazon AdsAmazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.Amazon AdsGeneric Table (Bulk Read / Write)Insert, UpdateRequired Parameters Url Fill-in the parameter... Request Method Fill-in the parameter... Optional Parameters IsMultiPart Filter Request Format (Content-Type) Default Body {$rows$} JsonOutputFormat Multicontent DoNotOutputNullProperty Batch Size (Default=1) 1 Meta Detection Order StaticDynamicVirtual Input Columns - For Mapping (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double Output Columns (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double Request Format Response Format Default Headers Accept: */* || Cache-Control: no-cache Csv - Column Delimiter , Csv - Row Delimiter {NEWLINE} Csv - Quote Around Value True Csv - Always Quote regardless type Encoding CharacterSet Writer DateTime Format Csv - Has Header Row True Xml - ElementsToTreatAsArray Layout Map <?xml version="1.0" encoding="utf-8"?> <!-- Example#1: Output all columns --> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings> <!-- Example#2: Records under array <?xml version="1.0" encoding="utf-8"?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings> --> <!-- Example#3: Records under nested section <?xml version="1.0" encoding="utf-8"?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings> --> -
Finally, map the desired columns:
API Destination - Amazon AdsAmazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports. -
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
More actions supported by Amazon Ads Connector
Learn how to perform other actions directly in SSIS with these how-to guides: