Marketing Java SDK

概述

腾讯广告 Marketing API(以下简称API) SDK 提供了Token获取、请求封装、响应解释等功能，以本地化方式轻松完成API的调用和结果的获取，旨在帮助开发者快速搭建投放管理系统。 未来还会基于常用的广告投放场景，提供场景化的接口组合及调用封装。

使用条件

1. 使用SDK需要首先注册成为腾讯广告开发者，请参考开发者快速入门文档
2. 使用SDK需要先拥有API的访问权限，所有SDK的使用与应用拥有的权限组相关联
3. Java SDK 需要依赖 JDK 1.7 及以上
4. Maven

代码托管

目前marketing-api-java-sdk的源码已经可以在github阅读，欢迎访问：源码地址

如何安装运行

• 我们推荐用Maven的方式管理我们的Java SDK，可以添加如下XML内容到您项目的pom.xml中

<dependency>
<groupId>com.tencent.ads</groupId>
<artifactId>marketing-api-java-sdk</artifactId>
<version>1.1.113</version>
</dependency>

• 或者您也可以手动下载Java压缩包文件，解压后可以得到一个Java SDK的源码项目。SDK下载地址：ams-marketing-sdk-java.zip

  1. 解压文件，默认解压到目录ams-marketing-sdk-java。
  2. 执行mvn clean install，将包安装到你本地的Maven资源库中。

cd ams-marketing-sdk-java
mvn clean install

3. 在你的项目的pom.xml中添加刚刚安装的依赖

 <dependency>
<groupId>com.tencent.ads</groupId>
<artifactId>marketing-api-java-sdk</artifactId>
<version>1.1.113</version>
</dependency>

如何使用

SDK数组参数调用的方法名与API接口一一对应，如campaigns/get接口就对应TencentAds.getInstance().campaigns().campaignsGet()方法。

获取Access Token

注：本示例适用于授权时通过Authorization Code获取Access Token和Refresh Token。

importcom.tencent.ads.model.OauthTokenResponseData;
publicclassExample {
privatestaticLongclientId = 0L; // 修改为你的clientIdprivatestaticStringclientSecret = ""; // 修改为你的clientSecretprivatestaticStringgrantType = "authorization_code";
privatestaticStringauthorizationCode = "YOUR AUTHORIZATION CODE"; // 修改为你获取到的AUTHORIZATION CODEprivatestaticStringredirectUri = "YOUR REDIRECT URI"; // 修改为你的回调地址publicstaticvoidmain(String[] args) {
TencentAdstencentAds = TencentAds.getInstance();
tencentAds.init(newApiContextConfig());
try {
OauthTokenResponseDataresponseData = tencentAds.oauth()
.oauthToken(clientId, clientSecret, grantType, authorizationCode, null, redirectUri);
if (responseData != null) {
StringaccessToken = responseData.getAccessToken();
System.out.println(accessToken);
tencentAds.setAccessToken(accessToken);
}
} catch (Exceptione) {
e.printStackTrace();
}
}
}

设置调用环境、Access Token

TencentAdstencentAds = TencentAds.getInstance();
tencentAds.init(newApiContextConfig("{access-token}", true));
tencentAds.useSandbox();// 默认访问沙箱环境，如访问正式环境，请调用tencentAds.useProduction();

调用API接口

importcom.tencent.ads.ApiContextConfig;
importcom.tencent.ads.TencentAds;
importcom.tencent.ads.exception.TencentAdsResponseException;
importcom.tencent.ads.exception.TencentAdsSDKException;
importcom.tencent.ads.model.CampaignsGetResponseData;
importcom.tencent.ads.model.FilteringStruct;
importjava.util.ArrayList;
importjava.util.Arrays;
importjava.util.List;
/** * 本文件提供了一个获取推广计划(Campaign)列表的简单示例 **/publicclassGetCampaigns {
/** * YOUR ACCESS TOKEN */publicStringACCESS_TOKEN = "YOUR ACCESS TOKEN";
/** * YOUR ACCOUNT ID */publicLongACCOUNT_ID = 0L;
/** * TencentAds */publicTencentAdstencentAds;
publicvoidinit() {
this.tencentAds = TencentAds.getInstance();
this.tencentAds.init(
newApiContextConfig().accessToken(ACCESS_TOKEN).isDebug(true));// debug==true 会打印请求详细信息this.tencentAds.useSandbox();// 默认使用沙箱环境，如果要请求线上，这里需要设为线上环境
}
publicCampaignsGetResponseDatagetCampaigns() throwsException {
LongaccountId = ACCOUNT_ID;
List<FilteringStruct> filtering = newArrayList<>();
Longpage = null;
LongpageSize = null;
BooleanisDeleted = null;
List<String> fields = Arrays
.asList("campaign_id", "campaign_name");
FilteringStructfilter = newFilteringStruct().field("promoted_object_type").operator("EQUALS")
.values(Arrays.asList("PROMOTED_OBJECT_TYPE_APP_IOS"));
filtering.add(filter);
CampaignsGetResponseDataresponseData = tencentAds.campaigns()
.campaignsGet(accountId, filtering, page, pageSize, isDeleted, fields);
returnresponseData;
}
publicstaticvoidmain(String[] args) {
try {
GetCampaignsgetCampaigns = newGetCampaigns();
getCampaigns.init();
CampaignsGetResponseDataresponseData = getCampaigns.getCampaigns();
} catch (TencentAdsResponseExceptione) {
e.printStackTrace();
} catch (TencentAdsSDKExceptione) {
e.printStackTrace();
} catch (Exceptione) {
e.printStackTrace();
}
}
}

调试和查看API接口日志

TencentAdstencentAds = TencentAds.getInstance();
tencentAds.init(newApiContextConfig("{access-token}", true));//第二个参数即为调试参数// 或者主动设置debug模式tencentAds.setDebug(true);

问题建议与反馈

如果您在使用SDK过程中有任何问题与建议，请随时登录开发者官网，点击右下角的"咨询"按钮，与我们的客服支持人员联系

后续计划

1. 丰富各类场景示例
2. 推出其他语言的SDK