您的第一個應用程式:必要條件

開始設定第一個用戶端應用程式之前,請先完成下列事項 (如果還沒有的話)。

建立 Google 帳戶並取得 Search Ads 360 權限

如要使用 Search Ads 360 API,您必須具備 Google 帳戶,並從 Search Ads 360 授予該帳戶的適當權限:

  1. 如果您還沒有 Google 帳戶,請先建立帳戶

  2. 要求 Search Ads 360 代理商管理員為您的 Google 帳戶建立 Search Ads 360 使用者

    如要下載報表,您必須針對您要合作的廣告客戶具備查看權限

    您必須具備合作廣告客戶的廣告客戶,具備編輯權限,才能新增或編輯轉換。在共用的 Floodlight 設定中,您必須針對要上傳轉換資料的每個下層廣告客戶取得編輯權限。 您不需要具備上層廣告客戶的存取權,也不需要未將轉換上傳到其下層的下層廣告客戶的存取權。如果您使用點擊 ID 將轉換歸因於造訪,請務必取得產生該點擊 ID 的廣告客戶編輯權限。如果您指定的點擊 ID 來自無權編輯的廣告客戶,則請求會失敗。

    代理商管理員可以將帳戶設為具備特定廣告客戶存取權的廣告客戶使用者,或是具有更高層級的存取權 (例如具備代理商所有廣告客戶存取權的代理商使用者)。

啟用 API 轉換服務

如果您想上傳轉換資料,具有代理商管理員權限的 Search Ads 360 使用者必須登入 Search Ads 360 UI,然後啟用 API 轉換服務。如需操作說明,請參閱 Search Ads 360 說明中心

為用戶端建立 Google API 控制台專案和 OAuth 憑證

  1. 啟動 Google API 控制台設定工具
    設定工具會引導您建立專案 (或使用現有專案)、啟用 Search Ads 360 API,以及建立 OAuth 2.0 憑證。
  2. 在「註冊應用程式」頁面上,選取現有專案或選取 [建立專案]。然後點選 [繼續]
  3. Google API 控制台啟用 Search Ads 360 API 後,按一下 [前往憑證] 按鈕。
  4. 在「Create credentials」(建立憑證) 頁面中輸入以下資訊:
    • 您目前使用的是哪個 API?:Search Ads 360 API
    • 您將存取哪些資料?:使用者資料
  5. 按一下「Next」按鈕。

    設定工具現在可協助您建立 OAuth 2.0 用戶端 ID

  6. 按照設定工具的其餘步驟進行。

安裝 sa360Api.py

Search Ads 360 提供公用程式指令碼,可協助設定授權程序。如果您想要在設計及撰寫完整應用程式前嘗試傳送和接收資料,也可以使用這個指令碼來傳送及接收 JSON 格式的資料。您可以複製這個說明文件網站上的許多 JSON 範例,然後直接輸入到指令碼中。

安裝指令碼的步驟如下:

  1. 安裝 Python 2.7。
    指令碼不支援 Python 3.x。
  2. 安裝 cURL
  3. 下載 sa360Api.zip
  4. sa360Api.zip 中擷取 sa360Api.py
  5. sa360Api.py 設為執行檔。

瞭解 REST 的基本概念

您可以透過下列兩種方式叫用 API:

如果您決定不要使用用戶端程式庫,就必須瞭解 REST 的基本概念。

REST 是一種軟體架構,可提供簡便且一致的資料要求及修改方法。

REST 為 Representational State Transfer (具象狀態傳輸) 的簡稱。在 Google 的 API 中,這是指使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。

在符合 REST 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。

在 Google 的 RESTful API 中,用戶端會使用 HTTP 動詞指定動作,例如 POSTGETPUTDELETE。並由下列格式的全域唯一 URI 指定資源:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由於所有 API 資源都有可供 HTTP 存取的專屬 URI,因此 REST 不僅能夠支援資料快取,也非常適合與網路的分散式基礎架構搭配運作。

HTTP 1.1 標準說明文件中的方法定義可能非常實用;其中包含 GETPOSTPUTDELETE 的規格。

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 物件標記法) 是一種常見的語言專用資料格式,可透過簡單的文字表示任意資料結構。詳情請參閱 json.org