大多數資源都是使用 Mutate
方法修改 (建立、更新或移除)。系統會以 HTTP POST
形式,對符合資源名稱模式的資源專屬網址叫用 Mutate
方法,但不含結尾的資源 ID。要變動的資源 ID 會改為在 JSON 要求主體中傳送。這可讓您傳送單一 API 呼叫,其中包含不同資源的多項作業。
舉例來說,廣告活動的資源名稱採用下列格式:
customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID
如要衍生用於變更廣告活動的網址,請省略尾端資源 ID,並附加 :mutate
:
https://googleads.googleapis.com/v20/customers/CUSTOMER_ID/campaigns:mutate
Mutate
訊息包含頂層 JSON 物件,以及可包含多個 operation
物件的 operations
陣列。每個作業依序可以是 create
、update
或 remove
。這是唯一可能的變動作業。
POST /v20/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "operations": [ ... ] }
大多數服務都支援在單一 API 呼叫中執行數千項作業。「系統限制」指南說明瞭要求大小的限制。
根據預設,單一 API 要求中的作業會以一組動作的形式執行,也就是說,如果任何單一作業失敗,整批作業就會一併失敗,否則就會全部成功。部分服務支援 partialFailure
屬性,可變更這項行為。如要進一步瞭解變動作業語意,請參閱「變動資源」。
建立
建立作業會產生新實體,且必須包含您要建立資源的完整 JSON 表示法。
POST /v20/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "operations": [ { "create": { "name": "An example campaign", "status": "PAUSED", "campaignBudget": "customers/CUSTOMER_ID/campaignBudgets/CAMPAIGN_BUDGET_ID", "advertisingChannelType": "SEARCH", "networkSettings": { "targetGoogleSearch": true, "targetSearchNetwork": true, "targetContentNetwork": true, "targetPartnerSearchNetwork": false }, "target_spend": {} } } ] }
更新
更新作業會對現有資源執行稀疏更新。您只需要指定要修改的欄位。
如要指定要更新的欄位,請將 updateMask
屬性設為以半形逗號分隔的欄位名稱清單。如果您已有物件的完整 JSON 表示法 (例如先前 API 呼叫傳回的表示法),但只想變更特定欄位,這種做法就特別實用。您不必修剪 JSON 物件,只要在 updateMask
中列出要修改的欄位名稱,然後傳送整個 JSON 物件即可。
下方範例會變更現有廣告活動的 name
和 status
,並提供 resourceName
。
POST /v20/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "operations": [ { "updateMask": "name,status", "update": { "resourceName": "customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID", "name": "My renamed campaign", "status": "PAUSED", } } ] }
移除
移除作業會有效刪除物件,並將其 Google Ads 狀態設為 REMOVED
。只需提供要移除的 resourceName
。
POST /v20/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "operations": [ { "remove": "customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID" } ] }