變更物件

API 結構指南所述,Google Ads API 中的每個頂層資源都有對應的資源類型專屬服務,可支援修改資源例項。

本指南會使用 CampaignService 示範如何修改 Campaign 物件,但相同概念適用於所有其他資源類型專屬服務。

變更物件

每個資源類型專屬服務都會有 mutate 方法,可接受變更要求。這項要求包含:

  • A customerId
  • 一系列作業
  • 回應內容類型設定,用於決定變動後應傳回可變動資源,還是只傳回資源名稱。

舉例來說,CampaignServiceMutateCampaigns 方法會接受 MutateCampaignsRequest,其中包含:

  • A customerId
  • 一組 CampaignOperation 物件
  • response_content_type 欄位,指出偏好的回應類型。

作業

作業物件 (例如 CampaignOperation) 可讓您設定 operation 欄位,指定要對單一資源執行的動作。這個欄位是其中一個欄位,由下列屬性組成,這些屬性的類型為資源類型:

create
建立資源的新例項。
update
更新資源,使其符合 update 資源的屬性。 設定這個欄位時,您也必須設定作業的 update_mask,告知 Google Ads API 在更新作業期間要修改哪些屬性。每個用戶端程式庫都有公用程式或輔助方法,可為您產生 update_mask,如用戶端程式庫所示。
remove
移除資源。

由於 operation 欄位是 oneof 欄位,因此您無法使用單一作業修改多個物件。舉例來說,如要建立一個廣告活動並移除另一個廣告活動,請在要求中新增 CampaignOperation 的兩個執行個體:一個設有 create,另一個設有 remove

批次作業

雖然單一作業只能建立、更新或移除單一資源,但單一變動要求可以包含多項作業。請將作業合併為單一變動要求,而非傳送多個各含單一作業的變動要求。

舉例來說,如果您想建立十個廣告活動,請傳送單一 MutateCampaignsRequest,其中包含十個 CampaignOperation 物件。

修改回應

回應中傳回的內容取決於變動要求中傳送的內容。response_content_type舉例來說,如果指定 MUTABLE_RESOURCE,則回應只會包含廣告活動中可變動的欄位。然後,您可以在該資源物件上進行後續變動,不必重建該物件。

修改錯誤

只有在要求中的每項作業都成功時,特定變動要求中的作業才會套用至 Google Ads 帳戶。如要查看常見錯誤清單和解決方法,請參閱常見錯誤指南