Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Mutasi

Sebagian besar resource diubah (dibuat, diperbarui, atau dihapus) menggunakan metode Mutate. Metode Mutate dipanggil sebagai POST HTTP ke URL khusus resource yang cocok dengan pola nama resource, tanpa ID resource akhir. ID resource yang akan dimutasi dikirim dalam isi permintaan JSON. Dengan demikian, Anda dapat mengirim satu panggilan API yang berisi beberapa operasi pada resource yang berbeda.

Misalnya, nama resource kampanye menggunakan format berikut:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Untuk mendapatkan URL yang digunakan untuk mengubah kampanye, abaikan ID resource di akhir dan tambahkan :mutate:

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

Pesan Mutate berisi objek JSON level atas dengan array operations yang dapat berisi banyak objek operation. Setiap operasi, pada gilirannya, dapat berupa salah satu dari: create, update, atau remove. Hanya ini operasi yang dapat dimutasi.

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

Sebagian besar layanan mendukung ribuan operasi dalam satu panggilan API. Panduan Batas Sistem mendokumentasikan batasan ukuran permintaan.

Operasi dalam satu permintaan API dijalankan sebagai satu kumpulan tindakan secara default, yang berarti semuanya berhasil bersama-sama atau seluruh batch gagal jika satu operasi gagal. Beberapa layanan mendukung atribut partialFailure untuk mengubah perilaku ini. Lihat Mutating Resource untuk mengetahui informasi mendetail tentang semantik operasi mutasi.

Buat

Operasi pembuatan menghasilkan entity baru dan harus menyertakan representasi JSON lengkap dari resource yang ingin Anda buat.

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

Perbarui

Operasi update melakukan update sparse ke resource yang ada. Anda hanya perlu menentukan kolom yang ingin diubah.

Untuk menentukan kolom yang ingin diperbarui, tetapkan atribut updateMask ke daftar nama kolom yang dipisahkan dengan koma. Hal ini sangat berguna jika Anda sudah memiliki representasi JSON yang lengkap untuk sebuah objek (misalnya, seperti yang ditampilkan oleh panggilan API sebelumnya), tetapi hanya ingin mengubah kolom tertentu. Daripada memangkas objek JSON, Anda cukup mencantumkan nama kolom yang akan diubah di updateMask dan mengirim seluruh objek JSON.

Contoh di bawah ini mengubah name dan status kampanye yang sudah ada yang memiliki resourceName tertentu.

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

Hapus

Menghapus operasi secara efektif menghapus objek, sehingga menyetel status Google Ads-nya ke REMOVED. Hanya resourceName yang akan dihapus yang diperlukan.

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