手把手教你从零开始搭建Amazon Advertising-API开发环境(二)之获取SP广告数据

1. 获取access_token

官方链接

1.1 请求路径 POST

地区	URL
NA	https://api.amazon.com/auth/o2/token
EU	https://api.amazon.co.uk/auth/o2/token
FE	https://api.amazon.co.jp/auth/o2/token

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" \    https://api.amazon.com/auth/o2/token

1.3 代码实操

 //获取access_token的方法,以NA地区为例。
HashMap 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);

运行结果如下：

image-20210726111027125.png

2. 获取profileId

官方连接

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 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

运行结果如下：

image-20210726114127641.png

3. 创建sp_campaign报表

官方链接

⚠️：此次官方文档的Responses有误，大家懂的都懂，已实际的Responses为主。

3.1 请求路径 POST

https://advertising-api.amazon.com/v2/sp/campaigns/report

3.2 请求参数

请求体参数：

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

请求头：

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 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 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 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 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 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 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 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广告数据已获取到，处理数据保存到文件即可。