本頁面將詳細說明如何使用 API 執行常見工作。
建立使用者
UserService 可讓具有管理員權限的使用者直接在自己的網路中建立使用者。任何開發人員都能不需要讓新使用者先註冊,就能執行這項操作。例如,若您首次試用 API,而不是每次以管理員身分執行 API 呼叫 (您的電子郵件地址預設值),我們建議您建立幾位具有銷售專員、廣告投放專員或廣告主等角色的使用者,以便測試實際工作流程。
- 建立新的 Gmail 地址,例如
my.name.dfp.salesperson@gmail.com
。或者,您也可以將現有的非 Gmail 地址註冊為新的 Google 帳戶。 - 使用新地址和所選的
Role
呼叫createUsers
。 - 您可以使用 OAuth 2.0 產生存取權杖,以新使用者的身份進行驗證。
取得根廣告單元
取決於您的帳戶類型 (小型企業或進階),可新增子節點最頂端的 AdUnit
。支援修改子節點的最頂層 AdUnit
,稱為有效的根層級 AdUnit
。
如要擷取有效的根層級,請呼叫 NetworkService.getCurrentNetwork()
,然後檢查傳回的 Network
物件中的 effectiveRootAdUnitId
欄位。
注意:不同帳戶類型支援不同的階層模式。
查詢物件
您可以使用由多項服務公開的 getObjectsByStatement()
方法,透過搜尋條件搜尋物件,其中 Object 是特定物件類型。這個方法採用 PQL 查詢,這項查詢與 SQL 查詢類似,可讓您指定要搜尋的欄位 (欄位名稱對應至物件屬性)、排序、限制及偏移搜尋結果。如要進一步瞭解 PQL 指南,以及可用哪些物件欄位進行篩選,請參閱 PQL 指南。
建立訂單
如要建立訂單,只要建立 Order
物件,並將廣告主、銷售專員和廣告投放專員 ID 設為適當的使用者,接著指派專屬名稱,並呼叫 createOrders()
即可。結果將包含新建立的 Order
,或是錯誤。
範例
請參閱建立訂單的 Java 程式碼範例。
建立委刊項
以下是建立新委刊項的步驟:
- 建立新的
Order
物件或使用現有物件。 - 建立新的
LineItem
物件,然後設定輪播類型、廣告素材大小陣列、開始與結束日期和其他屬性。 - 建立新的
InventoryTargeting
物件,然後指定要指定或排除的Placement
或AdUnit
物件。 - 將
InventoryTargeting
物件納入新的Targeting
物件,然後指派給LineItem
的指定目標屬性。 - 使用新物件呼叫委刊項服務方法
createLineItems()
,然後檢查結果來確認物件是否已建立。
範例
請參閱建立委刊項的 Java 程式碼範例。
建立廣告素材
不同類型的廣告素材類型支援不同的元件:舉例來說,圖片廣告素材
支援單一圖片來源檔案;Flash 廣告素材支援兩種基礎素材資源檔案:Flash 檔案和備用圖片檔案,以便在無法放送 Flash 檔案時使用。針對第三方網站代管的廣告素材,您只能上傳
參照第三方伺服器上檔案的 HTML 程式碼片段。請查看特定的 Creative
子類別,瞭解必須上傳哪些素材資源,才能建立廣告素材。
範例
請參閱建立圖片廣告素材的 Java 程式碼範例。
修改現有物件
如要修改現有物件,請呼叫 getObjectsByStatement()
來查詢物件,更新傳回物件中的值,然後呼叫 updateObjects()
。
注意:更新後的物件將完全取代現有物件,因此如果您不在傳送的物件中設定屬性值,儲存的物件將取得該屬性的預設值,而非之前的值。
變更物件狀態
只要呼叫服務公開的 performObjectAction()
方法,即可變更物件狀態。這個方法使用兩個參數:
- 用來說明所需操作的動作物件例項。舉例來說,訂單服務會顯示數個動作,包括
ApproveOrders
、PauseOrders
和ArchiveOrders
。動作物件全都衍生自服務適用的基本動作類別。 - 說明要變更哪些物件的 PQL 查詢。您可以指定適當的 PQL 陳述式,一次變更一或多個物件的狀態。
產生廣告代碼
您無法使用 API 產生廣告代碼,必須改用 Google Ad Manager 網站。詳情請參閱說明中心的「標記 」一節。
其他示例
您可以在我們的用戶端程式庫程式碼範例中找到更多使用不同程式設計語言的範例。如需程式設計語言範例的連結,請參閱「用戶端程式庫與程式碼範例 」頁面。