開始編寫第一個用戶端應用程式之前,您必須先完成以下程序 (如果尚未完成)。
建立 Google 帳戶並取得 Search Ads 360 權限
如要使用 Search Ads 360 API,您需要有 Google 帳戶, 並授予該帳戶從 Search Ads 360 取得的適當權限:
如果您還沒有 Google 帳戶,請 建立帳戶。
請 Search Ads 360 代理商管理員為您的 Google 帳戶 建立 Search Ads 360 使用者。
如要下載報表,您必須取得合作廣告客戶的檢視權限。
如要新增或編輯轉換,您必須具備合作廣告主的編輯權限。如果是共用的 Floodlight 設定,您必須針對所有要上傳轉換資料的目標下層廣告客戶取得編輯權限。您不需具備上層廣告主的存取權,也不需要非轉換數據上傳目標的下層廣告主存取權。如果您要將轉換歸因於造訪,請確定您具備產生該點擊 ID 的廣告客戶編輯存取權。要是您指定的點擊 ID 是來自您無權編輯的廣告客戶, 就無法成功提出要求。
代理商管理員可以將您的帳戶設為廣告客戶使用者,以便存取特定廣告客戶,也可以將帳戶設為代理商使用者,以便存取代理商中的所有廣告客戶。
啟用 API 轉換服務
如果您想上傳轉換資料,具備代理商管理員權限的 Search Ads 360 使用者必須登入 Search Ads 360 UI,並啟用 API 轉換服務。如需操作說明,請參閱 Search Ads 360 說明中心。
為用戶端建立 Google API 控制台專案和 OAuth 憑證
- 啟動 Google API 控制台
設定工具。
設定工具會引導您建立專案 (或使用現有專案)、啟用 Search Ads 360 API 及建立 OAuth 2.0 憑證。 - 在「註冊應用程式」頁面上,選取現有專案或選取「建立專案」。然後按一下「繼續」。
- Google API 控制台啟用 Search Ads 360 API 之後,按一下「前往憑證」按鈕。
- 在「Create credentials」(建立憑證) 頁面中輸入下列資訊:
- 您使用的是哪個 API?:Search Ads 360 API
- 您需要存取哪些資料?:使用者資料
- 點選「Next」按鈕。
設定工具現在可協助您建立 OAuth 2.0 用戶端 ID。
- 按照設定工具中的其餘步驟操作。
安裝 sa360Api.py
Search Ads 360 提供實用程式指令碼,方便您設定授權。如要在設計及編寫完整應用程式前嘗試傳送及接收資料,您也可以使用這個指令碼來傳送及接收 JSON 格式的資料。您可以複製本說明文件網站上的許多 JSON 範例,然後直接輸入到指令碼中。
如何安裝指令碼:
- 安裝 Python 2.7。
這個指令碼不適用於 Python 3.x。 - 安裝 cURL。
- 下載 sa360Api.zip。
- 從
sa360Api.zip
擷取sa360Api.py
。 - 將
sa360Api.py
設為可執行檔。
瞭解 REST 的基本概念
您可以透過下列兩種方式叫用 API:
- 使用用戶端程式庫。
- 傳送 HTTP 要求並剖析回應。
如果您決定不使用用戶端程式庫,就必須瞭解 REST 的基本概念。
REST 是一種軟體架構,可提供簡便且一致的資料要求及修改方法。
REST 這個詞是「Representational State Transfer (表現層狀態轉換)」的簡稱。在 Google API 中,這是指使用 HTTP 動詞來擷取及修改 Google 所儲存資料的表示法。
在符合 REST 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。
在具備 REST 特性的各種 Google API 中,用戶端會使用 POST
、GET
、PUT
或 DELETE
等 HTTP 動詞來指定動作。接著,該動詞會透過全域唯一的 URI 來指定資源,格式如下:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
由於所有 API 資源都有可供 HTTP 存取的專屬 URI,因此 REST 不僅能夠支援資料快取,也非常適合與網路的分散式基礎架構搭配運作。
您可以在 HTTP 1.1 標準說明文件中找到相當實用的方法定義,其中包括 GET
、POST
、PUT
及 DELETE
的規格說明。
Search Ads 360 API 中的 REST
Search Ads 360 API 作業會直接對應至 REST HTTP 動詞。
Search Ads 360 API URI 的具體格式如下:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
如需 API 中各支援作業使用的完整 URI 組合摘要資訊,請參閱 API 參考資料。
瞭解 JSON 的基本概念
如果您使用 REST,請使用 JSON 格式建立要求主體。您可以指定回應格式為 JSON 或 CSV。
JSON (JavaScript Object Notation) 是一種常見的語言無關資料格式,可提供任意資料結構的簡單文字表示法。詳情請參閱 json.org。