使用指南

本頁詳細說明如何使用 API 執行常見工作。

建立使用者

UserService 可讓 具備管理員權限的使用者可建立 使用者。任何開發人員都能執行這項操作 讓新使用者先註冊舉例來說,如果您想 當使用者第一次執行 API 呼叫時 (預設值是 電子郵件地址),建議您建立一些具備角色權限的使用者,例如 銷售專員、廣告投放專員或廣告客戶,用於測試真實工作流程。

  1. 建立新的 Gmail 地址,例如 my.name.salesperson@gmail.com。另外 將現有的非 Gmail 地址註冊為新 Google 帳戶
  2. 使用新地址和所選的 Role 呼叫 createUsers
  3. 您可以使用 OAuth 2.0 產生存取權杖,以新使用者的身分進行驗證。

取得根廣告單元

可新增子節點的頂層 AdUnit 和階層深度取決於您的帳戶類型 (小型商家或 Premium)。支援修改其子節點的最頂層 AdUnit 稱為有效的根 AdUnit

如要擷取有效的根,請呼叫 NetworkService.getCurrentNetwork(),然後檢查回傳 Network 物件的 effectiveRootAdUnitId 欄位。

注意:不同的帳戶類型支援不同的階層模式。

查詢物件

您可以使用 getObjectsByStatement() 方法,透過搜尋條件搜尋物件 許多服務公開,其中 Object 是特定的物件類型。這個 方法會使用 PQL 查詢,這與 SQL 查詢類似,差別在於前者可讓您指定 要搜尋的欄位 (欄位名稱對應至物件屬性)、排序, 並偏移您的搜尋結果詳情請參閱 PQL 指南,進一步瞭解 PQL,以及瞭解有哪些物件欄位可以 篩選依據。

建立訂單

如要建立訂單,只要建立 Order 物件並設定廣告客戶即可 為適當的使用者指派專屬名稱 並呼叫 createOrders()。結果會包含新建立的 Order、 或是發生錯誤

範例

請參閱「用於建立訂單的 Java 程式碼」範例。

建立委刊項

建立新委刊項的步驟如下:

  1. 建立新的 Order 物件或使用現有物件。
  2. 建立新的 LineItem 物件,並設定輪播類型、廣告素材大小陣列。 開始日期、結束日期和其他屬性
  3. 建立新的 InventoryTargeting 物件,然後指定要指定或排除的 PlacementAdUnit 物件。
  4. InventoryTargeting 物件納入新的 Targeting 物件中,然後指派 將其加入「LineItem」的指定資源中。
  5. 使用新物件呼叫委刊項服務方法 createLineItems(),然後檢查結果,確認物件是否已建立。

範例

請參閱建立委刊項的 Java 程式碼範例。

製作廣告素材

不同類型的廣告素材支援不同的元件,例如圖片 廣告素材支援單一圖片來源檔案;Flash 廣告素材支援 兩個基礎素材資源檔案:一個 Flash 檔案和一個備用圖片檔案; 則無法放送對於第三方網站代管的廣告素材,請將 只參照第三方伺服器上檔案的 HTML 程式碼片段。查看 特定的 Creative 子類別,瞭解您必須上傳哪些資產 建立廣告素材

範例

請參閱用於建立圖片廣告素材的 Java 程式碼範例。

修改現有物件

如要修改現有物件,請呼叫 getObjectsByStatement() 來查詢物件, 更新傳回物件中的值,然後呼叫 updateObjects()

注意:更新後的物件會完全取代現有物件,因此您 無需在傳送的物件中設定屬性值,儲存的物件將 取得該屬性的預設值,而非先前的值。

變更物件狀態

呼叫 performObjectAction() 方法即可變更物件狀態 暴露在風險中。這個方法使用兩個參數:

  • 動作物件的執行個體,用於說明您要完成的工作。適用對象 執行個體,訂單服務會公開數個動作,包括 ApproveOrdersPauseOrders、 和 ArchiveOrders。動作物件全都衍生自基本動作 適合服務的類別。
  • 描述要變更哪些物件的 PQL 查詢。您可以 方法是指定適當的 PQL 維持狀態 聲明。

產生廣告代碼

您無法使用 API 產生廣告代碼;您必須前往 Google Ad Manager 網站詳情請參閱廣告代碼 說明中心的「 瞭解詳情

更多範例

您可以在我們的用戶端程式庫的範例程式碼中找到更多範例 提供的不同程式設計語言詳情請參閱用戶端程式庫與範例程式碼 」頁面,取得程式設計語言範例的連結。