廣告服務(Ads Kit)提供流量變現服務,通過該服務開發者可以在自己的App中向用戶展示Banner、原生、激勵廣告等多種形式的廣告內容。而對於應用中已上線的廣告位來說,因為涉及到收入,所以日常的數據監控顯得尤為重要。 為此廣告服務也提供了流量變現服務報表API(Publisher Service ...
廣告服務(Ads Kit)提供流量變現服務,通過該服務開發者可以在自己的App中向用戶展示Banner、原生、激勵廣告等多種形式的廣告內容。而對於應用中已上線的廣告位來說,因為涉及到收入,所以日常的數據監控顯得尤為重要。
為此廣告服務也提供了流量變現服務報表API(Publisher Service Reporting API),通過接入該API,開發者可以獲取應用內廣告變現相關數據,包括廣告請求量、返回量、展示率、點擊率等,讓開發者可以依據數據對廣告效果進行分析,從而及時調整投放策略。
開發者可根據返回的數據實現自己的報表展示效果
那麼如何獲取流量變現數據呢?以下是具體的集成步驟。
一.獲取客戶端ID和密鑰
在獲取變現數據前,我們要先有OAuth 2.0 客戶端ID和密鑰,用於生成調用報表API時傳入的access_token,需要註意的是此處的客戶端ID和密鑰並不是指APPGallery Connect中應用的ClientID,而是通過在華為開發者聯盟->憑證中創建的伺服器應用的客戶端ID。
- 註冊成為開發者,完成實名認證。登錄華為開發者聯盟,點擊右上角“管理中心”進入主頁面。
- 進入“憑證”頁面,創建項目,如果已有項目請跳過【步驟a】。
a. 選擇“憑證”,根據下圖標記順序填入“項目名稱”和“項目別名”新建項目。
b. 選中創建的項目,點擊“確定”。
- 選擇“OAuth 2.0 客戶端 ID”創建客戶端ID。
說明:
如果項目下已經存在“OAuth 2.0 客戶端 ID”憑證,需要檢查產品類型是否為伺服器應用,如果是伺服器應用可以跳過【步驟4】。
檢查方式:點擊操作一欄下的“編輯”按鈕,查看“產品類型”。
如果不是“伺服器應用”類型,需要重新創建“OAuth 2.0 客戶端 ID”:
- 選擇“伺服器應用”,輸入“產品名稱”,選擇“應用類型”和“預設語言”,點擊“創建”;提示“客戶端ID”和“密鑰”,點擊“確定”。
- 進入“我的API”頁面,確認選中的項目,點擊“申請新的HMS API服務”。
- 下拉找到“App Services”,點擊“流量變現服務報表API”。
- 點擊“啟用”,開啟流量變現服務報表API,之後就可以調用流量變現報表API了
在“停用”後,再次“啟用”時,由於頁面緩存等原因,生效時間是非實時生效的,需要等待大概6~10分鐘。如果10分鐘後沒有生效,請重新進行嘗試。
二.調用流量變現報表API
- 在調用流量變現報表API前需要先獲取access_token鑒權信息。
調用介面:
POSThttps://oauth-login.cloud.huawei.com/oauth2/v3/token
請求示例:
POST /oauth2/v3/token HTTP/1.1
Host: oauth-login.cloud.huawei.com
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&
client_id=<客戶端ID >&
client_secret=<客戶端密鑰>
```
請求示例截圖:
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095223768-601184076.png)
需要註意的是,客戶端ID和密鑰,是在開發者聯盟界面獲取的伺服器應用的客戶端ID和密鑰,而不是在APPGallery Connect中創建的移動應用的客戶端ID和密鑰。
2. 拿到access_token鑒權信息後,調用報表API。
調用介面:
POST https://ads.cloud.huawei.com/openapi/monetization/reports/v1/publisher
俄羅斯站點需要調用以下介面:
POST https://ads-drru.cloud.huawei.ru/openapi/monetization/reports/v1/publisher
請求示例:
POST /openapi/monetization/reports/v1/publisher HTTP/1.1
Content-Type: application/json
Authorization: Bearer ***
Accept: application/json
Content-Length: 233
{
"start_date": "2022-06-01",
"end_date": "2022-06-28",
"filtering": {
"currency": "CNY"
},
"time_granularity": "STAT_TIME_GRANULARITY_DAILY",
"page": 1,
"page_size": 10
}
請求示例截圖:
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095224240-1997205441.png)
從截圖中可以看到,數據已成功返回。具體請求參數,和響應參數可以參考[文檔鏈接 ](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/query-publisher-service-reports-0000001050933546#section20939514163519?ha_source=hms1)
調用API獲取變現報表數據後,開發者可以根據自己的需求去實現數據的展現形式。
### 三.接入流量變現報表時的常見問題
**調用流量變現服務報表API時返回access forbidden?**
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095224639-1429524542.png)
原因分析:
1. 在開發者聯盟界面“API”欄目中沒有開啟對應項目的流量變現報表API開關。
2. 流量報表API開關“啟用”後,還沒有等到許可權生效,就調用報表API介面。
3. 獲取access_token鑒權信息時,傳入的客戶端ID和密鑰,不是開發者聯盟界面“憑證”中伺服器應用的ID和密鑰。
**解決方法:**
1. 開啟流量報表API開關,在開發者聯盟界面->我的API->選擇對應的項目->點擊“申請新的HMS API服務”,找到“流量變現服務報表API” 許可權,點擊“啟用”。
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095225022-9483682.png)
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095225415-1778789825.png)
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095225808-452279312.png)
2. 流量報表API開關“停用”後,再次“啟用”時,並非實時生效,需要等待大概6~10分鐘。
3. 檢查獲取access_token鑒權信息時,傳入的客戶端ID是否是伺服器應用的。在開發者聯盟界面->憑證->找到對應的項目->點擊項目下應用的編輯按鈕,即可在產品類型一行看到應用類型。如果不是伺服器應用,請更換伺服器應用的客戶端ID和密鑰後重試。
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095226250-388435331.png)
![](https://img2022.cnblogs.com/other/2396482/202207/2396482-20220725095226640-867093597.png)
**瞭解更多詳情>>**
訪問[廣告服務官網](https://developer.huawei.com/consumer/cn/hms/huawei-adskit?ha_source=hms1)
訪問[華為開發者聯盟官網](http://developer.huawei.com/consumer/cn/hms?ha_source=hms1)
獲取[開髮指導文檔](http://developer.huawei.com/consumer/cn/doc/development?ha_source=hms1)
華為移動服務開源倉庫地址:[GitHub](http://github.com/HMS-Core)、[Gitee](http://gitee.com/hms-core)
**關註我們,第一時間瞭解 HMS Core 最新技術資訊~**