Mutate

您可以使用 Mutate 方法修改(创建、更新或移除)大多数资源。Mutate 方法会以 HTTP POST 的形式调用,指向与资源名称模式匹配的资源专用网址,且不以资源 ID 结尾。需要更改的资源的 ID 将在 JSON 请求正文中发送。这样一来,您可以发送单个 API 调用,其中包含对不同资源执行的多项操作。

例如,广告系列的资源名称采用以下格式:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

如需推导出用于更改广告系列的网址,请省略末尾的资源 ID 并附加 :mutate

https://googleads.googleapis.com/v17/customers/CUSTOMER_ID/campaigns:mutate

Mutate 消息包含一个带有 operations 数组的顶级 JSON 对象,该数组可以包含多个 operation 对象。反过来,每项操作可以是以下项之一:createupdateremove。这些是仅有的 mutate 操作。

POST /v17/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 属性来更改此行为。如需详细了解 Mutate 操作语义,请参阅变更资源

创建

创建操作会生成新实体,并且必须包含要创建的资源的完整 JSON 表示法。

POST /v17/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 调用所返回),但只想更改某些字段,这种方法尤其有用。您可以只在 updateMask 中列出要修改的字段名称并发送整个 JSON 对象,而不是删减 JSON 对象。

以下示例更改了具有给定 resourceName 的现有广告系列的 namestatus

POST /v17/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",
      }
    }
  ]
}

移除

remove 操作可以有效地删除对象,即将其 Google Ads 状态设置为 REMOVED。只需移除要移除的 resourceName

POST /v17/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"
    }
  ]
}