SDK使用指引

概述

腾讯广告 Marketing API(以下简称API) SDK 提供了Token获取、请求封装、响应解释等功能，以本地化方式轻松完成API的调用和结果的获取，旨在帮助开发者快速搭建投放管理系统。现已覆盖Marketing API V1.1及V1.2的所有对外接口，同时支持腾讯广告账户及微信公众平台广告主的使用。后续，腾讯广告SDK还会基于不同行业客户常见的API应用场景，提供场景化的接口组合调用封装，并推出更多语言版本，敬请期待。

一、使用条件

1.使用SDK需要首先注册成为腾讯广告开发者，请参考开发者快速入门文档2.使用SDK进行不同接口的调试时，需要拥有API对应接口的操作权限。请参考开发者快速入门文档申请您所需要的接口权限范围。 3.PHP SDK 需要依赖 PHP 5.5 及以上

二、如何安装

手动下载SDK压缩包文件，解压后将文件放入项目目录(一般是vendor目录下)。 SDK下载地址：ams-marketing-sdk-php-1.0.0.zip1. 解压文件，默认解压到目录ams-marketing-sdk-php 2. 执行composer install安装依赖 “`
cd ams-marketing-sdk-php
composer install


3. 添加依赖和namespace映射，require相应的autoload文件。 ```
require_once __DIR__ . '/vendor/ams-marketing-sdk-php/vendor/autoload.php'; // 修改对应目录

三、如何使用

1.获取Access Token

注：本示例适用于授权时通过Authorization Code获取Access Token和Refresh Token，如需更新Access Token请参考 ./examples/refresh_token.php 示例

<?php
require_once __DIR__ . '/vendor/ams-marketing-sdk-php/vendor/autoload.php'; // sdk目录下的vendor目录
use TencentAds\TencentAds;
$tads = TencentAds::init([
  'is_debug' => '{is-debug}'
]);
$token = $tads->useSandbox() //默认访问沙箱环境，如访问生产环境，请调用$tads->useProduction()
    ->oauth()->token([
    'client_id' => '{your client id}',
    'client_secret' => '{your client secret}',
    'grant_type' => 'authorization_code',
    'authorization_code' => '{your authorization code}',
    'redirect_uri' =&gt '{your redirect uri}'
]);
$refreshToken = $token->getRefreshToken();
$accessToken = $token->getAccessToken();

2.设置请求地址、Access Token

<?php
require_once __DIR__ . '/vendor/ams-marketing-sdk-php/vendor/autoload.php';
use TencentAds\TencentAds;
$tads = TencentAds::init([
  'access_token' => '{access-token}',
  'is_debug' => '{is-debug}'
]);

3.调用API接口

<?php
require_once __DIR__ . '/vendor/ams-marketing-sdk-php/vendor/autoload.php';
use TencentAds\TencentAds;
use TencentAds\Exception\TencentAdsResponseException;
use TencentAds\Exception\TencentAdsSDKException;
$tads = TencentAds::init([
  'access_token' => '{access-token}',
  'is_debug' => '{is-debug}'
]);
try {
  $filtering = [[
    'field' => 'promoted_object_type',
    'operator' => 'EQUALS',
    'values' => ['PROMOTED_OBJECT_TYPE_APP_IOS'],
  ]];
  $response = $tads   //不指定环境则默认访问沙箱环境，如访问生产环境，请调用$tads->useProduction()
     ->campaigns()
     ->get(['filtering' => $filtering]);
} catch(TencentAdsResponseException $e) {
  // When Api returns an error
  echo 'Tencent ads returned an error: ' . $e->getMessage();
  exit;
} catch(TencentAdsSDKException $e) {
  // When validation fails or other local issues
  echo 'Tencent ads SDK returned an error: ' . $e->getMessage();
  exit;
}

4.调试和查看API接口日志

<?php
require_once __DIR__ . '/vendor/ams-marketing-sdk-php/vendor/autoload.php';
use TencentAds\TencentAds;
$tads = TencentAds::init([
  'access_token' => '{access-token}',
  'is_debug'     => true,
  // 不指定，输出到 php://output
  'debug_file'   => '{your log path}',
]);

四、问题与反馈

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

首页

开发文档

腾讯广告