手把手教你從零開始搭建Amazon Advertising-API開發環境(二)之獲取SP廣告數據

1. 獲取access_token

官方連接java

1.1 請求路徑 POST

地區 URL
NA api.amazon.com/auth/o2/tok…
EU api.amazon.co.uk/auth/o2/tok…
FE api.amazon.co.jp/auth/o2/tok…

1.2 請求事例

curl \ -X POST \ -H "Content-Type:application/x-www-form-urlencoded;charset=UTF-8" \ --data "grant_type=refresh_token&client_id=YOUR_CLIENT_ID&refresh_token=YOUR_REFRESH_TOKEN&client_secret=YOUR_CLIENT_SECRET" \ api.amazon.com/auth/o2/tok…ios

1.3 代碼實操

//獲取access_token的方法,以NA地區爲例。
HashMap<String, Object> map = new HashMap<>();
map.put("grant_type","refresh_token");            map.put("refresh_token","your refresh_token");
map.put("client_id","your client_id");
map.put("client_secret","your client_secret");
String getAccessUrl = "https://api.amazon.com/auth/o2/token";
String result = HttpUtil.doPost(getAccessUrl,map,null);
Map map1 = JSONObject.parseObject(result, Map.class);
String access_token = (String) map1.get("access_token");
System.out.println("access_token = " + access_token);
複製代碼

運行結果以下:json

image-20210726111027125.png

2. 獲取profileId

官方鏈接api

2.1 請求路徑 GET

https://advertising-api.amazon.com/v2/profiles
複製代碼

2.2 請求參數

參數名稱 可能的值(string)
apiProgram billing, campaign, paymentMethod, store, report, account, posts
accessLevel edit, view
profileTypeFilter seller, vendor, agency
validPaymentMethodFilter true, false

請求頭:微信

key value
Content-Type application/json
Authorization access_token
Amazon-Advertising-API-ClientId your client_id

2.3 代碼實操

String url = "https://advertising-api.amazon.com/v2/profiles?apiProgram=billing&profileTypeFilter=seller&validPaymentMethodFilter=true";
HashMap<String, String> headerMap = new HashMap<>();
headerMap.put("Content-Type","application/json");
headerMap.put("Authorization","Bearer "+access_token);
headerMap.put("Amazon-Advertising-API-ClientId","your client_id");
String result1 = HttpUtil.doGet1(url,headerMap);
List<Map> profileIds = JSONObject.parseArray(result1, Map.class);
System.out.println("profileIds = " + profileIds);
複製代碼

運行結果以下:markdown

image-20210726114127641.png

3. 建立sp_campaign報表

官方連接app

⚠️:這次官方文檔的Responses有誤,你們懂的都懂,已實際的Responses爲主。curl

3.1 請求路徑 POST

https://advertising-api.amazon.com/v2/sp/campaigns/report
複製代碼

3.2 請求參數

請求體參數:oop

key Value
stateFilter enabled, paused, archived
campaignType sponsoredProducts
segment query, placement
reportDate YYYYMMDD
metrics 傳入你想獲取的值

請求頭:post

key value
Content-Type application/json
Amazon-Advertising-API-ClientId your client_id
Amazon-Advertising-API-Scope profileId(第二步獲取的)
Authorization access_token

3.3 代碼實操

/** *第二步獲取的是個List,選擇符合條件的進行操做,本次實操選擇的是type=seller,profileId=xxxxxxxx,countryCode=CA */
String createSpReport = "https://advertising-api.amazon.com/v2/sp/campaigns/report";
//構造請求頭
HashMap<String, String> headerMap1 = new HashMap<>();
headerMap1.put("Content-Type","application/json");
headerMap1.put("Amazon-Advertising-API-ClientId","your client_id");
headerMap1.put("Amazon-Advertising-API-Scope",profileId.toString());
headerMap1.put("Authorization","Bearer "+access_token);
//請求體的參數
HashMap<String, Object> paramMap = new HashMap<>();
//paramMap.put("stateFilter", "enabled");
//paramMap.put("campaignType","sponsoredProducts");
//paramMap.put("segment","query");
paramMap.put("reportDate","20210701");
paramMap.put("metrics","campaignName,campaignId,impressions,clicks,cost,attributedConversions14d,attributedSales14d");
String s2 = HttpUtil.doPostBody(createSpReport, JSONObject.toJSONString(paramMap),headerMap1);   
System.out.println("s2 = " + s2);
複製代碼

運行結果以下:

image-20210726135448721.png

4.獲取表報下載地址

4.1 請求路徑 GET

https://advertising-api.amazon.com/v2/reports/{reportId}
複製代碼

4.2 請求參數

請求頭:

key value
Content-Type application/json
Authorization access_token
Amazon-Advertising-API-ClientId your client_id
Amazon-Advertising-API-Scope profileId

4.3 代碼實操

/** 當status=SUCCESS的時候說明報表建立好了,這時去獲取下載URL */
String getSpReport = "https://advertising-api.amazon.com/v2/reports/"+reportId;
HashMap<String, String> header = new HashMap<>();
header.put("Content-Type","application/json");
header.put("Authorization","Bearer "+access_token);
header.put("Amazon-Advertising-API-ClientId","your client_id");
header.put("Amazon-Advertising-API-Scope",profileId.toString());
String report = HttpUtil.doGet1(getSpReport, header);
reportMap = JSONObject.parseObject(report, Map.class);
String downUrl = reportMap.get("location").toString();
複製代碼

運行結果以下:

image-20210726142518285.png

5. 下載報表一

官方連接

官方文檔只有在sd廣告中才有下載的API

5.1 請求路徑 GET

步驟4中獲取的downUrl

5.2 請求參數

請求頭參數:

key value
Content-Type application/json
Authorization access_token
Amazon-Advertising-API-ClientId your client_id
Amazon-Advertising-API-Scope profileId

5.3 代碼實操

/** 步驟4中獲取downUrl並非最終的下載地址,還需再一次請求獲取。 */
HashMap<String, String> headerMap2 = new HashMap<>();
headerMap2.put("Content-Type","application/json");
headerMap2.put("Authorization","Bearer "+access_token);
headerMap2.put("Amazon-Advertising-API-ClientId","your client_id");
headerMap2.put("Amazon-Advertising-API-Scope",profileId.toString());
CloseableHttpResponse response = HttpUtil.doGetReturnResponse(downUrl, headerMap2);
Header[] locations = response.getHeaders("Location");
System.out.println("locations = " + locations);
複製代碼

6.下載報表二

6.1 請求路徑 GET

步驟5中獲取的url

6.2 請求參數

請求頭參數:

key value
Accept-Encoding gzip
Accept application/octet-stream

6.3 代碼實操

HashMap<String, String> header = new HashMap<>();
header.put("Accept-Encoding","gzip");
header.put("Accept","application/octet-stream");
String s3 = HttpUtil.doGet3("url", header);
System.out.println("s3 = " + s3);
複製代碼

執行結果以下:

image-20210726144600516.png

7.根據campaignId獲取portfolioId

官方文檔

因爲步驟六中獲取的信息裏不包含portfolioId,因此繼續獲取portfolioId。

7.1 請求路徑 GET

https://advertising-api.amazon.com/v2/sp/campaigns
複製代碼

7.2 請求參數

本次請求只傳campaignIdFilter參數,

請求頭參數:

key value
Authorization access_token
Amazon-Advertising-API-ClientId your client_id
Amazon-Advertising-API-Scope profileId
Content-Type application/json

7.3 代碼實操

/** campaignId_param爲全部的campaignId以逗號拼接在一塊兒 */
String getPortfolioId_url = "https://advertising-api.amazon.com/v2/sp/campaigns?campaignIdFilter="+campaignId_param;
HashMap<String, String> headerMap3 = new HashMap<>();
headerMap3.put("Authorization","Bearer "+access_token);
headerMap3.put("Amazon-Advertising-API-ClientId","your client_id");
headerMap3.put("Amazon-Advertising-API-Scope",profileId.toString());
headerMap3.put("Content-Type","application/json");
String s4 = HttpUtil.doGet1(getPortfolioId_url, headerMap3);
System.out.println("獲取的portfolioId = " + s4);
複製代碼

執行結果就不演示了。

7.4 根據portfolioId去獲取portfolio信息

官方文檔

7.5 請求路徑

https://advertising-api.amazon.com/v2/portfolios
複製代碼

7.6 請求參數

name type 描述
portfolioId string 檢索具備指定 ID 的投資組合
portfolioName string 檢索具備指定名稱的投資組合
portfolioState string 檢索具備指定狀態的投資組合

請求頭參數:

key value
Authorization access_token
Amazon-Advertising-API-ClientId your client_id
Amazon-Advertising-API-Scope profileId
Content-Type application/json

7.7 代碼實操

/** portfolioIdFilter是portfolioId以逗號拼接到一塊兒的,可是一次最大拼接100個。 */
String getPortfolios_url = "https://advertising-api.amazon.com/v2/portfolios?portfolioIdFilter="+portfolioIdFilter;
HashMap<String, String> headerMap4 = new HashMap<>();
headerMap4.put("Authorization","Bearer "+access_token);
headerMap4.put("Amazon-Advertising-API-ClientId","your client_id");
headerMap4.put("Amazon-Advertising-API-Scope",profileId.toString());
headerMap4.put("Content-Type","application/json");
String s5 = HttpUtil.doGet1(getPortfolios_url, headerMap4);
System.out.println("獲取的portfolio = " + s5); 
複製代碼

執行結果就不演示了。

到此sp廣告數據已獲取到,處理數據保存到文件便可。

PS:你們看了後以爲對本身有幫助能夠三連留言,歡迎提出寶貴意見,如想進行技術交流歡迎加入Amazon各種API開發交流羣!請添加技術人員微信:x118422邀請進羣~

相關文章
相關標籤/搜索