事前準備
- 請帳戶代表設定帳戶的適當權限 應用程式將會存取
- 如果不熟悉 Authorized Buyers 的概念,請參閱 Authorized Buyers 說明中心和 馬上就對使用者介面進行實驗 如果您的應用程式預期會執行即時出價,請參閱 RTB 通訊協定說明文件。
- 請造訪 API 控制台 設定新專案您可以登入開發人員 Google 帳戶 建立帳戶。系統會提示您建立專案並簽署 幾項服務條款
上層帳戶和孩童帳戶
如果您使用的是包含上層和子帳戶的帳戶結構 只要您瞭解這些帳戶 互動。以下是簡短摘要:
兒童帳戶
擁有憑證授予孩童帳戶存取權的使用者只能 查看及修改與其帳戶相關聯的資源。孩童帳戶無法操作 查看或修改屬於其他子項或上層帳戶的資源。
上層帳戶
擁有憑證授予上層帳戶存取權的使用者才能查看
並修改父項帳戶的資源
。針對列出指定資源的所有作業,這位使用者
您會收到回應,內含其帳戶和所有
。請注意,在其他類型的要求中,為子買方指定資源時,
上層帳戶必須為子項指定 accountId
路徑參數
而非他們自己的 accountId
。
REST API 資料模型
資源是具有專屬 ID 的個別資料實體。 帳戶資源代表 Authorized Buyers 帳戶,也是根 Ad Exchange Buyer API 的資料類別。API 的方法會針對個別 帳戶資源和帳戶資源集合。
Google 帳戶 資源包括:帳戶編號、Cookie 比對所用的資訊、 出價工具位置、傳送出價要求的網址,以及請求 指定廣告交易平台傳送的每秒查詢數量上限。
除了帳戶資源和集合外,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 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。
在具備 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
的規格。
在 Ad Exchange Buyer API 中使用 REST
受支援的操作直接對應於 REST HTTP 動詞,如 API 作業。
API URI 的專用格式如下:
https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters
其中 resourceID
是
帳戶資源和 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。