鍵.png)
使用這些基本 REST API 最佳實踐構(gòu)建出色的 API
Step 3:完善開發(fā)者資料。將資料填寫完整并通過手機(jī)驗證碼驗證通過后,即完成開發(fā)者注冊。
Step1: 注冊成為開發(fā)者后,在開發(fā)者官網(wǎng)進(jìn)行登陸并進(jìn)入應(yīng)用程序管理看板,可選擇創(chuàng)建私有應(yīng)用或第三方應(yīng)用(私有應(yīng)用的前置條件是您的開發(fā)者注冊QQ賬號同時為代理商、廣告主、商務(wù)管家等身份的開戶QQ),則界面會顯示相應(yīng)的創(chuàng)建入口如下圖:
Step 2:點擊“創(chuàng)建新應(yīng)用”進(jìn)入創(chuàng)建應(yīng)用程序界面,填寫應(yīng)用名稱、應(yīng)用介紹信息等。請注意,私有應(yīng)用需要填寫的內(nèi)容比第三方應(yīng)用少,但僅可管理該QQ號對應(yīng)的廣告賬號。
2.單擊+新建應(yīng)用程序以創(chuàng)建新應(yīng)用程序。
Step 3:您可根據(jù)使用需要選擇對應(yīng)的權(quán)限組分類,權(quán)限組分類的詳細(xì)介紹可通過權(quán)限等級進(jìn)一步了解 – 創(chuàng)建后,私有應(yīng)用自動審核通過,您可以立即開始相關(guān)能力的搭建。第三方應(yīng)用則會在2-3個工作日內(nèi)進(jìn)行審核。
Token是在Marketing API操作指定賬號的身份憑證,當(dāng)您需要操作特定廣告賬號時,您需要使用該廣告賬號對您的開發(fā)者應(yīng)用進(jìn)行授權(quán),以獲取access_token和refresh_token,所有接口均通過請求參數(shù)中傳遞的 access_token(授權(quán)令牌)來進(jìn)行身份認(rèn)證和鑒權(quán),系統(tǒng)會在校驗 access_token有效、接口調(diào)用配額未用完、接口調(diào)用頻次未超限3個條件符合后接受此次請求進(jìn)行具體業(yè)務(wù)處理并做出響應(yīng)。
Marketing API目前支持代理商/商務(wù)管家/廣告主等賬號類型進(jìn)行授權(quán)鑒權(quán)。
本節(jié)將為您介紹如何進(jìn)行 Marketing API 的授權(quán)認(rèn)證 。
該環(huán)節(jié)您可以獲取指定賬號的access_token和refresh_token,其中:
進(jìn)入應(yīng)用詳情界面
1. 首先選擇您要操作的賬戶身份:如廣告主、服務(wù)商、商務(wù)管家、T1等(因同一個QQ可以同時具有多個身份,不同的身份的token是不同的)。
2. 點擊“獲取或重置”即可獲取或者重置您的token
客戶需要通過您的應(yīng)用進(jìn)行推廣操作時,您的應(yīng)用需要先引導(dǎo)客戶完成至少一次 OAuth 2.0 認(rèn)證操作,以便獲得調(diào)用接口操作的客戶的推廣帳號所必須的 access_token 。Marketing API的 OAuth 2.0 遵循業(yè)界通用的規(guī)范和流程,完成 OAuth 2.0 認(rèn)證(當(dāng)前只支持 server-side 模式)需要完成以下步驟:
詳細(xì)描述如下:
Step 1:引導(dǎo)客戶完成OAuth 2.0認(rèn)證獲得authorization_code,獲得 authorization_code 需要引導(dǎo)客戶完成 OAuth 2.0 的認(rèn)證。調(diào)用 OAuth 2.0 授權(quán)頁面的URL形如:https://developers.e.qq.com/oauth/authorize?client_id=123456&redirect_uri=https%3a%2f%2fwww.example.com%3fpara1%3da%26para2%3db&state=&scope=ads_management&account_type=ACCOUNT_TYPE_QQ
。其中:
賬戶分類 | 支持角色 | 可管理的賬戶范圍 |
---|---|---|
商務(wù)管家賬號 | 超級管理員(開戶qq/微信) | 該商務(wù)管家及其認(rèn)領(lǐng)的所有賬戶 |
代理商主體賬號 | 代理商超級管理員(開戶qq/微信) | 當(dāng)前代理商主體下所有代理商和所有代理子客戶 |
代理商帳號 | 代理商超級管理員(開戶qq/微信) | 當(dāng)前代理商及所有代理子客戶 |
代理商帳號 | 代理商管理員/子賬號管理員/運營人員 | 該員工有權(quán)管理的所有代理商子客 |
代理商帳號 | 廣告主員工(自理投放管理員) | 該員工有權(quán)管理的所有代理商子客 |
直客廣告主賬號 | 超級管理員(開戶qq/微信) | 該廣告主賬戶 |
Step 2:使用 authorization_code 獲得 access_token 和 refresh_token。用 authorization_code 獲得 access_token 和 refresh_token 的接口地址為https://api.e.qq.com/oauth/token ,接口輸入?yún)?shù)如下表所示:
請求參數(shù):
字段名 | 類型 | 描述 |
---|---|---|
client_id | integer | 應(yīng)用 id,在開發(fā)者官網(wǎng)創(chuàng)建應(yīng)用后獲得,可通過?應(yīng)用程序管理頁面?查看 |
client_secret | string | 應(yīng)用 secret,在開發(fā)者官網(wǎng)創(chuàng)建應(yīng)用后獲得,可通過?應(yīng)用程序管理頁面?查看 字段長度最小 1 字節(jié),長度最大 256 字節(jié) |
grant_type | string | 請求的類型,可選值: authorization_code (授權(quán)碼方式獲取 token )、 refresh_token (刷新 token ) 字段長度最小 1 字節(jié),長度最大 64 字節(jié) |
authorization_code | string | OAuth 認(rèn)證 code,可通過獲取 Authorization Code 接口獲取,當(dāng) grant_type=authorization_code 時必填 字段長度最小 1 字節(jié),長度最大 64 字節(jié) |
refresh_token | string | 應(yīng)用 refresh token,當(dāng) grant_type=refresh_token 時必填 字段長度最小 1 字節(jié),長度最大 256 字節(jié) |
redirect_uri | string | 應(yīng)用回調(diào)地址,當(dāng) grant_type=authorization_code 時, redirect_uri 為必傳參數(shù),僅支持 http 和 https,不支持指定端口號,且傳入的地址需要與獲取 authorization_code 時,傳入的回調(diào)地址保持一致 字段長度最小 1 字節(jié),長度最大 1024 字節(jié) |
請求示例:
curl -G 'https://api.e.qq.com/oauth/token' \
-d 'client_id=<CLIENT_ID>' \
-d 'client_secret=<CLIENT_SECRET>' \
-d 'grant_type=authorization_code' \
-d 'authorization_code=<AUTHORIZATION_CODE>' \
-d 'redirect_uri=https://www.example.com'
返回示例:
{
code: 0,
message: ,
data: {
access_token: 228bd56b7ee039540953352f766b40d31651487e,
refresh_token: 854e744a1f4c6fc20f498e366b9aabd2c4b971fd,
access_token_expires_in: 86400,
refresh_token_expires_in: 2592000
}
}
獲得 access_token 后,您可用此調(diào)用接口對相關(guān)的推廣帳號進(jìn)行操作,如果發(fā)起Marketing API請求可通過發(fā)起請求章節(jié)進(jìn)行了解。
值得注意的是,一旦 access_token 失效,您將無法調(diào)用接口。access_token 和 refresh_token 的有效期可以通過 oauth/token 接口的返回字段獲取,默認(rèn)情況下 access_token 和 refresh_token 的有效期如下:
API請求中需要提供必要的通用參數(shù)、每個接口要求的參數(shù),并聲明正確的編碼方式。以curl發(fā)起請求獲取和創(chuàng)建一個推廣計劃為例。 獲取一個推廣計劃:
curl 'https://api.e.qq.com/v1.1/campaigns/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=51959'
-d 'fields=[campaign_id,campaign_name,campaign_type, daily_budget]'
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
<
{
code:0,
message:,
data:
{
list:[
{
campaign_id:12345,
campaign_name:推廣計劃1,
campaign_type:CAMPAIGN_TYPE_NORMAL,
daily_budget:1000000
},
{
campaign_id:12346,
campaign_name:推廣計劃2,
campaign_type:CAMPAIGN_TYPE_NORMAL,
daily_budget:10000
},
page_info:{
page:1,
page_size:2,
total_number:2,
total_page:1
}
}
}
創(chuàng)建一個推廣計劃:
curl 'https://api.e.qq.com/v1.1/campaigns/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
account_id: 51959,
campaign_name: test,
campaign_type: CAMPAIGN_TYPE_NORMAL,
daily_budget: 10000,
promoted_object_type,PROMOTED_OBJECT_TYPE_APP_IOS
}'
* Connected to api.e.qq.com (10.10.10.10) port 443 (#0)
> POST / HTTP/1.1
> User-Agent: curl/7.41.0
> Host: api.e.qq.com
> Content-Type: application/json
> Content-Length: 64
* upload completely sent off: 64 out of 64 bytes
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
<
{
code:0,
message:,
data:
{
campaign_id:23456
}
}
Q:如何找到騰訊廣告開放平臺
A:冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺,專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’騰訊廣告開放平臺‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q:開發(fā)者官網(wǎng)的應(yīng)用程序與推廣的應(yīng)用程序有什么關(guān)系?
A:開發(fā)者官網(wǎng)的應(yīng)用程序是指基于Marketing API開發(fā)的應(yīng)用,比如管理廣告的投放平臺、廣告數(shù)據(jù)分析工具、自動化營銷的腳本等等,而推廣的應(yīng)用程序是指廣告主推廣的目標(biāo)應(yīng)用。兩者之前并無任何關(guān)聯(lián)。
Q:我需要為多個應(yīng)用上報行為數(shù)據(jù),需要分別創(chuàng)建應(yīng)用程序么?
A:不需要。您只需創(chuàng)建一個應(yīng)用程序,并申請數(shù)據(jù)上報的權(quán)限即可。一個應(yīng)用可以獲得多個推廣帳號的授權(quán),從而幫多個推廣帳號上報數(shù)據(jù)。
Q:應(yīng)用程序?qū)徍送ㄟ^后,是否就可以操作推廣帳號了?
A:應(yīng)用程序的審核是指給應(yīng)用程序分配相應(yīng)的接口權(quán)限,但是應(yīng)用程序能操作哪些推廣帳號,需要通過OAuth 2.0向指定的推廣帳號發(fā)起授權(quán)申請,當(dāng)指定的推廣帳號同意授權(quán)后,應(yīng)用程序即可調(diào)用接口對該帳號進(jìn)行操作。
Q:點擊“同意授權(quán)”后報錯5014,提示“當(dāng)前登錄的帳號無可授權(quán)的廣告主身份”?
A:代理商、直客、商務(wù)管家賬戶需要使用開戶QQ登錄授權(quán);代理商子客,需要有自理類管理員權(quán)限的QQ號登錄授權(quán)。
Q:開發(fā)者應(yīng)用權(quán)限配置后,為什么接口調(diào)用依然報錯無權(quán)限?
A:作為開發(fā)者,您雖然已經(jīng)擁有了權(quán)限,但是還需要廣告主給您授予相應(yīng)的操作廣告主的權(quán)限,權(quán)限變更后,請重新操作授權(quán)認(rèn)證流程,具體參考快速入門
除了騰訊廣告開放平臺,還有其他替代服務(wù)商也提供類似api服務(wù),例如:
Sleazy Fork API開放平臺、Android-Hilfe API開放平臺、Art19 API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q:騰訊廣告開放平臺這個密鑰還適用于哪些api?
添加騰訊廣告服務(wù)商子客、查詢騰訊廣告廣告主信息、獲取廣告主資質(zhì)
本文提供了一份詳盡且實用的“如何獲取騰訊廣告開放平臺訪問密鑰分步指南”,旨在幫助開發(fā)者們輕松掌握獲取訪問密鑰的全過程。從注冊騰訊廣告開放平臺賬號,到完成開發(fā)者身份認(rèn)證,再到最終成功獲取訪問密鑰,每一步操作都配以詳盡的說明和指導(dǎo),確保開發(fā)者能夠順利、準(zhǔn)確地完成流程。在獲取密鑰后,本文還強(qiáng)調(diào)了進(jìn)行可用性測試的重要性,以確保騰訊廣告開放平臺的各項功能能夠順利集成到應(yīng)用中,并發(fā)揮最佳效果。這不僅有助于提升應(yīng)用的性能和用戶體驗,還能確保開發(fā)者在數(shù)字營銷領(lǐng)域取得更大的成功。本文為開發(fā)者們提供了一個全面、詳盡且實用的指南,旨在幫助他們順利獲取騰訊廣告開放平臺的訪問密鑰,并有效利用這一平臺資源,為項目或應(yīng)用提供強(qiáng)大的數(shù)據(jù)支持,從而在激烈的市場競爭中脫穎而出。