背景

事前準備

  1. 請您的帳戶代表設定您應用程式要存取帳戶的適當權限。
  2. 如果不熟悉 Authorized Buyers 的概念，請前往 Authorized Buyers 說明中心，嘗試看看使用者介面。 如果您的應用程式預期將會執行即時出價，請參閱 RTB 通訊協定說明文件。
  3. 請前往 API 控制台設定新專案。登入開發人員 Google 帳戶，或是建立帳戶。接著，系統會提示您建立專案並簽署幾項《服務條款》。

上層帳戶和子帳戶

如果您處理的是含有上層和子帳戶的帳戶結構，那麼瞭解這些項目互動的方式或許就能更有效率。以下簡要說明：

子帳戶

具備憑證存取權的使用者只能查看及修改與其帳戶相關聯的資源。子帳戶無法查看或修改其他子項或上層帳戶的資源。

上層帳戶

如果使用者擁有的憑證將存取權授予上層帳戶，則除了所有相關聯的子帳戶外，還能查看及修改上層帳戶的資源。如果是列出所有特定資源的作業，此使用者會收到回應，當中包含其帳戶和所有子帳戶的資料。請注意，如果是其他類型的要求，指定子項帳戶的資源，上層帳戶就必須為子帳戶指定 accountId 路徑參數，而不是自己的 accountId。

REST API 資料模型

資源是具有專屬 ID 的個別資料實體。「帳戶」資源代表 Authorized Buyers 帳戶項目，同時也是 Ad Exchange Buyer API 的根資料類別。API 方法會根據個別的帳戶資源與帳戶資源集合運作。

帳戶資源包括帳戶 ID、Cookie 比對功能使用的資訊、出價工具位置、傳送出價要求的網址，以及用來指定 Ad Exchange 每秒傳送查詢數上限的請求。

除了帳戶資源和集合，Ad Exchange Buyer API 還定義下列資料結構：

出價方位置

出價工具位置是與 Account 資源一併傳回的結構，目的在於提供廣告交易平台應傳送出價要求的網址，以及廣告交易平台應傳送的每秒查詢數量上限。以下是出價工具位置的範例，以 JSON 表示：

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

項目

項目會提供帳戶清單。以下是項目範例，以 JSON 表示： 

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

支援作業

您可以依照下表所述，在 Ad Exchange Buyer API 中對集合和資源叫用三種不同的方法。所有作業都需要授權。

作業 說明 REST HTTP 對應
list 列出目前已驗證使用者可存取的所有帳戶。 集合 URI 上的 GET。
取得 取得特定的帳戶資源。 資源 URI 上的 GET。
更新 更新特定的帳戶資源。 資源 URI 上的 PUT，您會傳入已更新資源的資料。

通話方式

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

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

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

在 Google 的 REST 樣式 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 的規格。

Ad Exchange Buyer API 中的 REST

支援的作業直接對應於 REST HTTP 動詞，如 API 作業一節所述。

API URI 的專用格式為：

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

其中 resourceID 是「Accounts」資源的 ID，而 parameters 是套用至該查詢的任何參數。詳情請參閱標準查詢參數和參考說明文件。

resourceID 路徑擴充功能的格式可讓您識別目前在操作的資源，例如：

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

如需 API 中各支援作業使用的完整 URI 組合摘要，請參閱參考說明文件。

以下是在 Ad Exchange Buyer API 中運作的範例。

取得已驗證使用者的帳戶清單：

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

資料格式

JSON

JSON (JavaScript Object Notation) 是一種與語言無關的常用資料格式，可透過簡單的文字方式來呈現任意資料結構。詳情請參閱 json.org。