Alterar

A maioria dos recursos é modificada (criada, atualizada ou removida) usando um método Mutate. O método Mutate é invocado como um POST HTTP para um URL específico do recurso que corresponde ao padrão de nome do recurso, sem o ID do recurso final. Os IDs dos recursos a serem modificados são enviados no corpo da solicitação JSON. Isso permite enviar uma única chamada de API que contém várias operações em recursos diferentes.

Por exemplo, o nome do recurso de uma campanha usa o seguinte formato:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Para derivar o URL usado para modificar campanhas, omita o ID do recurso final e anexe :mutate:

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

Uma mensagem Mutate contém um objeto JSON de nível superior com uma matriz operations que pode conter muitos objetos operation. Cada operação, por sua vez, pode ser create, update ou remove. Essas são as únicas operações de modificação possíveis.

POST /v25/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": [
    ...
  ]
}

A maioria dos serviços oferece suporte a milhares de operações em uma única chamada de API. O guia Limites do sistema documenta as limitações nos tamanhos de solicitação.

As operações em uma única solicitação de API são executadas como um conjunto de ações por padrão, o que significa que todas são bem-sucedidas juntas ou todo o lote falha se qualquer operação falhar. Alguns serviços oferecem suporte a um partialFailure atributo para mudar esse comportamento. Consulte Recursos de mutação para mais informações sobre a semântica da operação de mutação.

Criar

As operações de criação produzem novas entidades e precisam incluir uma representação JSON completa do recurso que você pretende criar.

POST /v25/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": {}
      }
    }
  ]
}

Atualizar

As operações de atualização realizam atualizações esparsas em um recurso atual. Você só precisa especificar os campos que quer modificar.

Para especificar os campos que você quer atualizar, defina o atributo updateMask como uma lista separada por vírgulas de nomes de campos. Isso é particularmente útil se você já tiver uma representação JSON totalmente formada de um objeto (por exemplo, conforme retornado por uma chamada de API anterior), mas só quiser mudar determinados campos. Em vez de remover o objeto JSON, basta listar os nomes dos campos a serem modificados no updateMask e enviar o objeto JSON inteiro.

O exemplo a seguir muda o name e o status de uma campanha atual com o resourceName especificado.

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

Remover

As operações de remoção excluem um objeto, definindo o status do Google Ads como REMOVED. Apenas o resourceName a ser removido é obrigatório.

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