本文件適用於想要透過 AdSense Management API 取得 AdSense 帳戶相關資訊的開發人員,本文假設您熟悉網路程式設計概念和網路資料格式。
事前準備
取得 AdSense 帳戶
註冊或登入 AdSense 帳戶即可開始體驗。
熟悉 AdSense
如果您還不熟悉 AdSense 概念,請參閱 AdSense 簡介資訊並測試 AdSense UI,然後再開始寫程式。
選擇您的用戶端程式庫
您可以在用戶端程式庫與範例頁面中找到可用程式庫與範例的相關資訊。按一下所選語言的分頁標籤,點選連結即可下載來源。用戶端程式庫會為您處理下列項目:
- 驗證
- 發現服務
- 為 API 建立請求
- 回應剖析
請參閱安裝及設定所選用戶端程式庫的操作說明,通常位於存放區根目錄的 README 檔案中。
如果您的實作有特殊需求 (例如使用不支援的語言),您可以向 API 直接發出要求,而非使用用戶端程式庫。
註冊應用程式
若要使用 AdSense Management API,您必須建立專案並產生用戶端 ID,以註冊您正在開發的應用程式。
註冊應用程式使用您剛建立的新憑證,編輯用戶端程式庫專案的設定檔。詳情請參閱用戶端程式庫說明文件。
注意:註冊時使用的 Google 帳戶應為您的「開發人員」帳戶,也就是您希望應用程式使用者顯示為應用程式開發人員的帳戶。這個帳戶不需要與 AdSense 登入資訊連結,因為使用者會在使用應用程式時授予自身帳戶的存取權。
快速入門教學課程
請按照下列步驟提出第一個要求,請注意,視您使用的程式庫或語言而定,這些步驟可能略有不同:
- 請使用適當的範例,從 AdSense 帳戶擷取廣告用戶端清單。這項要求會啟動一次性的程序,由 AdSense 使用者驗證並授權您的專案。
廣告用戶端代表 AdSense 帳戶與 AdSense 產品之間的關聯,例如多媒體廣告或搜尋廣告。AdSense 帳戶可以有一個或多個廣告用戶端。
- 如果是網頁應用程式,系統會將使用者重新導向至可供他們選擇授予存取權的網站。取得授權後,系統會將其重新導向至 Google API 控制台中定義的回呼網址。
- 已安裝的應用程式以類似的方式運作。用戶端程式庫會嘗試開啟瀏覽器視窗,並使用授權碼。在 Android、Chrome 和 iOS 應用程式上,這種做法適用於特定平台。
- 使用
reports.generate
的 Google API 多層檢視提出下列報表要求:date_range: YESTERDAY
dimensions: DATE
metrics: ESTIMATED_EARNINGS
報表可讓您查看收益資料,以及這些收益的影響因素。使用管道,您就能針對整個帳戶或一小部分的廣告單元執行報表。
- 試著在應用程式中請求相同的報表。
- 您可以按廣告單元篩選報表。使用
adunits.list
擷取廣告單元清單。請注意,您必須使用廣告用戶端 ID (從步驟 1 取得)。選擇廣告單元後,請在reports.generate
的 filter 參數中使用其 ID:廣告單元是指使用者為廣告設定的預留位置,其定義了顯示廣告的部分屬性 (如大小與形狀)。
date_range: YESTERDAY
dimensions: DATE
metrics: ESTIMATED_EARNINGS
filter: AD_UNIT_ID==ca-pub-123456789:987654321
- 請嘗試按自訂或網址管道進行篩選,或合併多個篩選條件。
您可以使用管道這項工具來追蹤一小部分廣告單元的成效,管道類型有兩種:網址和自訂。前者可讓您追蹤某個網頁或網域的成效,後者則可讓您追蹤使用者所選特定廣告單元群組的成效。
請瀏覽在參考說明文件中其他可用的呼叫和資源,即可開始實作。