<?php
require_once __DIR__ . '/../../vendor/autoload.php'; // change path as needed
use TencentAds\TencentAds;
use TencentAds\Exception\TencentAdsResponseException;
use TencentAds\Exception\TencentAdsSDKException;
/*****
* 本文件提供了一个创建一个微信推广IOS App的激励视频广告的示例
*/
class AddRewardedVideoAds
{
public static $tads;
public static $ACCESS_TOKEN = 'YOUR ACCESS TOKEN';
public static $ACCOUNT_ID = 'YOUR ACCOUNT ID';
public static $IOS_APP_ID = 'YOUR APP ID'; // 这里放被推广的iOS App的ID,即App Store的数字ID
public static $ADCREATIVE_TEMPLATE_ID = 560; // 激励视频
public static $VIDEO_PATH = 'YOUR AD VIDEO PATH'; // 广告主视频文件路径,560规格要求:750x1334, 6-30秒, <7168K, mp4
public static $AD_TITLE = 'YOUR AD TEXT'; // 广告文案,560规格要求:字数:1~12
public static $LOGO_IMAGE_PATH = 'YOUR LOGO IMAGE PATH'; // 广告品牌LOGO图文件路径,560规格要求:300x300, <50K, png/jpg
public static $LOGO_CORP_NAME = 'YOUR LOGO CORP NAME'; // 广告品牌商标名称,560规格要求:字数:1~9
public function init()
{
$tads = TencentAds::init([
'access_token' => static::$ACCESS_TOKEN,
'is_debug' => true,
]);
$tads->useSandbox(); // 默认访问沙箱环境,如访问正式环境,请切换为$tads->useProduction()
static::$tads = $tads;
return $tads;
}
public function main()
{
try {
/* @var TencentAds $tads */
$tads = static::$tads;
// 第一步,创建推广计划
$campaignType = 'CAMPAIGN_TYPE_NORMAL'; // 普通展示广告
$promotedObjectType = 'PROMOTED_OBJECT_TYPE_APP_IOS'; // 推广IOS App
$campaignId = $this->AddCampaign($tads, $campaignType, $promotedObjectType);
// echo 'Campaign ID: ' . $campaignId . PHP_EOL;
// 第二步,创建推广目标
$promotedObjectId = $this->AddPromotedObject($tads, $promotedObjectType, static::$IOS_APP_ID);
// echo 'Promoted object ID: ' . $promotedObjectId . PHP_EOL;
// 第三步,创建广告组,激励视频不允许使用定向包,因此在广告组里创建定向
$siteSet = ['SITE_SET_WECHAT']; // 投放微信流量
$adgroupId = $this->AddAdgroup($tads, $campaignId, $promotedObjectType, $promotedObjectId, $siteSet);
// echo 'Adgroup ID: ' . $adgroupId . PHP_EOL;
// 第四步,上传素材
$videoId = $this->AddVideo($tads, static::$VIDEO_PATH);
// echo 'Video ID: ' . $videoId . PHP_EOL;
$imageId = $this->AddImage($tads, static::$LOGO_IMAGE_PATH);
// echo 'Image ID: ' . $imageId . PHP_EOL;
// 第五步,创建创意
$adcreativeId = $this->AddAdcreative($tads, static::$ADCREATIVE_TEMPLATE_ID, $campaignId, $promotedObjectType,
$promotedObjectId, $siteSet, $videoId, static::$AD_TITLE, $imageId, static::$LOGO_CORP_NAME);
// echo 'Adcreative ID: ' . $adcreativeId . PHP_EOL;
// 第六步,创建广告
$adId = $this->AddAd($tads, $adgroupId, $adcreativeId);
// echo 'Ad ID: ' . $adId . PHP_EOL;
return $adId;
} catch (TencentAdsResponseException $e) {
// When Api returns an error
echo 'Tencent ads returned an error: ' . $e->getMessage() . PHP_EOL;
throw $e;
} catch (TencentAdsSDKException $e) {
// When validation fails or other local issues
echo 'Tencent ads SDK returned an error: ' . $e->getMessage() . PHP_EOL;
throw $e;
} catch (Exception $e) {
echo 'Other exception: ' . $e->getMessage() . PHP_EOL;
throw $e;
}
}
// 创建朋友圈推广计划
protected function AddCampaign(TencentAds $tads, $campaignType, $promotedObjectType)
{
$campaignName = 'SDK sample campaign ' . uniqid();
$campaignDailyBudget = 0; // 不限日预算
$campaign = $tads->campaigns()
->add([
'account_id' => static::$ACCOUNT_ID,
'campaign_name' => $campaignName,
'campaign_type' => $campaignType,
'promoted_object_type' => $promotedObjectType,
'daily_budget' => $campaignDailyBudget,
]);
$campaignId = $campaign->getCampaignId();
return $campaignId;
}
// 创建iOS App推广目标
protected function AddPromotedObject(TencentAds $tads, $promotedObjectType, $promotedObjectId)
{
$promotedObjects = $tads->promotedObjects()
->get([
'account_id' => static::$ACCOUNT_ID,
'filtering' => [
[
'field' => 'promoted_object_id',
'operator' => 'EQUALS',
'values' => [$promotedObjectId],
],
],
]);
if (count($promotedObjects->getList()) > 0) {
// 从App Store更新推广目标的信息
$promotedObjects = $tads->promotedObjects()
->update([
'account_id' => static::$ACCOUNT_ID,
'promoted_object_type' => $promotedObjectType,
'promoted_object_id' => $promotedObjectId,
]);
} else {
// 创建推广目标
$promotedObjects = $tads->promotedObjects()
->add([
'account_id' => static::$ACCOUNT_ID,
'promoted_object_type' => $promotedObjectType,
'promoted_object_id' => $promotedObjectId,
]);
}
return $promotedObjectId;
}
// 创建广告组
protected function AddAdgroup(
TencentAds $tads,
$campaignId,
$promotedObjectType,
$promotedObjectId,
$siteSet
) {
$adgroupName = 'SDK sample adgroup ' . uniqid();
$beginDate = date('Y-m-d', strtotime('+1 day')); // 开始投放日期
$endDate = date('Y-m-d', strtotime('+10 day')); // 结束投放日期
$billingEvent = 'BILLINGEVENT_IMPRESSION'; // CPM
$bidAmount = 5000; // 50元(单位为分)
$optimizationGoal = 'OPTIMIZATIONGOAL_APP_ACTIVATE'; // 优化目标APP激活
$timeSeries = str_repeat('1', 48 * 7); // 全天投放
$adgroupDailyBudget = 1000000; // 日预算10000元(单位为分)
$expandEnabled = true; // 开启自动扩量
$expandTargeting = ['age', 'geo_location', 'gender']; // 自动扩量定向范围
$regionIds = ['310000']; // 上海,激励视频地域只能位于同一城市
$targeting = [
'age' => [
[ // 年龄定向,23~45岁
'min' => 23,
'max' => 45,
],
],
'gender' => ['MALE'], // 性别定向,男性
'geo_location' => [ // 地域定向
'location_types' => ['LIVE_IN'],
'regions' => $regionIds,
],
'user_os' => ['IOS'], // 操作系统定向
];
$adgroup = $tads->adgroups()
->add([
'account_id' => static::$ACCOUNT_ID,
'campaign_id' => $campaignId,
'adgroup_name' => $adgroupName,
'promoted_object_type' => $promotedObjectType,
'begin_date' => $beginDate,
'end_date' => $endDate,
'billing_event' => $billingEvent,
'bid_amount' => $bidAmount,
'optimization_goal' => $optimizationGoal,
'time_series' => $timeSeries,
'site_set' => $siteSet,
'daily_budget' => $adgroupDailyBudget,
'promoted_object_id' => $promotedObjectId,
'targeting' => $targeting,
'is_rewarded_video_ad' => true,
'expand_enabled' => $expandEnabled,
'expand_targeting' => $expandTargeting,
]);
$adgroupId = $adgroup->getAdgroupId();
return $adgroupId;
}
// 上传素材
protected function AddImage(TencentAds $tads, $imageFile)
{
$imageSignature = md5_file($imageFile);
$uploadType = 'UPLOAD_TYPE_FILE';
$image = $tads->images()
->add([
'account_id' => static::$ACCOUNT_ID,
'upload_type' => $uploadType,
'file' => $imageFile,
'signature' => $imageSignature,
]);
$imageId = $image->getImageId();
return $imageId;
}
// 上传素材
protected function AddVideo(TencentAds $tads, $videoFile)
{
$videoSignature = md5_file($videoFile);
$video = $tads->videos()
->add([
'account_id' => static::$ACCOUNT_ID,
'video_file' => $videoFile,
'signature' => $videoSignature,
]);
$videoId = $video->getVideoId();
return $videoId;
}
// 创建创意
protected function AddAdcreative(
TencentAds $tads,
$adcreativeTemplateId,
$campaignId,
$promotedObjectType,
$promotedObjectId,
$siteSet,
$videoId,
$adTitle,
$logoImageId,
$logoCorpName
) {
$adcreativeName = 'SDK sample adcreative ' . uniqid();
$adcreativeElements = [
'video' => $videoId,
'title' => $adTitle,
'corporate' => [
'corporate_name' => $logoCorpName,
'corporate_img' => $logoImageId,
],
];
$pageType = 'PAGE_TYPE_DEFAULT';
$adcreative = $tads->adcreatives()
->add([
'account_id' => static::$ACCOUNT_ID,
'campaign_id' => $campaignId,
'adcreative_name' => $adcreativeName,
'adcreative_template_id' => $adcreativeTemplateId,
'adcreative_elements' => $adcreativeElements,
'promoted_object_type' => $promotedObjectType,
'page_type' => $pageType,
'site_set' => $siteSet,
'promoted_object_id' => $promotedObjectId,
]);
$adcreativeId = $adcreative->getAdcreativeId();
return $adcreativeId;
}
// 创建广告
protected function AddAd(TencentAds $tads, $adgroupId, $adcreativeId)
{
$adName = 'SDK sample ad ' . uniqid();
$ad = $tads->ads()
->add([
'account_id' => static::$ACCOUNT_ID,
'adgroup_id' => $adgroupId,
'adcreative_id' => $adcreativeId,
'ad_name' => $adName,
]);
$adId = $ad->getAdId();
return $adId;
}
}
if (basename($_SERVER['PHP_SELF']) == basename(__FILE__)) {
try {
$example = new AddRewardedVideoAds();
$example->init();
$example->main();
} catch (\Exception $e) {
exit(-1);
}
}
package com.tencent.ads.examples.WechatAds;
import com.tencent.ads.ApiContextConfig;
import com.tencent.ads.ApiException;
import com.tencent.ads.TencentAds;
import com.tencent.ads.exception.TencentAdsResponseException;
import com.tencent.ads.exception.TencentAdsSDKException;
import com.tencent.ads.model.AdcreativeCorporate;
import com.tencent.ads.model.AdcreativeCreativeElementsMp;
import com.tencent.ads.model.AdcreativesAddRequest;
import com.tencent.ads.model.AdcreativesAddResponseData;
import com.tencent.ads.model.AdgroupsAddRequest;
import com.tencent.ads.model.AdgroupsAddResponseData;
import com.tencent.ads.model.AdsAddRequest;
import com.tencent.ads.model.AdsAddResponseData;
import com.tencent.ads.model.AgeStruct;
import com.tencent.ads.model.BillingEvent;
import com.tencent.ads.model.CampaignType;
import com.tencent.ads.model.CampaignsAddRequest;
import com.tencent.ads.model.CampaignsAddResponseData;
import com.tencent.ads.model.DestinationType;
import com.tencent.ads.model.FilteringStruct;
import com.tencent.ads.model.GeoLocations;
import com.tencent.ads.model.ImagesAddResponseData;
import com.tencent.ads.model.OptimizationGoal;
import com.tencent.ads.model.PromotedObjectType;
import com.tencent.ads.model.PromotedObjectsAddRequest;
import com.tencent.ads.model.PromotedObjectsGetResponseData;
import com.tencent.ads.model.PromotedObjectsUpdateRequest;
import com.tencent.ads.model.VideosAddResponseData;
import com.tencent.ads.model.WriteTargetingSettingForAdgroup;
import com.tencent.ads.utils.SignatureUtils;
import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Calendar;
import java.util.List;
import java.util.UUID;
/** *** 本文件提供了一个创建一个微信推广IOS App的激励视频广告的示例 */
public class AddRewardedVideoAds {
/** YOUR ACCESS TOKEN */
public String ACCESS_TOKEN = "YOUR ACCESS TOKEN";
/** YOUR ACCOUNT ID */
public Long ACCOUNT_ID = 0L;
/** YOUR IOS_APP_ID */
public static String IOS_APP_ID = "IOS_APP_ID"; // 这里放被推广的iOS App的ID,即App Store的数字ID
/** YOUR ADCREATIVE_TEMPLATE_ID */
public static Long ADCREATIVE_TEMPLATE_ID = 560L; // 激励视频
/** YOUR AD VIDEO_PATH */
public static String VIDEO_PATH =
"YOUR AD VIDEO PATH"; // 广告主视频文件路径,560规格要求:750x1334, 6-30秒, <7168K, mp4
/** YOUR AD TEXT */
public static String AD_TITLE = "YOUR AD TEXT"; // 广告文案,560规格要求:字数:1~12
/** YOUR LOGO IMAGE PATH */
public static String LOGO_IMAGE_PATH =
"YOUR LOGO IMAGE PATH"; // 广告品牌LOGO图文件路径,560规格要求:300x300, <50K, png/jpg
/** YOUR LOGO CORP NAME */
public static String LOGO_CORP_NAME = "YOUR LOGO CORP NAME"; // 广告品牌商标名称,560规格要求:字数:1~9
/** TencentAds */
public TencentAds tencentAds;
private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
public void init() {
this.tencentAds = TencentAds.getInstance();
this.tencentAds.init(
new ApiContextConfig().accessToken(ACCESS_TOKEN).isDebug(true)); // debug==true 会打印请求详细信息
this.tencentAds.useSandbox(); // 默认使用沙箱环境,如果要请求线上,这里需要设为线上环境
}
public Long addRewardedVideoAds() throws Exception {
// 第一步,创建推广计划
CampaignType campaignType = CampaignType.NORMAL; // 普通展示广告
PromotedObjectType promotedObjectType = PromotedObjectType.APP_IOS; // 推广IOS App
Long campaignId = addCampaign(campaignType, promotedObjectType);
// 第二步,创建推广目标
String promotedObjectId = addPromotedObject(promotedObjectType, IOS_APP_ID);
// 第三步,创建广告组,激励视频不允许使用定向包,因此在广告组里创建定向
List<String> siteSet = Arrays.asList("SITE_SET_WECHAT"); // 投放微信流量
Long adgroupId = addAdgroup(campaignId, promotedObjectType, promotedObjectId, siteSet);
// 第四步,上传素材
Long videoId = addVideo(VIDEO_PATH);
String imageId = addImage(LOGO_IMAGE_PATH);
// 第五步,创建创意
Long adcreativeId =
addAdcreative(
ADCREATIVE_TEMPLATE_ID,
campaignId,
promotedObjectType,
promotedObjectId,
siteSet,
String.valueOf(videoId),
AD_TITLE,
imageId,
LOGO_CORP_NAME);
// 第六步,创建广告
Long adId = addAd(adgroupId, adcreativeId);
return adId;
}
public static void main(String[] args) {
try {
AddRewardedVideoAds addRewardedVideoAds = new AddRewardedVideoAds();
addRewardedVideoAds.init();
Long adId = addRewardedVideoAds.addRewardedVideoAds();
} catch (TencentAdsResponseException e) {
e.printStackTrace();
} catch (TencentAdsSDKException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
}
// 创建推广计划
private Long addCampaign(CampaignType campaignType, PromotedObjectType promotedObjectType)
throws ApiException {
String campaignName = "SDK计划" + UUID.randomUUID().toString().substring(0, 10);
Long campaignDailyBudget = 0L; // 不限日预算
CampaignsAddResponseData response =
tencentAds
.campaigns()
.campaignsAdd(
new CampaignsAddRequest()
.accountId(ACCOUNT_ID)
.campaignName(campaignName)
.campaignType(campaignType)
.promotedObjectType(promotedObjectType)
.dailyBudget(campaignDailyBudget));
return response.getCampaignId();
}
// 创建iOS App推广目标
private String addPromotedObject(PromotedObjectType promotedObjectType, String promotedObjectId)
throws ApiException {
PromotedObjectsGetResponseData getResponseData =
tencentAds
.promotedObjects()
.promotedObjectsGet(
ACCOUNT_ID,
Arrays.asList(
new FilteringStruct()
.field("promoted_object_id")
.operator("EQUALS")
.values(Arrays.asList(String.valueOf(promotedObjectId)))),
null,
null,
null);
if (getResponseData != null && getResponseData.getList().size() > 0) {
tencentAds
.promotedObjects()
.promotedObjectsUpdate(
new PromotedObjectsUpdateRequest()
.accountId(ACCOUNT_ID)
.promotedObjectType(promotedObjectType)
.promotedObjectId(promotedObjectId));
} else {
tencentAds
.promotedObjects()
.promotedObjectsAdd(
new PromotedObjectsAddRequest()
.accountId(ACCOUNT_ID)
.promotedObjectType(promotedObjectType)
.promotedObjectId(promotedObjectId));
}
return promotedObjectId;
}
// 创建广告组
private Long addAdgroup(
Long campaignId,
PromotedObjectType promotedObjectType,
String promotedObjectId,
List<String> siteSet)
throws ApiException {
String adgroupName = "SDK sample adgroup " + UUID.randomUUID().toString().substring(0, 10);
Calendar calendar = Calendar.getInstance();
calendar.add(Calendar.DATE, 1);
String beginDate = sdf.format(calendar.getTime());
calendar.add(Calendar.DATE, 10);
String endDate = sdf.format(calendar.getTime());
BillingEvent billingEvent = BillingEvent.IMPRESSION; // CPM
Long bidAmount = 20000L; // 200元(单位为分)
OptimizationGoal optimizationGoal = OptimizationGoal.APP_ACTIVATE; // 优化目标APP激活
String timeSeries =
"11111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111"
+ "1111111111111111111111111111111111111111111111111111111"; // 全天投放
Long adgroupDailyBudget = 1000000L; // 日预算10000元(单位为分)
boolean expandEnabled = true; // 开启自动扩量
List<String> expandTargeting = Arrays.asList("age", "geo_location", "gender"); // 自动扩量定向范围
List<Long> regionIds = Arrays.asList(310000L); // 上海,激励视频地域只能位于同一城市
AdgroupsAddResponseData responseData =
tencentAds
.adgroups()
.adgroupsAdd(
new AdgroupsAddRequest()
.accountId(ACCOUNT_ID)
.campaignId(campaignId)
.adgroupName(adgroupName)
.promotedObjectType(promotedObjectType)
.beginDate(beginDate)
.endDate(endDate)
.billingEvent(billingEvent)
.bidAmount(bidAmount)
.optimizationGoal(optimizationGoal)
.timeSeries(timeSeries)
.siteSet(siteSet)
.dailyBudget(adgroupDailyBudget)
.promotedObjectId(promotedObjectId)
.targeting(
new WriteTargetingSettingForAdgroup()
.age(Arrays.asList(new AgeStruct().max(45L).min(23L)))
.gender(Arrays.asList("MALE"))
.geoLocation(
new GeoLocations()
.locationTypes(Arrays.asList("LIVE_IN"))
.regions(regionIds))
.userOs(Arrays.asList("IOS")))
.expandEnabled(expandEnabled)
.expandTargeting(expandTargeting));
return responseData.getAdgroupId();
}
// 上传素材
private String addImage(String imageFile) throws Exception {
String imageSignature = SignatureUtils.getMD5Checksum(imageFile);
String uploadType = "UPLOAD_TYPE_FILE";
ImagesAddResponseData responseData =
tencentAds
.images()
.imagesAdd(
ACCOUNT_ID,
uploadType,
imageSignature,
new File(imageFile),
null,
null,
null,
null,
null,
null);
return responseData.getImageId();
}
// 上传视频
private Long addVideo(String videoFile) throws Exception {
String imageSignature = SignatureUtils.getMD5Checksum(videoFile);
VideosAddResponseData responseData =
tencentAds.videos().videosAdd(ACCOUNT_ID, new File(videoFile), imageSignature, null, null);
return responseData.getVideoId();
}
// 创建创意
private Long addAdcreative(
Long adcreativeTemplateId,
Long campaignId,
PromotedObjectType promotedObjectType,
String promotedObjectId,
List<String> siteSet,
String videoId,
String adTitle,
String logoImageId,
String logoCorpName)
throws ApiException {
String adcreativeName = "SDK sample adcreative " + UUID.randomUUID().toString();
DestinationType pageType = DestinationType.DEFAULT; // 'PAGE_TYPE_FULL_SCREEN_WECHAT';
AdcreativesAddResponseData responseData =
tencentAds
.adcreatives()
.adcreativesAdd(
new AdcreativesAddRequest()
.accountId(ACCOUNT_ID)
.campaignId(campaignId)
.adcreativeName(adcreativeName)
.adcreativeTemplateId(adcreativeTemplateId)
.adcreativeElements(
new AdcreativeCreativeElementsMp()
.title(adTitle)
.video(videoId)
.corporate(
new AdcreativeCorporate()
.corporateName(logoCorpName)
.corporateImg(logoImageId)))
.promotedObjectType(promotedObjectType)
.pageType(pageType)
.siteSet(siteSet)
.promotedObjectId(String.valueOf(promotedObjectId)));
return responseData.getAdcreativeId();
}
// 创建广告
private Long addAd(Long adgroupId, Long adcreativeId) throws ApiException {
String adName = "SDK sample ad " + UUID.randomUUID().toString().substring(0, 10);
AdsAddResponseData responseData =
tencentAds
.ads()
.adsAdd(
new AdsAddRequest()
.accountId(ACCOUNT_ID)
.adgroupId(adgroupId)
.adcreativeId(adcreativeId)
.adName(adName));
return responseData.getAdId();
}
}